Package net.bluemind.directory.api

Interface IDirectory

@Path("/directory/{domain}")
public interface IDirectory

Method Summary

Modifier and Type	Method	Description
ContainerChangeset<String>	changeset(Long since)	Get the domain's ContainerChangeset
TaskRef	delete(String path)	Delete DirEntry by path
TaskRef	deleteByEntryUid(String entryUid)	Delete a DirEntry by uid
DirEntry	findByEntryUid(String entryUid)	Get DirEntry by uid
ItemValue<DirEntry>	findItemValueByEntryUid(String entryUid)	Get DirEntry by uid
DirEntry	getByEmail(String email)	Fetch a DirEntry by its email address
List<ItemValue<DirEntry>>	getByRoles(List<String> roles)
List<DirEntry>	getEntries(String path)	Fetch DirEntrys by their path
DirEntry	getEntry(String path)	Fetch DirEntry by its path
byte[]	getEntryIcon(String entryUid)	Get a DirEntry's icon
byte[]	getEntryPhoto(String entryUid)	Get a DirEntry's photo
byte[]	getIcon(String path)	Get a DirEntry's icon
List<ItemValue<DirEntry>>	getMultiple(List<String> id)	Fetch a list of net.bluemind.core.container.model(DirEntry) by their internal numerical ids
List<ItemValue<DirEntry>>	getMultipleLight(List<String> id)	Fetch a list of net.bluemind.core.container.model(DirEntry) by their internal numerical ids without decorator executing db query
Set<String>	getRolesForDirEntry(String entryUid)	Get all the roles associated to an DirEntry
Set<String>	getRolesForOrgUnit(String orgUnitUid)	Get all the roles associated to an OrgUnit
DirEntry	getRoot()	Fetch the root DirEntry
ItemValue<VCard>	getVCard(String uid)	Get DirEntry's VCard
ListResult<ItemValue<DirEntry>>	search(DirEntryQuery query)	Search DirEntrys by DirEntryQuery
ListResult<String>	searchUids(DirEntryQuery query)	Search DirEntrys by DirEntryQuery

Method Details

getRoot

@GET
DirEntry getRoot()
          throws ServerFault

Fetch the root DirEntry

Returns:

DirEntry

Throws:

ServerFault - common error object

getEntry

@POST
@Path("_entry")
DirEntry getEntry(String path)
           throws ServerFault

Fetch DirEntry by its path

Parameters:

path - path of the directory entry
domainUid/kind/entryUid to find a particular entry
domainUid/kind to find all entries of a particular kind
domainUid to find all entries of a particular domain

Returns:

DirEntry or null if not found

Throws:

ServerFault - common error object

getEntries

@POST
@Path("_childs")
List<DirEntry> getEntries(String path)
                   throws ServerFault

Fetch DirEntrys by their path

Parameters:

path - path of the directory entries
domainUid/kind to find all entries of a particular kind
domainUid to find all entries of a particular domain

Returns:

DirEntrys

Throws:

ServerFault - common error object

delete

@DELETE
@Path("{path}")
TaskRef delete(@PathParam("path")
 String path)
        throws ServerFault

Delete DirEntry by path

Parameters:

path - path of the directory entry (domainUid/kind/entryUid)
This action will fail if a shorter form of the path (like domain or domain/kind) is used and returns multiple entries.

Throws:

ServerFault - common error object

getVCard

@GET
@Path("{uid}/_vcard")
ItemValue<VCard> getVCard(@PathParam("uid")
 String uid)
                   throws ServerFault

Get DirEntry's VCard

Parameters:

uid - the entry uid

Throws:

ServerFault - common error object

deleteByEntryUid

@DELETE
@Path("_byentryuid/{entryUid}")
TaskRef deleteByEntryUid(@PathParam("entryUid")
 String entryUid)
                  throws ServerFault

Delete a DirEntry by uid

Parameters:

uid - the entry uid

Throws:

ServerFault - common error object

changeset

@GET
@Path("_changeset")
ContainerChangeset<String> changeset(@QueryParam("since")
 Long since)
                              throws ServerFault

Get the domain's ContainerChangeset

Parameters:

since - timestamp of the first change we want to retrieve

Returns:

ContainerChangeset

Throws:

ServerFault - common error object

search

@POST
@Path("_search")
ListResult<ItemValue<DirEntry>> search(DirEntryQuery query)
                                throws ServerFault

Search DirEntrys by DirEntryQuery

Parameters:

query - the DirEntryQuery search parameters

Returns:

List of matching DirEntrys

Throws:

ServerFault - common error object

searchUids

@POST
@Path("_searchUids")
ListResult<String> searchUids(DirEntryQuery query)
                       throws ServerFault

Search DirEntrys by DirEntryQuery

Parameters:

query - the DirEntryQuery search parameters

Returns:

List of matching DirEntrys uids

Throws:

ServerFault - common error object

findByEntryUid

@GET
@Path("entry-uid/{entryUid}")
DirEntry findByEntryUid(@PathParam("entryUid")
 String entryUid)
                 throws ServerFault

Get DirEntry by uid

Parameters:

entryUid - the unique DirEntry uid

Returns:

matching DirEntry or null if not found

Throws:

ServerFault - common error object

findItemValueByEntryUid

@GET
@Path("item-value-uid/{entryUid}")
ItemValue<DirEntry> findItemValueByEntryUid(@PathParam("entryUid")
 String entryUid)
                                     throws ServerFault

Get DirEntry by uid

Parameters:

entryUid - the unique DirEntry uid

Returns:

matching DirEntry or null if not found

Throws:

ServerFault - common error object

getEntryIcon

@GET
@Path("entry-uid/{entryUid}/icon")
@Produces("image/png")
byte[] getEntryIcon(@PathParam("entryUid")
 String entryUid)
             throws ServerFault

Get a DirEntry's icon

Parameters:

entryUid - the unique DirEntry uid

Returns:

the image data in PNG format or null, if no icon is associated to the DirEntry

Throws:

ServerFault - common error object

getEntryPhoto

@GET
@Path("entry-uid/{entryUid}/photo")
@Produces("image/png")
byte[] getEntryPhoto(@PathParam("entryUid")
 String entryUid)
              throws ServerFault

Get a DirEntry's photo

Parameters:

entryUid - the unique DirEntry uid

Returns:

the image data in PNG format or null, if no photo is associated to the DirEntry

Throws:

ServerFault - common error object

getIcon

@GET
@Path("_icon/{path}")
@Produces("image/png")
byte[] getIcon(@PathParam("path")
 String path)
        throws ServerFault

Get a DirEntry's icon

Parameters:

path - path of the directory entry (domainUid/kind/entryUid)
This action will fail if a shorter form of the path (like domain or domain/kind) is used and returns multiple entries.

Returns:

the image data in PNG format or null, if no icon is associated to the DirEntry

Throws:

ServerFault - common error object

getRolesForDirEntry

@GET
@Path("entry-uid/{entryUid}/rolesfor_")
Set<String> getRolesForDirEntry(@PathParam("entryUid")
 String entryUid)
                         throws ServerFault

Get all the roles associated to an DirEntry

Parameters:

entryUid - the unique DirEntry uid

Returns:

a set containing all roles associated to a DirEntry

Throws:

ServerFault - common error object

getRolesForOrgUnit

@GET
@Path("ou-uid/{ouUid}/rolesfor_")
Set<String> getRolesForOrgUnit(@PathParam("ouUid")
 String orgUnitUid)
                        throws ServerFault

Get all the roles associated to an OrgUnit

Parameters:

orgUnitUid - the unique OrgUnit's id

Returns:

a set containing all roles associated to an OrgUnit

Throws:

ServerFault - common error object

getByRoles

@POST
@Path("_byroles")
List<ItemValue<DirEntry>> getByRoles(List<String> roles)
                              throws ServerFault

Parameters:

roles -

Returns:

Throws:

ServerFault

getByEmail

@GET
@Path("_byEmail/{email}")
DirEntry getByEmail(@PathParam("email")
 String email)

Fetch a DirEntry by its email address

Parameters:

email - the DirEntry's email address

Returns:

the matching DirEntry or null, if not found

getMultiple

@POST
@Path("_mget")
List<ItemValue<DirEntry>> getMultiple(List<String> id)

Fetch a list of net.bluemind.core.container.model(DirEntry) by their internal numerical ids

Parameters:

id - list of internal numerical ids

Returns:

list of matching DirEntry's

getMultipleLight

@POST
@Path("_mgetlight")
List<ItemValue<DirEntry>> getMultipleLight(List<String> id)

Fetch a list of net.bluemind.core.container.model(DirEntry) by their internal numerical ids without decorator executing db query

Parameters:

id - list of internal numerical ids

Returns:

list of matching DirEntry's