com.netscape.certsrv.ldap
Interface ILdapConnModule


public interface ILdapConnModule

Class on behalf of the Publishing system that controls an instance of an ILdapConnFactory. Allows a factory to be intialized and grants access to the factory to other interested parties.

Version:
$Revision: 1211 $, $Date: 2010-08-18 10:15:37 -0700 (Wed, 18 Aug 2010) $

Method Summary
 ILdapConnFactory getLdapConnFactory()
          Returns the internal ldap connection factory.
 void init(ISubsystem owner, IConfigStore config)
          Initialize ldap publishing module with config store.
 

Method Detail

init

void init(ISubsystem owner,
          IConfigStore config)
          throws EBaseException,
                 ELdapException
Initialize ldap publishing module with config store.

Parameters:
owner - Entity that is interested in this instance of Publishing.
config - Config store containing the info needed to set up Publishing.
Throws:
ELdapException - Due to Ldap error.
EBaseException - Due to config value errors and all other errors.

getLdapConnFactory

ILdapConnFactory getLdapConnFactory()
Returns the internal ldap connection factory. This can be useful to get a ldap connection to the ldap publishing directory without having to get it again from the config file. Note that this means sharing a ldap connection pool with the ldap publishing module so be sure to return connections to pool. Use ILdapConnFactory.getConn() to get a Ldap connection to the ldap publishing directory. Use ILdapConnFactory.returnConn() to return the connection.

Returns:
Instance of ILdapConnFactory.