net.bluemind.directory.service.internal

Class DirectoryService

java.lang.Object

net.bluemind.directory.service.internal.DirectoryService

All Implemented Interfaces:

IDirectory

public class DirectoryService
extends java.lang.Object
implements IDirectory

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<DirectoryDecorator>	decorators

Constructor Summary

Constructors

Constructor and Description
DirectoryService(BmContext context, Container dirContainer, ItemValue<Domain> domain)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

decorators

public static java.util.List<DirectoryDecorator> decorators

Constructor Detail

DirectoryService

public DirectoryService(BmContext context,
                        Container dirContainer,
                        ItemValue<Domain> domain)

Method Detail

getRoot

public DirEntry getRoot()
                 throws ServerFault

Description copied from interface: IDirectory

Fetch the root DirEntry

Specified by:

getRoot in interface IDirectory

Returns:

DirEntry

Throws:

ServerFault - common error object

getEntry

public DirEntry getEntry(java.lang.String path)
                  throws ServerFault

Description copied from interface: IDirectory

Fetch DirEntry by its path

Specified by:

getEntry in interface IDirectory

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

public java.util.List<DirEntry> getEntries(java.lang.String path)
                                    throws ServerFault

Description copied from interface: IDirectory

Fetch DirEntrys by their path

Specified by:

getEntries in interface IDirectory

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

public TaskRef delete(java.lang.String path)
               throws ServerFault

Description copied from interface: IDirectory

Delete DirEntry by path

Specified by:

delete in interface IDirectory

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

public ItemValue<VCard> getVCard(java.lang.String uid)
                          throws ServerFault

Description copied from interface: IDirectory

Get DirEntry's VCard

Specified by:

getVCard in interface IDirectory

Parameters:

uid - the entry uid

Throws:

ServerFault - common error object

deleteByEntryUid

public TaskRef deleteByEntryUid(java.lang.String entryUid)
                         throws ServerFault

Description copied from interface: IDirectory

Delete a DirEntry by uid

Specified by:

deleteByEntryUid in interface IDirectory

Throws:

ServerFault - common error object

changelog

public ContainerChangelog changelog(java.lang.Long since)
                             throws ServerFault

Description copied from interface: IDirectory

Get the domain's ContainerChangelog

Specified by:

changelog in interface IDirectory

Parameters:

since - timestamp of the first change we want to retrieve

Returns:

ContainerChangelog

Throws:

ServerFault - common error object

changeset

public ContainerChangeset<java.lang.String> changeset(java.lang.Long since)
                                               throws ServerFault

Description copied from interface: IDirectory

Get the domain's ContainerChangeset

Specified by:

changeset in interface IDirectory

Parameters:

since - timestamp of the first change we want to retrieve

Returns:

ContainerChangeset

Throws:

ServerFault - common error object

search

public ListResult<ItemValue<DirEntry>> search(DirEntryQuery query)
                                       throws ServerFault

Description copied from interface: IDirectory

Search DirEntrys by DirEntryQuery

Specified by:

search in interface IDirectory

Parameters:

query - the DirEntryQuery search parameters

Returns:

List of matching DirEntrys

Throws:

ServerFault - common error object

findByEntryUid

public DirEntry findByEntryUid(java.lang.String entryUid)
                        throws ServerFault

Description copied from interface: IDirectory

Get DirEntry by uid

Specified by:

findByEntryUid in interface IDirectory

Parameters:

entryUid - the unique DirEntry uid

Returns:

matching DirEntry or null if not found

Throws:

ServerFault - common error object

getEntryIcon

public byte[] getEntryIcon(java.lang.String entryUid)
                    throws ServerFault

Description copied from interface: IDirectory

Get a DirEntry's icon

Specified by:

getEntryIcon in interface IDirectory

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

public byte[] getEntryPhoto(java.lang.String entryUid)
                     throws ServerFault

Description copied from interface: IDirectory

Get a DirEntry's photo

Specified by:

getEntryPhoto in interface IDirectory

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

public byte[] getIcon(java.lang.String path)
               throws ServerFault

Description copied from interface: IDirectory

Get a DirEntry's icon

Specified by:

getIcon in interface IDirectory

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

public java.util.Set<java.lang.String> getRolesForDirEntry(java.lang.String entryUid)
                                                    throws ServerFault

Description copied from interface: IDirectory

Get all the roles associated to an DirEntry

Specified by:

getRolesForDirEntry in interface IDirectory

Parameters:

entryUid - the unique DirEntry uid

Returns:

a set containing all roles associated to a DirEntry

Throws:

ServerFault - common error object

getRolesForOrgUnit

public java.util.Set<java.lang.String> getRolesForOrgUnit(java.lang.String orgUnitUid)
                                                   throws ServerFault

Description copied from interface: IDirectory

Get all the roles associated to an OrgUnit

Specified by:

getRolesForOrgUnit in interface IDirectory

Parameters:

orgUnitUid - the unique OrgUnit's id

Returns:

a set containing all roles associated to an OrgUnit

Throws:

ServerFault - common error object

getByEmail

public DirEntry getByEmail(java.lang.String email)

Description copied from interface: IDirectory

Fetch a DirEntry by its email address

Specified by:

getByEmail in interface IDirectory

Parameters:

email - the DirEntry's email address

Returns:

the matching DirEntry or null, if not found

getMultiple

public java.util.List<ItemValue<DirEntry>> getMultiple(java.util.List<java.lang.String> id)

Description copied from interface: IDirectory

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

Specified by:

getMultiple in interface IDirectory

Parameters:

id - list of internal numerical ids

Returns:

list of matching DirEntry's

xfer

public TaskRef xfer(java.lang.String entryUid,
                    java.lang.String serverUid)
             throws ServerFault

Description copied from interface: IDirectory

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

Specified by:

xfer in interface IDirectory

Parameters:

entryUid - the unique DirEntry uid

serverUid - the unique Server uid

Returns:

a TaskRef referencing this operation

Throws:

ServerFault - common error object

getByRoles

public java.util.List<ItemValue<DirEntry>> getByRoles(java.util.List<java.lang.String> roles)
                                               throws ServerFault

Specified by:

getByRoles in interface IDirectory

Returns:

Throws:

ServerFault