com.sssw.fw.directory.api
Interface EbiRealmContainerDelegate

All Superinterfaces:

EbiDelegate

public interface EbiRealmContainerDelegate

extends EbiDelegate

The Realm Container Delegate.

Fields inherited from interface com.sssw.fw.api.EbiDelegate

SERVICE_LOCAL, SERVICE_REMOTE

Method Summary

Collection	getAncestorContainers(EbiContext context, EbiRealmPrincipal realmPrin) Enumerates any ancestors, all the way up to the Root Realm Container, of the specified Realm Principal.
Collection	getChildren(EbiContext context, EbiRealmContainer container, boolean getSubcontainers, boolean getUsers) Enumerates the child objects (immediate descendants) of a specific Realm Container.
Collection	getDescendants(EbiContext context, EbiRealmContainer container, boolean getSubcontainers, boolean getUsers) Enumerates the descendant objects of a specific Realm Container.
EbiRealmContainer	getParentContainer(EbiContext context, EbiRealmPrincipal realmPrin) Gets the parent container for a specific Realm Container/User.
EbiRealmContainer	getRealmContainer(EbiContext context, String name) Gets a Realm Container, given its distinguished name.
EbiRealmUser	getRealmUser(EbiContext context, String name) Gets a Realm User, given the user's distinguished name.
EbiRealmContainer	getRootContainer(EbiContext context) Gets the Root Container within the directory hierarchy.
boolean	isDescendant(EbiContext context, EbiRealmContainer container, Principal prin) Checks to see if the specified principal is a descendant of the specified Realm Container.

Methods implemented from interface com.sssw.fw.api.EbiDelegate

getName

Method Detail

getRootContainer

public EbiRealmContainer getRootContainer(EbiContext context)
                                   throws EboUnrecoverableSystemException

Gets the Root Container within the directory hierarchy.

Parameters:

context - context

Returns:

the Root Container object

Throws:

EboUnrecoverableSystemException - on an unrecoverable system exception

getChildren

public Collection getChildren(EbiContext context,
                              EbiRealmContainer container,
                              boolean getSubcontainers,
                              boolean getUsers)
                       throws EboUnrecoverableSystemException

Enumerates the child objects (immediate descendants) of a specific Realm Container. Note: the method does not enumerate child groups; it enumerates child users and/or containers.

Parameters:

context - context

container - the parent Realm Container

getSubcontainers - if true, any child containers are included in the returned results

getUsers - if true, any users are included in the returned results

Returns:

a Collection of EbiRealmPrincipal's (EbiRealmContainer's and/or EbiRealmUser's)

Throws:

EboUnrecoverableSystemException - on an unrecoverable system exception

getDescendants

public Collection getDescendants(EbiContext context,
                                 EbiRealmContainer container,
                                 boolean getSubcontainers,
                                 boolean getUsers)
                          throws EboUnrecoverableSystemException

Enumerates the descendant objects of a specific Realm Container. Note: the method does not enumerate descendant groups; it enumerates descendant users and/or containers.

Parameters:

context - context

container - the ancestor Realm Container

getSubcontainers - if true, any descendant containers are included in the returned results

getUsers - if true, any users are included in the returned results

Returns:

a Collection of EbiRealmPrincipal's (EbiRealmContainer's and/or EbiRealmUser's)

Throws:

EboUnrecoverableSystemException - on an unrecoverable system exception

getParentContainer

public EbiRealmContainer getParentContainer(EbiContext context,
                                            EbiRealmPrincipal realmPrin)
                                     throws EboUnrecoverableSystemException

Gets the parent container for a specific Realm Container/User.

Parameters:

context - context

realmPrin - the realm principal whose parent is to be retrieved

Returns:

the parent Realm Container or null if the root container is passed in

Throws:

EboUnrecoverableSystemException - on an unrecoverable system exception

getRealmContainer

public EbiRealmContainer getRealmContainer(EbiContext context,
                                           String name)
                                    throws EboUnrecoverableSystemException

Gets a Realm Container, given its distinguished name.

Parameters:

context - context

name - the full distinguished name of the container

Returns:

the Realm Container or null if not found

Throws:

EboUnrecoverableSystemException - on an unrecoverable system exception

getRealmUser

public EbiRealmUser getRealmUser(EbiContext context,
                                 String name)
                          throws EboUnrecoverableSystemException

Gets a Realm User, given the user's distinguished name.

Parameters:

context - context

name - the full distinguished name of the user

Returns:

the Realm User object, or null of the user was not found

Throws:

EboUnrecoverableSystemException - on an unrecoverable system exception

isDescendant

public boolean isDescendant(EbiContext context,
                            EbiRealmContainer container,
                            Principal prin)
                     throws EboUnrecoverableSystemException

Checks to see if the specified principal is a descendant of the specified Realm Container.

Parameters:

context - context

container - the parent Realm Container

prin - the principal

Returns:

true if the principal is a descendant of the container, false otherwise

Throws:

EboUnrecoverableSystemException - on an unrecoverable system exception

getAncestorContainers

public Collection getAncestorContainers(EbiContext context,
                                        EbiRealmPrincipal realmPrin)
                                 throws EboUnrecoverableSystemException

Enumerates any ancestors, all the way up to the Root Realm Container, of the specified Realm Principal.

Parameters:

context - context

realmPrin - the Realm Principal whose ancestors are to be enumerated

Returns:

a Collection of EbiRealmContainer's; the Collection is empty if the Root Realm Container is passed in

Throws:

EboUnrecoverableSystemException - on an unrecoverable system exception