Package net.bluemind.directory.api

Interface IOrgUnits

All Superinterfaces:

IRestoreCrudSupport<OrgUnit>, IRestoreItemCrudSupport<OrgUnit>, IRestoreSupport<OrgUnit>

@Path("/directory/_ou/{domain}")
public interface IOrgUnits
extends IRestoreItemCrudSupport<OrgUnit>

Manages Organizational Units BlueMind integrates a delegated administration functionality. It allows you to grant limited administration rights to administrators (who become delegated administrators). Delegated administration rights can be given to specific users selected according to certain criteria (job type, industry, geographical area...). The resulting group is called an OrgUnit

Method Summary

Modifier and Type	Method	Description
void	create(String uid, OrgUnit value)	Create an OrgUnit
void	delete(String uid)	Delete an OrgUnit
Set<String>	getAdministratorRoles(String orgUnitUid, String dirEntryUid, List<String> groups)	Get the roles of a member or the Groups he is member of
Set<String>	getAdministrators(String uid, boolean hierarchical)	Get the UIDs of an OrgUnit's administrators
List<ItemValue<OrgUnit>>	getChildren(String uid)	Get all child elements of an OrgUnit
ItemValue<OrgUnit>	getComplete(String uid)	Get OrgUnit by UID
OrgUnitPath	getPath(String uid)	Get OrgUnitPath by OrgUnit UID
List<OrgUnitPath>	listByAdministrator(String administrator, List<String> groups)	Get a list of OrgUnitPaths by the UID of an administrator or the Groups he is member of
void	removeAdministrator(String administrator)	Remove an administrator from an OrgUnit
List<OrgUnitPath>	search(OrgUnitQuery query)	Get a list of OrgUnitPaths by OrgUnitQuery
void	setAdministratorRoles(String orgUnitUid, String dirEntryUid, Set<String> roles)	Grant roles to a member of an OrgUnit
void	update(String uid, OrgUnit value)	Update an OrgUnit

Methods inherited from interface net.bluemind.core.container.api.IRestoreSupport

get, restore

Method Details

getComplete

@GET
@Path("{uid}/complete")
ItemValue<OrgUnit> getComplete(@PathParam("uid")
 String uid)

Get OrgUnit by UID

Specified by:

getComplete in interface IRestoreItemCrudSupport<OrgUnit>

Parameters:

uid - UID

Returns:

ItemValue containing the OrgUnit, or null if not found

getChildren

@GET
@Path("{uid}/_children")
List<ItemValue<OrgUnit>> getChildren(@PathParam("uid")
 String uid)

Get all child elements of an OrgUnit

Parameters:

uid - OrgUnit UID

Returns:

ItemValues containing the OrgUnits

create

@PUT
@Path("{uid}")
void create(@PathParam("uid")
 String uid,
 OrgUnit value)

Create an OrgUnit

Parameters:

uid - Unique ID of the new OrgUnit

value - OrgUnit

update

@POST
@Path("{uid}")
void update(@PathParam("uid")
 String uid,
 OrgUnit value)

Update an OrgUnit

Parameters:

uid - UID of the OrgUnit

value - OrgUnit

delete

@DELETE
@Path("{uid}")
void delete(@PathParam("uid")
 String uid)

Delete an OrgUnit

Specified by:

delete in interface IRestoreCrudSupport<OrgUnit>

Parameters:

uid - UID of the OrgUnit

getPath

@GET
@Path("{uid}/path")
OrgUnitPath getPath(@PathParam("uid")
 String uid)

Get OrgUnitPath by OrgUnit UID

Parameters:

uid - UID

Returns:

OrgUnitPath or null, if not found

search

@POST
@Path("_search")
List<OrgUnitPath> search(OrgUnitQuery query)

Get a list of OrgUnitPaths by OrgUnitQuery

Parameters:

query - OrgUnitQuery

Returns:

List of matching OrgUnitPaths

setAdministratorRoles

@POST
@Path("{uid}/{dirUid}/_set")
void setAdministratorRoles(@PathParam("uid")
 String orgUnitUid,
 @PathParam("dirUid")
 String dirEntryUid,
 Set<String> roles)

Grant roles to a member of an OrgUnit

Parameters:

orgUnitUid - OrgUnit UID

dirEntryUid - UID of the member's DirEntry object

roles - Set of roles

getAdministratorRoles

@POST
@Path("{uid}/{dirUid}")
Set<String> getAdministratorRoles(@PathParam("uid")
 String orgUnitUid,
 @PathParam("dirUid")
 String dirEntryUid,
 List<String> groups)

Get the roles of a member or the Groups he is member of

Parameters:

orgUnitUid - OrgUnit UID

dirEntryUid - UID of the member's DirEntry object

groups - UIDs of the Groups the DirEntry is member of

Returns:

Set of roles

getAdministrators

@GET
@Path("{uid}/_administrators")
Set<String> getAdministrators(@PathParam("uid")
 String uid,
 @QueryParam("hierarchical")
 boolean hierarchical)

Get the UIDs of an OrgUnit's administrators

Parameters:

uid - OrgUnit UID

Returns:

Set of UIDs

listByAdministrator

@POST
@Path("_byAdmin")
List<OrgUnitPath> listByAdministrator(@QueryParam("administrator")
 String administrator,
 List<String> groups)

Get a list of OrgUnitPaths by the UID of an administrator or the Groups he is member of

Parameters:

administrator - Administrator UID

groups - UIDs of the Groups the DirEntry is member of

Returns:

List of OrgUnitPaths

removeAdministrator

@DELETE
@Path("_deleteadmin")
void removeAdministrator(@QueryParam("administrator")
 String administrator)

Remove an administrator from an OrgUnit

Parameters:

administrator - Administrator UID