toolbox.ldap
Class LDAPManagerImpl

Package class diagram package LDAPManagerImpl
java.lang.Object
  extended by toolbox.ldap.LDAPManagerImpl
All Implemented Interfaces:
LDAPManager

public class LDAPManagerImpl
extends java.lang.Object
implements LDAPManager

Default LDAPManager implementation.


Constructor Summary
LDAPManagerImpl()
          Default constructor
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LDAPManagerImpl

public LDAPManagerImpl()
Default constructor

Method Detail

init

public void init(java.lang.String name,
                 XMLProperties xmlProps)
          throws LDAPException
Initialise this manager with the given name and XML configuration properties.

Specified by:
init in interface LDAPManager
Parameters:
name - The name of this manager.
xmlProps - XMLProperites instance containing manager configuration.
Throws:
LDAPException - if the manager cannot be initialised.

getDirContext

public javax.naming.directory.DirContext getDirContext()
                                                throws LDAPException
Return a DirContext instance.

Specified by:
getDirContext in interface LDAPManager
Returns:
DirContext instance.
Throws:
LDAPException - if a DirContext instance cannot be returned.

releaseDirContext

public void releaseDirContext(javax.naming.directory.DirContext ctx)
                       throws LDAPException
Dispose of the given DirContext.

Specified by:
releaseDirContext in interface LDAPManager
Parameters:
ctx - DirContext instance to dispose of.
Throws:
LDAPException - if the DirContext cannot be disposed of.

getLDAPWorker

public LDAPWorker getLDAPWorker()
Return the LDAPWorker instance configured for this manager.

Specified by:
getLDAPWorker in interface LDAPManager
Returns:
LDAPWorker instance managed by this manager.

getMapBuilder

public MapBuilder getMapBuilder()
Return the MapBuilder instance configured for this manager.

Specified by:
getMapBuilder in interface LDAPManager
Returns:
MapBuilder instance configured for this manager.

getAttributesBuilder

public AttributesBuilder getAttributesBuilder()
Return the AttributesBuilder instance configured for this manager.

Specified by:
getAttributesBuilder in interface LDAPManager
Returns:
AttributesBuilder instance configured for this manager.

destroy

public void destroy()
             throws LDAPException
Destroy this manager.

Specified by:
destroy in interface LDAPManager
Throws:
LDAPException - if this manager cannot be destroyed.