LdapConnectionConfig (Apache Directory LDAP API Client API 2.1.3 API)

java.lang.Object
- org.apache.directory.ldap.client.api.LdapConnectionConfig

```
public class LdapConnectionConfig
extends Object
```
A class to hold the configuration for creating an LdapConnection.

Author:

Apache Directory Project

Field Summary

Fields
Modifier and Type	Field and Description
`private org.apache.directory.api.ldap.codec.api.BinaryAttributeDetector`	`binaryAttributeDetector` The class used to detect if an attribute is HR or not
`private Long`	`closeTimeout` Timeout for close and unbind operations
`private Long`	`connectTimeout` Timeout for connect and bind operations
`private String`	`credentials` user's credentials ( current implementation supports password only); it must be a non-null value
`static String`	`DEFAULT_LDAP_HOST` The default host : localhost
`static int`	`DEFAULT_LDAP_PORT` Default ports for LDAP
`static int`	`DEFAULT_LDAPS_PORT` Default port for LDAPS
`static String`	`DEFAULT_SSL_PROTOCOL` the default protocol used for creating SSL context
`static long`	`DEFAULT_TIMEOUT` The default timeout for operation : 30 seconds
`private String[]`	`enabledCipherSuites` an array of cipher suites which are enabled, if set, will be used while initializing the SSL context
`private String[]`	`enabledProtocols` an array of protocols which are enabled, if set, will be used while initializing the SSL context
`private KeyManager[]`	`keyManagers` an array of key managers, if set, will be used while initializing the SSL context
`static int`	`LDAP_V3` The LDAP version
`private org.apache.directory.api.ldap.codec.api.LdapApiService`	`ldapApiService` The Service to use internally when creating connections
`private String`	`ldapHost` the remote LDAP host
`private int`	`ldapPort` The selected LDAP port
`private static org.slf4j.Logger`	`LOG` A logger for this class
`private String`	`name` a valid Dn to authenticate the user
`private Long`	`readOperationTimeout` Timeout for read operations (search, compare)
`private SecureRandom`	`secureRandom` an instance of SecureRandom, if set, will be used while initializing the SSL context
`private Long`	`sendTimeout` Timeout for I/O (TCP) writes
`private String`	`sslProtocol` name of the protocol used for creating SSL context, default value is "TLS"
`private long`	`timeout` The session timeout in milliseconds
`private TrustManager[]`	`trustManagers` an array of certificate trust managers, if set, will be used while initializing the SSL context
`private boolean`	`useSsl` A flag indicating if we are using SSL or not, default value is false
`private boolean`	`useTls` A flag indicating if we are using TLS or not, default value is false
`private Long`	`writeOperationTimeout` Timeout for write operations (add, modify, delete, ...)

Constructor Summary

Constructors
Constructor and Description

LdapConnectionConfig()
Creates a default LdapConnectionConfig instance

Constructors
Constructor and Description
`LdapConnectionConfig()` Creates a default LdapConnectionConfig instance

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.apache.directory.api.ldap.codec.api.BinaryAttributeDetector`	`getBinaryAttributeDetector()`
`Long`	`getCloseTimeout()` Gets close timeout in milliseconds.
`Long`	`getConnectTimeout()` Gets connect timeout in milliseconds.
`String`	`getCredentials()` Gets the credentials.
`String`	`getDefaultLdapHost()` Gets the default LDAP host.
`int`	`getDefaultLdapPort()` Gets the default LDAP port.
`int`	`getDefaultLdapsPort()` Gets the default LDAPS port.
`long`	`getDefaultTimeout()` Gets the default timeout in milliseconds.
`String[]`	`getEnabledCipherSuites()` Gets the cipher suites which are enabled.
`String[]`	`getEnabledProtocols()` Gets the protocols which are enabled.
`KeyManager[]`	`getKeyManagers()` Gets the key managers.
`org.apache.directory.api.ldap.codec.api.LdapApiService`	`getLdapApiService()`
`String`	`getLdapHost()` Gets the LDAP host.
`int`	`getLdapPort()` Gets the LDAP port.
`String`	`getName()` Gets the name that is used to authenticate the user.
`Long`	`getReadOperationTimeout()` Gets read operation timeout in milliseconds.
`SecureRandom`	`getSecureRandom()` Gets the secure random.
`Long`	`getSendTimeout()` Gets send timeout in milliseconds.
`String`	`getSslProtocol()` Gets the SSL protocol.
`int`	`getSupportedLdapVersion()` Gets the supported LDAP version.
`long`	`getTimeout()` Gets the timeout in milliseconds.
`TrustManager[]`	`getTrustManagers()` Gets the trust managers.
`Long`	`getWriteOperationTimeout()` Gets write operation timeout in milliseconds.
`boolean`	`isUseSsl()` Checks if SSL (ldaps://) is used.
`boolean`	`isUseTls()` Checks if TLS is used.
`void`	`setBinaryAttributeDetector(org.apache.directory.api.ldap.codec.api.BinaryAttributeDetector binaryAttributeDetector)`
`void`	`setCloseTimeout(Long timeout)` Sets close timeout in milliseconds.
`void`	`setConnectTimeout(Long timeout)` Sets connect timeout in milliseconds.
`void`	`setCredentials(String credentials)` Sets the credentials.
`private void`	`setDefaultTrustManager()` Sets the default trust manager based on the SunX509 trustManagement algorithm
`void`	`setEnabledCipherSuites(String[] enabledCipherSuites)` Sets the cipher suites which are enabled
`void`	`setEnabledProtocols(String... enabledProtocols)` Sets the protocols which are enabled
`void`	`setKeyManagers(KeyManager[] keyManagers)` Sets the key managers.
`void`	`setLdapApiService(org.apache.directory.api.ldap.codec.api.LdapApiService ldapApiService)`
`void`	`setLdapHost(String ldapHost)` Sets the LDAP host.
`void`	`setLdapPort(int ldapPort)` Sets the LDAP port.
`void`	`setName(String name)` Sets the name which is used to authenticate the user.
`void`	`setReadOperationTimeout(Long timeout)` Sets read operation timeout in milliseconds.
`void`	`setSecureRandom(SecureRandom secureRandom)` Sets the secure random.
`void`	`setSendTimeout(Long timeout)` Sets the send timeout in milliseconds.
`void`	`setSslProtocol(String sslProtocol)` Sets the SSL protocol.
`void`	`setTimeout(long timeout)` Sets the timeout in milliseconds.
`void`	`setTrustManagers(TrustManager... trustManagers)` Sets the trust managers.
`void`	`setUseSsl(boolean useSsl)` Sets whether SSL should be used.
`void`	`setUseTls(boolean useTls)` Sets whether TLS should be used.
`void`	`setWriteOperationTimeout(Long timeout)` Sets write operation timeout in milliseconds.

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

- Field Detail
  - LOG
```
private static final org.slf4j.Logger LOG
```
    A logger for this class
  - DEFAULT_LDAP_PORT
```
public static final int DEFAULT_LDAP_PORT
```
    Default ports for LDAP
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LDAPS_PORT
```
public static final int DEFAULT_LDAPS_PORT
```
    Default port for LDAPS
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LDAP_HOST
```
public static final String DEFAULT_LDAP_HOST
```
    The default host : localhost
    
    See Also:
    
    Constant Field Values
  - LDAP_V3
```
public static final int LDAP_V3
```
    The LDAP version
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TIMEOUT
```
public static final long DEFAULT_TIMEOUT
```
    The default timeout for operation : 30 seconds
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SSL_PROTOCOL
```
public static final String DEFAULT_SSL_PROTOCOL
```
    the default protocol used for creating SSL context
    
    See Also:
    
    Constant Field Values
  - useSsl
```
private boolean useSsl
```
    A flag indicating if we are using SSL or not, default value is false
  - timeout
```
private long timeout
```
    The session timeout in milliseconds
  - connectTimeout
```
private Long connectTimeout
```
    Timeout for connect and bind operations
  - writeOperationTimeout
```
private Long writeOperationTimeout
```
    Timeout for write operations (add, modify, delete, ...)
  - readOperationTimeout
```
private Long readOperationTimeout
```
    Timeout for read operations (search, compare)
  - closeTimeout
```
private Long closeTimeout
```
    Timeout for close and unbind operations
  - sendTimeout
```
private Long sendTimeout
```
    Timeout for I/O (TCP) writes
  - useTls
```
private boolean useTls
```
    A flag indicating if we are using TLS or not, default value is false
  - ldapPort
```
private int ldapPort
```
    The selected LDAP port
  - ldapHost
```
private String ldapHost
```
    the remote LDAP host
  - name
```
private String name
```
    a valid Dn to authenticate the user
  - credentials
```
private String credentials
```
    user's credentials ( current implementation supports password only); it must be a non-null value
  - keyManagers
```
private KeyManager[] keyManagers
```
    an array of key managers, if set, will be used while initializing the SSL context
  - secureRandom
```
private SecureRandom secureRandom
```
    an instance of SecureRandom, if set, will be used while initializing the SSL context
  - trustManagers
```
private TrustManager[] trustManagers
```
    an array of certificate trust managers, if set, will be used while initializing the SSL context
  - enabledCipherSuites
```
private String[] enabledCipherSuites
```
    an array of cipher suites which are enabled, if set, will be used while initializing the SSL context
  - enabledProtocols
```
private String[] enabledProtocols
```
    an array of protocols which are enabled, if set, will be used while initializing the SSL context
  - sslProtocol
```
private String sslProtocol
```
    name of the protocol used for creating SSL context, default value is "TLS"
  - binaryAttributeDetector
```
private org.apache.directory.api.ldap.codec.api.BinaryAttributeDetector binaryAttributeDetector
```
    The class used to detect if an attribute is HR or not
  - ldapApiService
```
private org.apache.directory.api.ldap.codec.api.LdapApiService ldapApiService
```
    The Service to use internally when creating connections
- Constructor Detail
  - LdapConnectionConfig
```
public LdapConnectionConfig()
```
    Creates a default LdapConnectionConfig instance
- Method Detail
  - setDefaultTrustManager
```
private void setDefaultTrustManager()
```
    Sets the default trust manager based on the SunX509 trustManagement algorithm
  - isUseSsl
```
public boolean isUseSsl()
```
    Checks if SSL (ldaps://) is used.
    
    Returns:
    
    true, if SSL is used
  - setUseSsl
```
public void setUseSsl(boolean useSsl)
```
    Sets whether SSL should be used.
    
    Parameters:
    
    useSsl - true to use SSL
  - getLdapPort
```
public int getLdapPort()
```
    Gets the LDAP port.
    
    Returns:
    
    the LDAP port
  - setLdapPort
```
public void setLdapPort(int ldapPort)
```
    Sets the LDAP port.
    
    Parameters:
    
    ldapPort - the new LDAP port
  - getLdapHost
```
public String getLdapHost()
```
    Gets the LDAP host.
    
    Returns:
    
    the LDAP host
  - setLdapHost
```
public void setLdapHost(String ldapHost)
```
    Sets the LDAP host.
    
    Parameters:
    
    ldapHost - the new LDAP host
  - getName
```
public String getName()
```
    Gets the name that is used to authenticate the user.
    
    Returns:
    
    the name
  - setName
```
public void setName(String name)
```
    Sets the name which is used to authenticate the user.
    
    Parameters:
    
    name - the new name
  - getCredentials
```
public String getCredentials()
```
    Gets the credentials.
    
    Returns:
    
    the credentials
  - setCredentials
```
public void setCredentials(String credentials)
```
    Sets the credentials.
    
    Parameters:
    
    credentials - the new credentials
  - getDefaultLdapPort
```
public int getDefaultLdapPort()
```
    Gets the default LDAP port.
    
    Returns:
    
    the default LDAP port
  - getDefaultLdapsPort
```
public int getDefaultLdapsPort()
```
    Gets the default LDAPS port.
    
    Returns:
    
    the default LDAPS port
  - getDefaultLdapHost
```
public String getDefaultLdapHost()
```
    Gets the default LDAP host.
    
    Returns:
    
    the default LDAP host
  - getDefaultTimeout
```
public long getDefaultTimeout()
```
    Gets the default timeout in milliseconds.
    
    Returns:
    
    the default timeout in milliseconds
  - getTimeout
```
public long getTimeout()
```
    Gets the timeout in milliseconds. This is a "global" timeout. It is used when operation-specific timeouts are not specified. It is also used for extended operations.
    
    Returns:
    
    the timeout in milliseconds
  - setTimeout
```
public void setTimeout(long timeout)
```
    Sets the timeout in milliseconds. This is a "global" timeout. It is used when operation-specific timeouts are not specified. It is also used for extended operations.
    
    Parameters:
    
    timeout - the timeout in milliseconds to set. If < 0, will be set to infinite
  - getConnectTimeout
```
public Long getConnectTimeout()
```
    Gets connect timeout in milliseconds. Connect timeout is applied to connect and bind operations. If not specified, global timeout setting is applied.
    
    Returns:
    
    the timeout in milliseconds
  - setConnectTimeout
```
public void setConnectTimeout(Long timeout)
```
    Sets connect timeout in milliseconds. Connect timeout is applied to connect and bind operations. If not specified, global timeout setting is applied.
    
    Parameters:
    
    timeout - the timeout in milliseconds to set. If < 0, will be set to infinite
  - getWriteOperationTimeout
```
public Long getWriteOperationTimeout()
```
    Gets write operation timeout in milliseconds. Write operation timeout is applied to operations that write data, such as add, modify and delete. If not specified, global timeout setting is applied.
    
    Returns:
    
    the timeout in milliseconds
  - setWriteOperationTimeout
```
public void setWriteOperationTimeout(Long timeout)
```
    Sets write operation timeout in milliseconds. Write operation timeout is applied to operations that write data, such as add, modify and delete. If not specified, global timeout setting is applied.
    
    Parameters:
    
    timeout - the timeout in milliseconds to set. If < 0, will be set to infinite
  - getReadOperationTimeout
```
public Long getReadOperationTimeout()
```
    Gets read operation timeout in milliseconds. This timeout is applied to read operations, such as search and compare. If not specified, global timeout setting is applied.
    
    Returns:
    
    the timeout in milliseconds
  - setReadOperationTimeout
```
public void setReadOperationTimeout(Long timeout)
```
    Sets read operation timeout in milliseconds. This timeout is applied to read operations, such as search and compare. If not specified, global timeout setting is applied.
    
    Parameters:
    
    timeout - the timeout in milliseconds to set. If < 0, will be set to infinite
  - getCloseTimeout
```
public Long getCloseTimeout()
```
    Gets close timeout in milliseconds. Close timeout is applied to close and unbind operations. If not specified, global timeout setting is applied.
    
    Returns:
    
    the timeout in milliseconds
  - setCloseTimeout
```
public void setCloseTimeout(Long timeout)
```
    Sets close timeout in milliseconds. Close timeout is applied to close and unbind operations. If not specified, global timeout setting is applied.
    
    Parameters:
    
    timeout - the timeout in milliseconds to set. If < 0, will be set to infinite
  - getSendTimeout
```
public Long getSendTimeout()
```
    Gets send timeout in milliseconds. Send timeout is used for I/O (TCP) write operations. If not specified, global timeout setting is applied.
    
    Returns:
    
    the timeout in milliseconds
  - setSendTimeout
```
public void setSendTimeout(Long timeout)
```
    Sets the send timeout in milliseconds. Send timeout is used for I/O (TCP) write operations. If not specified, global timeout setting is applied.
    
    Parameters:
    
    timeout - the timeout in milliseconds to set. If < 0, will be set to infinite
  - getSupportedLdapVersion
```
public int getSupportedLdapVersion()
```
    Gets the supported LDAP version.
    
    Returns:
    
    the supported LDAP version
  - getTrustManagers
```
public TrustManager[] getTrustManagers()
```
    Gets the trust managers.
    
    Returns:
    
    the trust managers
  - setTrustManagers
```
public void setTrustManagers(TrustManager... trustManagers)
```
    Sets the trust managers.
    
    Parameters:
    
    trustManagers - the new trust managers
    
    Throws:
    
    IllegalArgumentException - if the trustManagers parameter is null or empty
  - getSslProtocol
```
public String getSslProtocol()
```
    Gets the SSL protocol.
    
    Returns:
    
    the SSL protocol
  - setSslProtocol
```
public void setSslProtocol(String sslProtocol)
```
    Sets the SSL protocol.
    
    Parameters:
    
    sslProtocol - the new SSL protocol
  - getKeyManagers
```
public KeyManager[] getKeyManagers()
```
    Gets the key managers.
    
    Returns:
    
    the key managers
  - setKeyManagers
```
public void setKeyManagers(KeyManager[] keyManagers)
```
    Sets the key managers.
    
    Parameters:
    
    keyManagers - the new key managers
  - getSecureRandom
```
public SecureRandom getSecureRandom()
```
    Gets the secure random.
    
    Returns:
    
    the secure random
  - setSecureRandom
```
public void setSecureRandom(SecureRandom secureRandom)
```
    Sets the secure random.
    
    Parameters:
    
    secureRandom - the new secure random
  - getEnabledCipherSuites
```
public String[] getEnabledCipherSuites()
```
    Gets the cipher suites which are enabled.
    
    Returns:
    
    the cipher suites which are enabled
  - setEnabledCipherSuites
```
public void setEnabledCipherSuites(String[] enabledCipherSuites)
```
    Sets the cipher suites which are enabled
    
    Parameters:
    
    enabledCipherSuites - the cipher suites which are enabled
  - getEnabledProtocols
```
public String[] getEnabledProtocols()
```
    Gets the protocols which are enabled.
    
    Returns:
    
    the protocol which are enabled
  - setEnabledProtocols
```
public void setEnabledProtocols(String... enabledProtocols)
```
    Sets the protocols which are enabled
    
    Parameters:
    
    enabledProtocols - the protocols which are enabled
  - getBinaryAttributeDetector
```
public org.apache.directory.api.ldap.codec.api.BinaryAttributeDetector getBinaryAttributeDetector()
```
    Returns:
    
    the binaryAttributeDetector
  - setBinaryAttributeDetector
```
public void setBinaryAttributeDetector(org.apache.directory.api.ldap.codec.api.BinaryAttributeDetector binaryAttributeDetector)
```
    Parameters:
    
    binaryAttributeDetector - the binaryAttributeDetector to set
  - isUseTls
```
public boolean isUseTls()
```
    Checks if TLS is used.
    
    Returns:
    
    true, if TLS is used
  - setUseTls
```
public void setUseTls(boolean useTls)
```
    Sets whether TLS should be used.
    
    Parameters:
    
    useTls - true to use TLS
  - getLdapApiService
```
public org.apache.directory.api.ldap.codec.api.LdapApiService getLdapApiService()
```
    Returns:
    
    the ldapApiService
  - setLdapApiService
```
public void setLdapApiService(org.apache.directory.api.ldap.codec.api.LdapApiService ldapApiService)
```
    Parameters:
    
    ldapApiService - the ldapApiService to set

Class LdapConnectionConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

DEFAULT_LDAP_PORT

DEFAULT_LDAPS_PORT

DEFAULT_LDAP_HOST

LDAP_V3

DEFAULT_TIMEOUT

DEFAULT_SSL_PROTOCOL

useSsl

timeout

connectTimeout

writeOperationTimeout

readOperationTimeout

closeTimeout

sendTimeout

useTls

ldapPort

ldapHost

name

credentials

keyManagers

secureRandom

trustManagers

enabledCipherSuites

enabledProtocols

sslProtocol

binaryAttributeDetector

ldapApiService

Constructor Detail

LdapConnectionConfig

Method Detail

setDefaultTrustManager

isUseSsl

setUseSsl

getLdapPort

setLdapPort

getLdapHost

setLdapHost

getName

setName

getCredentials

setCredentials

getDefaultLdapPort

getDefaultLdapsPort

getDefaultLdapHost

getDefaultTimeout

getTimeout

setTimeout

getConnectTimeout

setConnectTimeout

getWriteOperationTimeout

setWriteOperationTimeout

getReadOperationTimeout

setReadOperationTimeout

getCloseTimeout

setCloseTimeout

getSendTimeout

setSendTimeout

getSupportedLdapVersion

getTrustManagers

setTrustManagers

getSslProtocol

setSslProtocol

getKeyManagers

setKeyManagers

getSecureRandom

setSecureRandom

getEnabledCipherSuites

setEnabledCipherSuites

getEnabledProtocols

setEnabledProtocols

getBinaryAttributeDetector

setBinaryAttributeDetector

isUseTls

setUseTls