net.bluemind.directory.api

Interface IDirectory

All Known Implementing Classes:

DirectoryService

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

Method Summary

Modifier and Type	Method and Description
ContainerChangelog	changelog(java.lang.Long since) Get the domain's ContainerChangelog
ContainerChangeset<java.lang.String>	changeset(java.lang.Long since) Get the domain's ContainerChangeset
TaskRef	delete(java.lang.String path) Delete DirEntry by path
TaskRef	deleteByEntryUid(java.lang.String entryUid) Delete a DirEntry by uid
DirEntry	findByEntryUid(java.lang.String entryUid) Get DirEntry by uid
DirEntry	getByEmail(java.lang.String email) Fetch a DirEntry by its email address
java.util.List<ItemValue<DirEntry>>	getByRoles(java.util.List<java.lang.String> roles)
java.util.List<DirEntry>	getEntries(java.lang.String path) Fetch DirEntrys by their path
DirEntry	getEntry(java.lang.String path) Fetch DirEntry by its path
byte[]	getEntryIcon(java.lang.String entryUid) Get a DirEntry's icon
byte[]	getEntryPhoto(java.lang.String entryUid) Get a DirEntry's photo
byte[]	getIcon(java.lang.String path) Get a DirEntry's icon
java.util.List<ItemValue<DirEntry>>	getMultiple(java.util.List<java.lang.String> id) Fetch a list of net.bluemind.core.container.model(DirEntry) by their internal numerical ids
java.util.Set<java.lang.String>	getRolesForDirEntry(java.lang.String entryUid) Get all the roles associated to an DirEntry
java.util.Set<java.lang.String>	getRolesForOrgUnit(java.lang.String orgUnitUid) Get all the roles associated to an OrgUnit
DirEntry	getRoot() Fetch the root DirEntry
ItemValue<VCard>	getVCard(java.lang.String uid) Get DirEntry's VCard
ListResult<ItemValue<DirEntry>>	search(DirEntryQuery query) Search DirEntrys by DirEntryQuery
TaskRef	xfer(java.lang.String entryUid, java.lang.String serverUid) Transfer a DirEntry to a different Server This transfers all database related data as well as all emails to the new server.

Method Detail

getRoot

@GET
DirEntry getRoot()
               throws ServerFault

Fetch the root DirEntry

Returns:

DirEntry

Throws:

ServerFault - common error object

getEntry

@POST
 @Path(value="_entry")
DirEntry getEntry(java.lang.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(value="_childs")
java.util.List<DirEntry> getEntries(java.lang.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(value="{path}")
TaskRef delete(@PathParam(value="path")
                                              java.lang.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(value="{uid}/_vcard")
ItemValue<VCard> getVCard(@PathParam(value="uid")
                                                            java.lang.String uid)
                                                     throws ServerFault

Get DirEntry's VCard

Parameters:

uid - the entry uid

Throws:

ServerFault - common error object

deleteByEntryUid

@DELETE
 @Path(value="_byentryuid/{entryUid}")
TaskRef deleteByEntryUid(@PathParam(value="entryUid")
                                                                        java.lang.String entryUid)
                                                                 throws ServerFault

Delete a DirEntry by uid

Parameters:

uid - the entry uid

Throws:

ServerFault - common error object

changelog

@GET
 @Path(value="_changelog")
ContainerChangelog changelog(@QueryParam(value="since")
                                                             java.lang.Long since)
                                                      throws ServerFault

Get the domain's ContainerChangelog

Parameters:

since - timestamp of the first change we want to retrieve

Returns:

ContainerChangelog

Throws:

ServerFault - common error object

changeset

@GET
 @Path(value="_changeset")
ContainerChangeset<java.lang.String> changeset(@QueryParam(value="since")
                                                                               java.lang.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(value="_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

findByEntryUid

@GET
 @Path(value="entry-uid/{entryUid}")
DirEntry findByEntryUid(@PathParam(value="entryUid")
                                                                  java.lang.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(value="entry-uid/{entryUid}/icon")
 @Produces(value="image/png")
byte[] getEntryIcon(@PathParam(value="entryUid")
                                                                                                 java.lang.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(value="entry-uid/{entryUid}/photo")
 @Produces(value="image/png")
byte[] getEntryPhoto(@PathParam(value="entryUid")
                                                                                                   java.lang.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(value="_icon/{path}")
 @Produces(value="image/png")
byte[] getIcon(@PathParam(value="path")
                                                                               java.lang.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(value="entry-uid/{entryUid}/rolesfor_")
java.util.Set<java.lang.String> getRolesForDirEntry(@PathParam(value="entryUid")
                                                                                                        java.lang.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(value="ou-uid/{ouUid}/rolesfor_")
java.util.Set<java.lang.String> getRolesForOrgUnit(@PathParam(value="ouUid")
                                                                                                 java.lang.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(value="_byroles")
java.util.List<ItemValue<DirEntry>> getByRoles(java.util.List<java.lang.String> roles)
                                                                       throws ServerFault

Parameters:

roles -

Returns:

Throws:

ServerFault

getByEmail

@GET
 @Path(value="_byEmail/{email}")
DirEntry getByEmail(@PathParam(value="email")
                                                          java.lang.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(value="_mget")
java.util.List<ItemValue<DirEntry>> getMultiple(java.util.List<java.lang.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

xfer

@POST
 @Path(value="_xfer/{entryUid}/{serverUid}")
TaskRef xfer(@PathParam(value="entryUid")
                                                                java.lang.String entryUid,
                                                                @PathParam(value="serverUid")
                                                                java.lang.String serverUid)
                                                         throws ServerFault

Transfer a DirEntry to a different Server This transfers all database related data as well as all emails to the new server. This action can potentially take a very long time

Parameters:

entryUid - the unique DirEntry uid

serverUid - the unique Server uid

Returns:

a TaskRef referencing this operation

Throws:

ServerFault - common error object