Interface ILdapConnModule

All Known Implementing Classes:
LdapConnModule
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$, $Date$

  • Method Summary

    Modifier and Type
    Method
    Description
    ILdapConnFactory
    getLdapConnFactory()
    Returns the internal ldap connection factory.
    void
    init(IConfigStore config)
    Initialize ldap publishing module with config store.

  • Method Details

    • init

      void init(IConfigStore config) throws EBaseException, ELdapException
      Initialize ldap publishing module with config store.
      Parameters:
      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.