java.lang.Object
- com.netscape.cmscore.ldap.LdapConnModule

All Implemented Interfaces:: ILdapConnModule

public class LdapConnModule
extends java.lang.Object
implements ILdapConnModule

Field Summary

Fields
Modifier and Type Field Description

static org.slf4j.Logger logger

protected IConfigStore mConfig

protected LdapBoundConnFactory mLdapConnFactory

Constructor Summary

Constructors
Constructor Description

LdapConnModule()
instantiate connection factory.

LdapConnModule(LdapBoundConnFactory factory)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`netscape.ldap.LDAPConnection`	`getConn()`
`ILdapConnFactory`	`getLdapConnFactory()`	Returns the internal ldap connection factory.
`void`	`init(IConfigStore config)`	Initialize ldap publishing module with config store.
`void`	`returnConn(netscape.ldap.LDAPConnection conn)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logger
```
public static org.slf4j.Logger logger
```
  - mConfig
```
protected IConfigStore mConfig
```
  - mLdapConnFactory
```
protected LdapBoundConnFactory mLdapConnFactory
```
- Constructor Detail
  - LdapConnModule
```
public LdapConnModule()
```
    instantiate connection factory.
  - LdapConnModule
```
public LdapConnModule(LdapBoundConnFactory factory)
```
- Method Detail
  - init
```
public void init(IConfigStore config)
          throws EBaseException
```
    Description copied from interface: ILdapConnModule
    
    Initialize ldap publishing module with config store.
    
    Specified by:
    
    init in interface ILdapConnModule
    
    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
```
public 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.
    
    Specified by:
    
    getLdapConnFactory in interface ILdapConnModule
    
    Returns:
    
    Instance of ILdapConnFactory.
    
    See Also:
    
    com.netscape.certsrv.ldap.LdapBoundConnFactory, ILdapConnFactory
  - getConn
```
public netscape.ldap.LDAPConnection getConn()
                                     throws ELdapException
```
    Throws:
    
    ELdapException
  - returnConn
```
public void returnConn(netscape.ldap.LDAPConnection conn)
                throws ELdapException
```
    Throws:
    
    ELdapException

Modifier and Type	Field	Description
`static org.slf4j.Logger`	`logger`
`protected IConfigStore`	`mConfig`
`protected LdapBoundConnFactory`	`mLdapConnFactory`

Constructor	Description
`LdapConnModule()`	instantiate connection factory.
`LdapConnModule(LdapBoundConnFactory factory)`

Class LdapConnModule

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

mConfig

mLdapConnFactory

Constructor Detail

LdapConnModule

LdapConnModule

Method Detail

init

getLdapConnFactory

getConn

returnConn