com.unboundid.ldap.sdk
Class LDAPConnectionOptions

java.lang.Object
  extended by com.unboundid.ldap.sdk.LDAPConnectionOptions

public final class LDAPConnectionOptions
extends java.lang.Object

This class provides a data structure that may be used to configure a number of connection-related properties. Elements included in the set of connection options include:


Constructor Summary
LDAPConnectionOptions()
          Creates a new set of LDAP connection options with the default settings.
 
Method Summary
 boolean abandonOnTimeout()
          Indicates whether the LDAP SDK should attempt to abandon any request for which no response is received in the maximum response timeout period.
 boolean allowConcurrentSocketFactoryUse()
          Indicates whether to allow a socket factory instance (which may be shared across multiple connections) to be used create multiple sockets concurrently.
 boolean autoReconnect()
          Indicates whether associated connections should attempt to automatically reconnect to the target server if the connection is lost.
 boolean bindWithDNRequiresPassword()
          Indicates whether the SDK should allow simple bind operations that contain a bind DN but no password.
 boolean captureConnectStackTrace()
          Indicates whether the LDAP SDK should capture a thread stack trace for each attempt made to establish a connection.
 LDAPConnectionOptions duplicate()
          Returns a duplicate of this LDAP connection options object that may be modified without impacting this instance.
 boolean followReferrals()
          Indicates whether associated connections should attempt to follow any referrals that they encounter.
 int getConnectTimeoutMillis()
          Retrieves the maximum length of time in milliseconds that a connection attempt should be allowed to continue before giving up.
 DisconnectHandler getDisconnectHandler()
          Retrieves the disconnect handler to use for associated connections.
 int getLingerTimeoutSeconds()
          Retrieves the linger timeout in seconds that will be used if the SO_LINGER socket option is enabled.
 int getMaxMessageSize()
          Retrieves the maximum size in bytes for an LDAP message that a connection will attempt to read from the directory server.
 long getPooledSchemaTimeoutMillis()
          Retrieves the maximum length of time in milliseconds that a pooled schema object should be considered fresh.
 int getReceiveBufferSize()
          Retrieves the socket receive buffer size that should be requested when establishing a connection.
 ReferralConnector getReferralConnector()
          Retrieves the referral connector that will be used to establish and optionally authenticate connections to servers when attempting to follow referrals, if defined.
 int getReferralHopLimit()
          Retrieves the maximum number of hops that a connection should take when trying to follow a referral.
 long getResponseTimeoutMillis()
          Retrieves the maximum length of time in milliseconds that an operation should be allowed to block while waiting for a response from the server.
 int getSendBufferSize()
          Retrieves the socket send buffer size that should be requested when establishing a connection.
 SSLSocketVerifier getSSLSocketVerifier()
          Retrieves the SSLSocketVerifier that will be used to perform additional validation for any newly-created SSLSocket instances.
 UnsolicitedNotificationHandler getUnsolicitedNotificationHandler()
          Retrieves the unsolicited notification handler to use for associated connections.
 void setAbandonOnTimeout(boolean abandonOnTimeout)
          Specifies whether the LDAP SDK should attempt to abandon any request for which no response is received in the maximum response timeout period.
 void setAllowConcurrentSocketFactoryUse(boolean allowConcurrentSocketFactoryUse)
          Specifies whether to allow a socket factory instance (which may be shared across multiple connections) to be used create multiple sockets concurrently.
 void setAutoReconnect(boolean autoReconnect)
          Specifies whether associated connections should attempt to automatically reconnect to the target server if the connection is lost.
 void setBindWithDNRequiresPassword(boolean bindWithDNRequiresPassword)
          Specifies whether the SDK should allow simple bind operations that contain a bind DN but no password.
 void setCaptureConnectStackTrace(boolean captureConnectStackTrace)
          Specifies whether the LDAP SDK should capture a thread stack trace for each attempt made to establish a connection.
 void setConnectTimeoutMillis(int connectTimeout)
          Specifies the maximum length of time in milliseconds that a connection attempt should be allowed to continue before giving up.
 void setDisconnectHandler(DisconnectHandler handler)
          Specifies the disconnect handler to use for associated connections.
 void setFollowReferrals(boolean followReferrals)
          Specifies whether associated connections should attempt to follow any referrals that they encounter, using the referral connector for the associated connection.
 void setMaxMessageSize(int maxMessageSize)
          Specifies the maximum size in bytes for an LDAP message that a connection will attempt to read from the directory server.
 void setPooledSchemaTimeoutMillis(long pooledSchemaTimeout)
          Specifies the maximum length of time in milliseconds that a pooled schema object should be considered fresh.
 void setReceiveBufferSize(int receiveBufferSize)
          Specifies the socket receive buffer size that should be requested when establishing a connection.
 void setReferralConnector(ReferralConnector referralConnector)
          Specifies the referral connector that should be used to establish and optionally authenticate connections to servers when attempting to follow referrals.
 void setReferralHopLimit(int referralHopLimit)
          Specifies the maximum number of hops that a connection should take when trying to follow a referral.
 void setResponseTimeoutMillis(long responseTimeout)
          Specifies the maximum length of time in milliseconds that an operation should be allowed to block while waiting for a response from the server.
 void setSendBufferSize(int sendBufferSize)
          Specifies the socket send buffer size that should be requested when establishing a connection.
 void setSSLSocketVerifier(SSLSocketVerifier sslSocketVerifier)
          Specifies the SSLSocketVerifier that will be used to perform additional validation for any newly-created SSLSocket instances.
 void setUnsolicitedNotificationHandler(UnsolicitedNotificationHandler handler)
          Specifies the unsolicited notification handler to use for associated connections.
 void setUseKeepAlive(boolean useKeepAlive)
          Specifies whether to use the SO_KEEPALIVE option for the underlying sockets used by associated connections.
 void setUseLinger(boolean useLinger, int lingerTimeout)
          Specifies whether to use the SO_LINGER option for the underlying sockets used by associated connections.
 void setUsePooledSchema(boolean usePooledSchema)
          Indicates whether to have connections that are part of a pool try to use shared schema information when reading data from the server (e.g., to select the appropriate matching rules for the attributes included in a search result entry).
 void setUseReuseAddress(boolean useReuseAddress)
          Specifies whether to use the SO_REUSEADDR option for the underlying sockets used by associated connections.
 void setUseSchema(boolean useSchema)
          Specifies whether to try to use schema information when reading data from the server (e.g., to select the appropriate matching rules for the attributes included in a search result entry).
 void setUseSynchronousMode(boolean useSynchronousMode)
          Specifies whether to operate in synchronous mode, in which at most one operation may be in progress at any time on a given connection.
 void setUseTCPNoDelay(boolean useTCPNoDelay)
          Specifies whether to use the TCP_NODELAY option for the underlying sockets used by associated connections.
 java.lang.String toString()
          Retrieves a string representation of this LDAP connection.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this LDAP connection to the provided buffer.
 boolean useKeepAlive()
          Indicates whether to use the SO_KEEPALIVE option for the underlying sockets used by associated connections.
 boolean useLinger()
          Indicates whether to use the SO_LINGER option for the underlying sockets used by associated connections.
 boolean usePooledSchema()
          Indicates whether to have connections that are part of a pool try to use shared schema information when reading data from the server (e.g., to select the appropriate matching rules for the attributes included in a search result entry).
 boolean useReuseAddress()
          Indicates whether to use the SO_REUSEADDR option for the underlying sockets used by associated connections.
 boolean useSchema()
          Indicates whether to try to use schema information when reading data from the server (e.g., to select the appropriate matching rules for the attributes included in a search result entry).
 boolean useSynchronousMode()
          Indicates whether to operate in synchronous mode, in which at most one operation may be in progress at any time on a given connection, which may allow it to operate more efficiently and without requiring a separate reader thread per connection.
 boolean useTCPNoDelay()
          Indicates whether to use the TCP_NODELAY option for the underlying sockets used by associated connections.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LDAPConnectionOptions

public LDAPConnectionOptions()
Creates a new set of LDAP connection options with the default settings.

Method Detail

duplicate

public LDAPConnectionOptions duplicate()
Returns a duplicate of this LDAP connection options object that may be modified without impacting this instance.

Returns:
A duplicate of this LDAP connection options object that may be modified without impacting this instance.

autoReconnect

public boolean autoReconnect()
Indicates whether associated connections should attempt to automatically reconnect to the target server if the connection is lost. Note that this option will not have any effect on pooled connections because defunct pooled connections will be replaced by newly-created connections rather than attempting to re-establish the existing connection.

Returns:
true if associated connections should attempt to automatically reconnect to the target server if the connection is lost, or false if not.

setAutoReconnect

public void setAutoReconnect(boolean autoReconnect)
Specifies whether associated connections should attempt to automatically reconnect to the target server if the connection is lost. Note that automatic reconnection will only be available for authenticated clients if the authentication mechanism used provides support for re-binding on a new connection. Also note that this option will not have any effect on pooled connections because defunct pooled connections will be replaced by newly-created connections rather than attempting to re-establish the existing connection. Further, auto-reconnect should not be used with connections that use StartTLS or some other mechanism to alter the state of the connection beyond authentication.

Parameters:
autoReconnect - Specifies whether associated connections should attempt to automatically reconnect to the target server if the connection is lost.

bindWithDNRequiresPassword

public boolean bindWithDNRequiresPassword()
Indicates whether the SDK should allow simple bind operations that contain a bind DN but no password. Binds of this type may represent a security vulnerability in client applications because they may cause the client to believe that the user is properly authenticated when the server considers it to be an unauthenticated connection.

Returns:
true if the SDK should allow simple bind operations that contain a bind DN but no password, or false if not.

setBindWithDNRequiresPassword

public void setBindWithDNRequiresPassword(boolean bindWithDNRequiresPassword)
Specifies whether the SDK should allow simple bind operations that contain a bind DN but no password.

Parameters:
bindWithDNRequiresPassword - Indicates whether the SDK should allow simple bind operations that contain a bind DN but no password.

captureConnectStackTrace

public boolean captureConnectStackTrace()
Indicates whether the LDAP SDK should capture a thread stack trace for each attempt made to establish a connection. If this is enabled, then the LDAPConnection#getConnectStackTrace() method may be used to retrieve the stack trace.

Returns:
true if a thread stack trace should be captured whenever a connection is established, or false if not.

setCaptureConnectStackTrace

public void setCaptureConnectStackTrace(boolean captureConnectStackTrace)
Specifies whether the LDAP SDK should capture a thread stack trace for each attempt made to establish a connection.

Parameters:
captureConnectStackTrace - Indicates whether to capture a thread stack trace for each attempt made to establish a connection.

getConnectTimeoutMillis

public int getConnectTimeoutMillis()
Retrieves the maximum length of time in milliseconds that a connection attempt should be allowed to continue before giving up.

Returns:
The maximum length of time in milliseconds that a connection attempt should be allowed to continue before giving up, or zero to indicate that there should be no connect timeout.

setConnectTimeoutMillis

public void setConnectTimeoutMillis(int connectTimeout)
Specifies the maximum length of time in milliseconds that a connection attempt should be allowed to continue before giving up. A value of zero indicates that there should be no connect timeout.

Parameters:
connectTimeout - The maximum length of time in milliseconds that a connection attempt should be allowed to continue before giving up.

getResponseTimeoutMillis

public long getResponseTimeoutMillis()
Retrieves the maximum length of time in milliseconds that an operation should be allowed to block while waiting for a response from the server. This may be overridden on a per-operation basis.

Returns:
The maximum length of time in milliseconds that an operation should be allowed to block while waiting for a response from the server, or zero if there should not be any default timeout.

setResponseTimeoutMillis

public void setResponseTimeoutMillis(long responseTimeout)
Specifies the maximum length of time in milliseconds that an operation should be allowed to block while waiting for a response from the server. A value of zero indicates that there should be no timeout.

Parameters:
responseTimeout - The maximum length of time in milliseconds that an operation should be allowed to block while waiting for a response from the server.

abandonOnTimeout

public boolean abandonOnTimeout()
Indicates whether the LDAP SDK should attempt to abandon any request for which no response is received in the maximum response timeout period.

Returns:
true if the LDAP SDK should attempt to abandon any request for which no response is received in the maximum response timeout period, or false if no abandon attempt should be made in this circumstance.

setAbandonOnTimeout

public void setAbandonOnTimeout(boolean abandonOnTimeout)
Specifies whether the LDAP SDK should attempt to abandon any request for which no response is received in the maximum response timeout period.

Parameters:
abandonOnTimeout - Indicates whether the LDAP SDK should attempt to abandon any request for which no response is received in the maximum response timeout period.

useKeepAlive

public boolean useKeepAlive()
Indicates whether to use the SO_KEEPALIVE option for the underlying sockets used by associated connections.

Returns:
true if the SO_KEEPALIVE option should be used for the underlying sockets, or false if not.

setUseKeepAlive

public void setUseKeepAlive(boolean useKeepAlive)
Specifies whether to use the SO_KEEPALIVE option for the underlying sockets used by associated connections. Changes to this setting will take effect only for new sockets, and not for existing sockets.

Parameters:
useKeepAlive - Indicates whether to use the SO_KEEPALIVE option for the underlying sockets used by associated connections.

useLinger

public boolean useLinger()
Indicates whether to use the SO_LINGER option for the underlying sockets used by associated connections.

Returns:
true if the SO_LINGER option should be used for the underlying sockets, or false if not.

getLingerTimeoutSeconds

public int getLingerTimeoutSeconds()
Retrieves the linger timeout in seconds that will be used if the SO_LINGER socket option is enabled.

Returns:
The linger timeout in seconds that will be used if the SO_LINGER socket option is enabled.

setUseLinger

public void setUseLinger(boolean useLinger,
                         int lingerTimeout)
Specifies whether to use the SO_LINGER option for the underlying sockets used by associated connections. Changes to this setting will take effect only for new sockets, and not for existing sockets.

Parameters:
useLinger - Indicates whether to use the SO_LINGER option for the underlying sockets used by associated connections.
lingerTimeout - The linger timeout in seconds that should be used if this capability is enabled.

useReuseAddress

public boolean useReuseAddress()
Indicates whether to use the SO_REUSEADDR option for the underlying sockets used by associated connections.

Returns:
true if the SO_REUSEADDR option should be used for the underlying sockets, or false if not.

setUseReuseAddress

public void setUseReuseAddress(boolean useReuseAddress)
Specifies whether to use the SO_REUSEADDR option for the underlying sockets used by associated connections. Changes to this setting will take effect only for new sockets, and not for existing sockets.

Parameters:
useReuseAddress - Indicates whether to use the SO_REUSEADDR option for the underlying sockets used by associated connections.

useSchema

public boolean useSchema()
Indicates whether to try to use schema information when reading data from the server (e.g., to select the appropriate matching rules for the attributes included in a search result entry).

Returns:
true if schema should be used when reading data from the server, or false if not.

setUseSchema

public void setUseSchema(boolean useSchema)
Specifies whether to try to use schema information when reading data from the server (e.g., to select the appropriate matching rules for the attributes included in a search result entry).

Note that calling this method with a value of true will also cause the usePooledSchema setting to be given a value of false, since the two values should not both be true at the same time.

Parameters:
useSchema - Indicates whether to try to use schema information when reading data from the server.

usePooledSchema

public boolean usePooledSchema()
Indicates whether to have connections that are part of a pool try to use shared schema information when reading data from the server (e.g., to select the appropriate matching rules for the attributes included in a search result entry). If this is true, then connections in a connection pool will share the same cached schema information in a way that attempts to reduce network bandwidth and connection establishment time (by avoiding the need for each connection to retrieve its own copy of the schema).

If pooled schema is to be used, then it may be configured to expire so that the schema may be periodically re-retrieved for new connections to allow schema updates to be incorporated. This behavior is controlled by the value returned by the getPooledSchemaTimeoutMillis method.

Returns:
true if all connections in a connection pool should reference the same schema object, or false if each connection should retrieve its own copy of the schema.

setUsePooledSchema

public void setUsePooledSchema(boolean usePooledSchema)
Indicates whether to have connections that are part of a pool try to use shared schema information when reading data from the server (e.g., to select the appropriate matching rules for the attributes included in a search result entry).

Note that calling this method with a value of true will also cause the useSchema setting to be given a value of false, since the two values should not both be true at the same time.

Parameters:
usePooledSchema - Indicates whether all connections in a connection pool should reference the same schema object rather than attempting to retrieve their own copy of the schema.

getPooledSchemaTimeoutMillis

public long getPooledSchemaTimeoutMillis()
Retrieves the maximum length of time in milliseconds that a pooled schema object should be considered fresh. If the schema referenced by a connection pool is at least this old, then the next connection attempt may cause a new version of the schema to be retrieved.

This will only be used if the usePooledSchema method returns true. A value of zero indicates that the pooled schema will never expire.

Returns:
The maximum length of time, in milliseconds, that a pooled schema object should be considered fresh, or zero if pooled schema objects should never expire.

setPooledSchemaTimeoutMillis

public void setPooledSchemaTimeoutMillis(long pooledSchemaTimeout)
Specifies the maximum length of time in milliseconds that a pooled schema object should be considered fresh.

Parameters:
pooledSchemaTimeout - The maximum length of time in milliseconds that a pooled schema object should be considered fresh. A value less than or equal to zero will indicate that pooled schema should never expire.

useSynchronousMode

public boolean useSynchronousMode()
Indicates whether to operate in synchronous mode, in which at most one operation may be in progress at any time on a given connection, which may allow it to operate more efficiently and without requiring a separate reader thread per connection. The LDAP SDK will not absolutely enforce this restriction, but when operating in this mode correct behavior cannot be guaranteed when multiple attempts are made to use a connection for multiple concurrent operations.

Note that if synchronous mode is to be used, then this connection option must be set on the connection before any attempt is made to establish the connection. Once the connection has been established, then it will continue to operate in synchronous or asynchronous mode based on the options in place at the time it was connected.

Returns:
true if associated connections should operate in synchronous mode, or false if not.

setUseSynchronousMode

public void setUseSynchronousMode(boolean useSynchronousMode)
Specifies whether to operate in synchronous mode, in which at most one operation may be in progress at any time on a given connection.

Note that if synchronous mode is to be used, then this connection option must be set on the connection before any attempt is made to establish the connection. Once the connection has been established, then it will continue to operate in synchronous or asynchronous mode based on the options in place at the time it was connected.

Parameters:
useSynchronousMode - Indicates whether to operate in synchronous mode.

useTCPNoDelay

public boolean useTCPNoDelay()
Indicates whether to use the TCP_NODELAY option for the underlying sockets used by associated connections.

Returns:
true if the TCP_NODELAY option should be used for the underlying sockets, or false if not.

setUseTCPNoDelay

public void setUseTCPNoDelay(boolean useTCPNoDelay)
Specifies whether to use the TCP_NODELAY option for the underlying sockets used by associated connections. Changes to this setting will take effect only for new sockets, and not for existing sockets.

Parameters:
useTCPNoDelay - Indicates whether to use the TCP_NODELAY option for the underlying sockets used by associated connections.

followReferrals

public boolean followReferrals()
Indicates whether associated connections should attempt to follow any referrals that they encounter.

Returns:
true if associated connections should attempt to follow any referrals that they encounter, or false if not.

setFollowReferrals

public void setFollowReferrals(boolean followReferrals)
Specifies whether associated connections should attempt to follow any referrals that they encounter, using the referral connector for the associated connection.

Parameters:
followReferrals - Specifies whether associated connections should attempt to follow any referrals that they encounter.

getReferralHopLimit

public int getReferralHopLimit()
Retrieves the maximum number of hops that a connection should take when trying to follow a referral.

Returns:
The maximum number of hops that a connection should take when trying to follow a referral.

setReferralHopLimit

public void setReferralHopLimit(int referralHopLimit)
Specifies the maximum number of hops that a connection should take when trying to follow a referral.

Parameters:
referralHopLimit - The maximum number of hops that a connection should take when trying to follow a referral. It must be greater than zero.

getReferralConnector

public ReferralConnector getReferralConnector()
Retrieves the referral connector that will be used to establish and optionally authenticate connections to servers when attempting to follow referrals, if defined.

Returns:
The referral connector that will be used to establish and optionally authenticate connections to servers when attempting to follow referrals, or null if no specific referral connector has been configured and referral connections should be created using the same socket factory and bind request as the connection on which the referral was received.

setReferralConnector

public void setReferralConnector(ReferralConnector referralConnector)
Specifies the referral connector that should be used to establish and optionally authenticate connections to servers when attempting to follow referrals.

Parameters:
referralConnector - The referral connector that will be used to establish and optionally authenticate connections to servers when attempting to follow referrals. It may be null to indicate that the same socket factory and bind request as the connection on which the referral was received should be used to establish and authenticate connections for following referrals.

getMaxMessageSize

public int getMaxMessageSize()
Retrieves the maximum size in bytes for an LDAP message that a connection will attempt to read from the directory server. If it encounters an LDAP message that is larger than this size, then the connection will be terminated.

Returns:
The maximum size in bytes for an LDAP message that a connection will attempt to read from the directory server, or 0 if no limit will be enforced.

setMaxMessageSize

public void setMaxMessageSize(int maxMessageSize)
Specifies the maximum size in bytes for an LDAP message that a connection will attempt to read from the directory server. If it encounters an LDAP message that is larger than this size, then the connection will be terminated.

Parameters:
maxMessageSize - The maximum size in bytes for an LDAP message that a connection will attempt to read from the directory server. A value less than or equal to zero indicates that no limit should be enforced.

getDisconnectHandler

public DisconnectHandler getDisconnectHandler()
Retrieves the disconnect handler to use for associated connections.

Returns:
the disconnect handler to use for associated connections, or null if none is defined.

setDisconnectHandler

public void setDisconnectHandler(DisconnectHandler handler)
Specifies the disconnect handler to use for associated connections.

Parameters:
handler - The disconnect handler to use for associated connections.

getUnsolicitedNotificationHandler

public UnsolicitedNotificationHandler getUnsolicitedNotificationHandler()
Retrieves the unsolicited notification handler to use for associated connections.

Returns:
The unsolicited notification handler to use for associated connections, or null if none is defined.

setUnsolicitedNotificationHandler

public void setUnsolicitedNotificationHandler(UnsolicitedNotificationHandler handler)
Specifies the unsolicited notification handler to use for associated connections.

Parameters:
handler - The unsolicited notification handler to use for associated connections.

getReceiveBufferSize

public int getReceiveBufferSize()
Retrieves the socket receive buffer size that should be requested when establishing a connection.

Returns:
The socket receive buffer size that should be requested when establishing a connection, or zero if the default size should be used.

setReceiveBufferSize

public void setReceiveBufferSize(int receiveBufferSize)
Specifies the socket receive buffer size that should be requested when establishing a connection.

Parameters:
receiveBufferSize - The socket receive buffer size that should be requested when establishing a connection, or zero if the default size should be used.

getSendBufferSize

public int getSendBufferSize()
Retrieves the socket send buffer size that should be requested when establishing a connection.

Returns:
The socket send buffer size that should be requested when establishing a connection, or zero if the default size should be used.

setSendBufferSize

public void setSendBufferSize(int sendBufferSize)
Specifies the socket send buffer size that should be requested when establishing a connection.

Parameters:
sendBufferSize - The socket send buffer size that should be requested when establishing a connection, or zero if the default size should be used.

allowConcurrentSocketFactoryUse

public boolean allowConcurrentSocketFactoryUse()
Indicates whether to allow a socket factory instance (which may be shared across multiple connections) to be used create multiple sockets concurrently. In general, socket factory implementations are threadsafe and can be to create multiple connections simultaneously across separate threads, but this is known to not be the case in some VM implementations (e.g., SSL socket factories in IBM JVMs). This setting may be used to indicate whether concurrent socket creation attempts should be allowed (which may allow for better and more consistent performance, especially in cases where a connection attempt fails due to a timeout) or prevented (which may be necessary for non-threadsafe socket factory implementations).

Returns:
true if multiple threads should be able to concurrently use the same socket factory instance, or false if Java synchronization should be used to ensure that no more than one thread is allowed to use a socket factory at any given time.

setAllowConcurrentSocketFactoryUse

public void setAllowConcurrentSocketFactoryUse(boolean allowConcurrentSocketFactoryUse)
Specifies whether to allow a socket factory instance (which may be shared across multiple connections) to be used create multiple sockets concurrently. In general, socket factory implementations are threadsafe and can be to create multiple connections simultaneously across separate threads, but this is known to not be the case in some VM implementations (e.g., SSL socket factories in IBM JVMs). This setting may be used to indicate whether concurrent socket creation attempts should be allowed (which may allow for better and more consistent performance, especially in cases where a connection attempt fails due to a timeout) or prevented (which may be necessary for non-threadsafe socket factory implementations).

Parameters:
allowConcurrentSocketFactoryUse - Indicates whether to allow a socket factory instance to be used to create multiple sockets concurrently.

getSSLSocketVerifier

public SSLSocketVerifier getSSLSocketVerifier()
Retrieves the SSLSocketVerifier that will be used to perform additional validation for any newly-created SSLSocket instances.

Returns:
The SSLSocketVerifier that will be used to perform additional validation for any newly-created SSLSocket instances.

setSSLSocketVerifier

public void setSSLSocketVerifier(SSLSocketVerifier sslSocketVerifier)
Specifies the SSLSocketVerifier that will be used to perform additional validation for any newly-created SSLSocket instances.

Parameters:
sslSocketVerifier - The SSLSocketVerifier that will be used to perform additional validation for any newly-created SSLSocket instances.

toString

public java.lang.String toString()
Retrieves a string representation of this LDAP connection.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this LDAP connection.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP connection to the provided buffer.

Parameters:
buffer - The buffer to which to append a string representation of this LDAP connection.