toolbox.ldap
Interface LDAPManager

All Known Implementing Classes:

LDAPManagerImpl

public interface LDAPManager

Defines an interface for developing a LDAP access manager.

Implementations of this interface will provide the following services:

• Manage access to DirContext instances.
• Manage the instantiation of LDAPWorker instances.
• Manage the instantiation of MapBuilder instances.
• Manage the instantiation of AttributesBuilder instances.

Method Summary

void	destroy() Destroy this manager.
AttributesBuilder	getAttributesBuilder() Return the AttributesBuilder instance configured for this manager.
javax.naming.directory.DirContext	getDirContext() Return a DirContext instance.
LDAPWorker	getLDAPWorker() Return the LDAPWorker instance configured for this manager.
MapBuilder	getMapBuilder() Return the MapBuilder instance configured for this manager.
void	init(java.lang.String name, XMLProperties xmlProps) Initialise this manager with the given name and XML configuration properties.
void	releaseDirContext(javax.naming.directory.DirContext ctx) Dispose of the given DirContext.

Method Detail

init

void init(java.lang.String name,
          XMLProperties xmlProps)
          throws LDAPException

Initialise this manager with the given name and XML configuration properties.

Parameters:

name - The name of this manager.

xmlProps - XMLProperites instance containing manager configuration.

Throws:

LDAPException - if the manager cannot be initialised.

getDirContext

javax.naming.directory.DirContext getDirContext()
                                                throws LDAPException

Return a DirContext instance.

Returns:

DirContext instance.

Throws:

LDAPException - if a DirContext instance cannot be returned.

releaseDirContext

void releaseDirContext(javax.naming.directory.DirContext ctx)
                       throws LDAPException

Dispose of the given DirContext.

Parameters:

ctx - DirContext instance to dispose of.

Throws:

LDAPException - if the DirContext cannot be disposed of.

getLDAPWorker

LDAPWorker getLDAPWorker()

Return the LDAPWorker instance configured for this manager.

Returns:

LDAPWorker instance managed by this manager.

getMapBuilder

MapBuilder getMapBuilder()

Return the MapBuilder instance configured for this manager.

Returns:

MapBuilder instance configured for this manager.

getAttributesBuilder

AttributesBuilder getAttributesBuilder()

Return the AttributesBuilder instance configured for this manager.

Returns:

AttributesBuilder instance configured for this manager.

destroy

void destroy()
             throws LDAPException

Destroy this manager.

Throws:

LDAPException - if this manager cannot be destroyed.