LdapConnectionManagerConfig (sakai-unboundid-provider 19.1 API)

All Known Implementing Classes:

UnboundidDirectoryProvider
```
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 UnboundidDirectoryProvider 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 UnboundidDirectoryProvider.init().

Author:

Dan McCallum, Unicon Inc

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`getBatchSize()`
`String[]`	`getLdapHost()`
`String`	`getLdapPassword()`
`int[]`	`getLdapPort()`
`String`	`getLdapUser()`
`int`	`getMaxResultSize()`
`int`	`getOperationTimeout()`
`int`	`getPoolMaxConns()`
`boolean`	`isAutoBind()` Access the LDAP auto-bind configuration
`boolean`	`isFollowReferrals()` Access LDAP referral following 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`	`setLdapHost(String[] ldapHost)`
`void`	`setLdapPassword(String ldapPassword)`
`void`	`setLdapPort(int[] ldapPort)`
`void`	`setLdapUser(String ldapUser)`
`void`	`setMaxResultSize(int maxResultSize)`
`void`	`setOperationTimeout(int operationTimeout)`
`void`	`setPoolMaxConns(int maxConns)`
`void`	`setSecureConnection(boolean secureConnection)` Set to `true` if LDAP connections should occur over a secure protocol.

- 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.
  - 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
  - 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
  - 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

getOperationTimeout

setOperationTimeout

getLdapHost

setLdapHost

getLdapPort

setLdapPort

getLdapUser

setLdapUser

getLdapPassword

setLdapPassword

isFollowReferrals

setFollowReferrals

isAutoBind

setAutoBind

getPoolMaxConns

setPoolMaxConns

getBatchSize

setBatchSize

getMaxResultSize

setMaxResultSize

setEnableAid