LdapConnectionManagerConfig (sakai-jldap-provider 20.6 API)

All Known Implementing Classes:

JLDAPDirectoryProvider
```
public interface LdapConnectionManagerConfig
```
Bean interface for collecting LdapConnectionManager configuration.
This interface was introduced to retain forward compatibility of <=2.3.0 config files, which configure a single JLDAPDirectoryProvider bean. As of this writing, that class now implements this interface as a mixin and makes itself available to the LdapConnectionManager as a side-effect of JLDAPDirectoryProvider.init().

Author:

Dan McCallum, Unicon Inc

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`getBatchSize()`
`String`	`getKeystoreLocation()`
`String`	`getKeystorePassword()`
`String`	`getLdapHost()`
`String`	`getLdapPassword()`
`int`	`getLdapPort()`
`String`	`getLdapUser()`
`int`	`getMaxObjectsToQueryFor()` Deprecated. `getBatchSize()`
`int`	`getMaxResultSize()`
`int`	`getOperationTimeout()`
`int`	`getPoolMaxConns()`
`com.novell.ldap.LDAPSocketFactory`	`getSecureSocketFactory()` Assign a `LDAPSocketFactory` appropriate for your environment, e.g.
`com.novell.ldap.LDAPSocketFactory`	`getSocketFactory()` The socket factory to be used when creating insecure connections.
`boolean`	`isAutoBind()` Access the LDAP auto-bind configuration
`boolean`	`isFollowReferrals()` Access LDAP referral following configuration
`boolean`	`isPooling()` Access the LDAP pooling configuration
`boolean`	`isSecureConnection()` If `true`, connect to LDAP over a secure protocol.
`void`	`setAutoBind(boolean autoBind)` Configure the LDAP auto-bind configuration param autoBind if `true` connection allocation (`LdapConnectionManager.getConnection()`) will include a bind attempt
`void`	`setBatchSize(int batchSize)`
`void`	`setEnableAid(boolean enable)`
`void`	`setFollowReferrals(boolean followReferrals)` Configures LDAP referral following
`void`	`setKeystoreLocation(String keystoreLocation)`
`void`	`setKeystorePassword(String keystorePassword)`
`void`	`setLdapHost(String ldapHost)`
`void`	`setLdapPassword(String ldapPassword)`
`void`	`setLdapPort(int ldapPort)`
`void`	`setLdapUser(String ldapUser)`
`void`	`setMaxObjectsToQueryFor(int maxObjectsToQueryFor)` Deprecated. `setBatchSize(int)`
`void`	`setMaxResultSize(int maxResultSize)`
`void`	`setOperationTimeout(int operationTimeout)`
`void`	`setPooling(boolean pooling)` Configure the LDAP connection pooling configuration param pooling if `true` connections will be maintained in a connection pool.
`void`	`setPoolMaxConns(int maxConns)`
`void`	`setSecureConnection(boolean secureConnection)` Set to `true` if LDAP connections should occur over a secure protocol.
`void`	`setSecureSocketFactory(com.novell.ldap.LDAPSocketFactory secureSocketFactory)`
`void`	`setSocketFactory(com.novell.ldap.LDAPSocketFactory socketFactory)`

- Method Detail
  - isSecureConnection
```
boolean isSecureConnection()
```
    If true, connect to LDAP over a secure protocol.
  - setSecureConnection
```
void setSecureConnection(boolean secureConnection)
```
    Set to true if LDAP connections should occur over a secure protocol.
  - getKeystoreLocation
```
String getKeystoreLocation()
```
    Returns:
    
    location of a SSL keystore
  - setKeystoreLocation
```
void setKeystoreLocation(String keystoreLocation)
```
    Parameters:
    
    keystoreLocation - the location of an SSL keystore
  - getKeystorePassword
```
String getKeystorePassword()
```
    Returns:
    
    SSL keystore password
  - setKeystorePassword
```
void setKeystorePassword(String keystorePassword)
```
    Parameters:
    
    keystoreLocation - SSL keystore password
  - getSecureSocketFactory
```
com.novell.ldap.LDAPSocketFactory getSecureSocketFactory()
```
    Assign a LDAPSocketFactory appropriate for your environment, e.g. LDAPJSSESecureSocketFactory or LDAPJSSEStartTLSFactory. This factory will only be used if isSecureConnection() returns true
  - setSecureSocketFactory
```
void setSecureSocketFactory(com.novell.ldap.LDAPSocketFactory secureSocketFactory)
```
    Parameters:
    
    the - current secureSocketFactory. Should not return null.
  - getSocketFactory
```
com.novell.ldap.LDAPSocketFactory getSocketFactory()
```
    The socket factory to be used when creating insecure connections. This factory will only be used if isSecureConnection() returns false. Can return null if no socket factory needs to be used.
  - setSocketFactory
```
void setSocketFactory(com.novell.ldap.LDAPSocketFactory socketFactory)
```
    Parameters:
    
    socketFactory - the socketFactory to use.
  - getOperationTimeout
```
int getOperationTimeout()
```
    Returns:
    
    the directory operation timeout
  - setOperationTimeout
```
void setOperationTimeout(int operationTimeout)
```
    Parameters:
    
    operationTimeout - the directory operation timeout to set.
  - getLdapHost
```
String getLdapHost()
```
    Returns:
    
    the LDAP host address or name.
  - setLdapHost
```
void setLdapHost(String ldapHost)
```
    Parameters:
    
    ldapHost - The LDAP host address or name.
  - getLdapPort
```
int getLdapPort()
```
    Returns:
    
    the LDAP connection port.
  - setLdapPort
```
void setLdapPort(int ldapPort)
```
    Parameters:
    
    ldapPort - The LDAP connection port to set.
  - getLdapUser
```
String getLdapUser()
```
    Returns:
    
    the LDAP user to bind as, typically a manager acct.
  - setLdapUser
```
void setLdapUser(String ldapUser)
```
    Parameters:
    
    ldapUser - The user to bind to LDAP as, typically a manager acct, leave blank for anonymous.
  - getLdapPassword
```
String getLdapPassword()
```
    Returns:
    
    Returns the LDAP password corresponding to the current default bind-as user.
    
    See Also:
    
    getLdapUser()
  - setLdapPassword
```
void setLdapPassword(String ldapPassword)
```
    Parameters:
    
    ldapPassword - the LDAP password corresponding to the current default bind-as user.
  - isFollowReferrals
```
boolean isFollowReferrals()
```
    Access LDAP referral following configuration
    
    Returns:
    
    if true, directory accesses will follow referrals
  - setFollowReferrals
```
void setFollowReferrals(boolean followReferrals)
```
    Configures LDAP referral following
    
    Parameters:
    
    followReferrals - if true, directory accesses will follow referrals
  - isAutoBind
```
boolean isAutoBind()
```
    Access the LDAP auto-bind configuration
    
    Returns:
    
    if true connection allocation (LdapConnectionManager.getConnection()) will include a bind attempt
  - setAutoBind
```
void setAutoBind(boolean autoBind)
```
    Configure the LDAP auto-bind configuration param autoBind if true connection allocation (LdapConnectionManager.getConnection()) will include a bind attempt
  - isPooling
```
boolean isPooling()
```
    Access the LDAP pooling configuration
    
    Returns:
    
    if true connections will be maintained in a connection pool.
  - setPooling
```
void setPooling(boolean pooling)
```
    Configure the LDAP connection pooling configuration param pooling if true connections will be maintained in a connection pool. This automatically sets autoBind to true as well
  - getPoolMaxConns
```
int getPoolMaxConns()
```
    Returns:
    
    The maximum number of physical connections in the pool
  - setPoolMaxConns
```
void setPoolMaxConns(int maxConns)
```
    Parameters:
    
    maxConns - The maximum number of physical connections in the pool
  - getMaxObjectsToQueryFor
```
int getMaxObjectsToQueryFor()
```
    Deprecated. getBatchSize()
    
    Returns:
    
    The maximum number of objects to lookup in one query.
  - setMaxObjectsToQueryFor
```
void setMaxObjectsToQueryFor(int maxObjectsToQueryFor)
```
    Deprecated. setBatchSize(int)
    
    Parameters:
    
    maxObjectsToQueryFor - The maximum number objects to lookup in one query.
  - getBatchSize
```
int getBatchSize()
```
    Returns:
    
    The maximum number of objects to lookup in one query.
  - setBatchSize
```
void setBatchSize(int batchSize)
```
    Parameters:
    
    batchSize - The maximum number objects to lookup in one query.
  - getMaxResultSize
```
int getMaxResultSize()
```
    Returns:
    
    The maximum number of results to ever get back from LDAP.
  - setMaxResultSize
```
void setMaxResultSize(int maxResultSize)
```
    Parameters:
    
    maxResultSize - The maximum number of results to ever get back from LDAP.
  - setEnableAid
```
void setEnableAid(boolean enable)
```
    Parameters:
    
    enable - If true then perform searches for users by Authentication ID.

Interface LdapConnectionManagerConfig

Method Summary

Method Detail

isSecureConnection

setSecureConnection

getKeystoreLocation

setKeystoreLocation

getKeystorePassword

setKeystorePassword

getSecureSocketFactory

setSecureSocketFactory

getSocketFactory

setSocketFactory

getOperationTimeout

setOperationTimeout

getLdapHost

setLdapHost

getLdapPort

setLdapPort

getLdapUser

setLdapUser

getLdapPassword

setLdapPassword

isFollowReferrals

setFollowReferrals

isAutoBind

setAutoBind

isPooling

setPooling

getPoolMaxConns

setPoolMaxConns

getMaxObjectsToQueryFor

setMaxObjectsToQueryFor

getBatchSize

setBatchSize

getMaxResultSize

setMaxResultSize

setEnableAid