org.ldaptive

Class ConnectionConfig

java.lang.Object

org.ldaptive.AbstractConfig

org.ldaptive.ConnectionConfig

public class ConnectionConfig
extends AbstractConfig

Contains all the configuration data needed to control connections.

Field Summary

Fields

Modifier and Type	Field and Description
private ConnectionInitializer	connectionInitializer Connection initializer to execute on Connection.open().
private long	connectTimeout Amount of time in milliseconds that connects will block.
private java.lang.String	ldapUrl URL to the LDAP(s).
private long	responseTimeout Amount of time in milliseconds to wait for responses.
private SslConfig	sslConfig Configuration for SSL and startTLS connections.
private boolean	useSSL Connect to LDAP using SSL protocol.
private boolean	useStartTLS Connect to LDAP using startTLS.

Fields inherited from class org.ldaptive.AbstractConfig

logger

Constructor Summary

Constructors

Constructor and Description
ConnectionConfig() Default constructor.
ConnectionConfig(java.lang.String url) Creates a new connection config.

Method Summary

Modifier and Type	Method and Description
ConnectionInitializer	getConnectionInitializer() Returns the connection initializer.
long	getConnectTimeout() Returns the connect timeout.
java.lang.String	getLdapUrl() Returns the ldap url.
long	getResponseTimeout() Returns the response timeout.
SslConfig	getSslConfig() Returns the ssl config.
boolean	getUseSSL() Returns whether the SSL protocol will be used for connections.
boolean	getUseStartTLS() Returns whether startTLS will be used for connections.
static ConnectionConfig	newConnectionConfig(ConnectionConfig config) Returns a connection config initialized with the supplied config.
void	setConnectionInitializer(ConnectionInitializer initializer) Sets the connection initializer.
void	setConnectTimeout(long time) Sets the maximum amount of time in milliseconds that connects will block.
void	setLdapUrl(java.lang.String url) Sets the ldap url.
void	setResponseTimeout(long time) Sets the maximum amount of time in milliseconds that operations will wait for a response.
void	setSslConfig(SslConfig config) Sets the ssl config.
void	setUseSSL(boolean b) Sets whether the SSL protocol will be used for connections.
void	setUseStartTLS(boolean b) Sets whether startTLS will be used for connections.
java.lang.String	toString()

Methods inherited from class org.ldaptive.AbstractConfig

checkImmutable, checkStringInput, makeImmutable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ldapUrl

private java.lang.String ldapUrl

URL to the LDAP(s).

connectTimeout

private long connectTimeout

Amount of time in milliseconds that connects will block.

responseTimeout

private long responseTimeout

Amount of time in milliseconds to wait for responses.

sslConfig

private SslConfig sslConfig

Configuration for SSL and startTLS connections.

useSSL

private boolean useSSL

Connect to LDAP using SSL protocol.

useStartTLS

private boolean useStartTLS

Connect to LDAP using startTLS.

connectionInitializer

private ConnectionInitializer connectionInitializer

Connection initializer to execute on Connection.open().

Constructor Detail

ConnectionConfig

public ConnectionConfig()

Default constructor.

ConnectionConfig

public ConnectionConfig(java.lang.String url)

Creates a new connection config.

Parameters:

url - to connect to

Method Detail

getLdapUrl

public java.lang.String getLdapUrl()

Returns the ldap url.

Returns:

ldap url

setLdapUrl

public void setLdapUrl(java.lang.String url)

Sets the ldap url.

Parameters:

url - of the ldap

getConnectTimeout

public long getConnectTimeout()

Returns the connect timeout. If this value is <= 0, then connects will wait indefinitely.

Returns:

timeout

setConnectTimeout

public void setConnectTimeout(long time)

Sets the maximum amount of time in milliseconds that connects will block.

Parameters:

time - timeout for connects

getResponseTimeout

public long getResponseTimeout()

Returns the response timeout. If this value is <= 0, then operations will wait indefinitely for a response.

Returns:

timeout

setResponseTimeout

public void setResponseTimeout(long time)

Sets the maximum amount of time in milliseconds that operations will wait for a response.

Parameters:

time - timeout for responses

getSslConfig

public SslConfig getSslConfig()

Returns the ssl config.

Returns:

ssl config

setSslConfig

public void setSslConfig(SslConfig config)

Sets the ssl config.

Parameters:

config - ssl config

getUseSSL

public boolean getUseSSL()

Returns whether the SSL protocol will be used for connections.

Returns:

whether the SSL protocol will be used

setUseSSL

public void setUseSSL(boolean b)

Sets whether the SSL protocol will be used for connections.

Parameters:

b - whether the SSL protocol will be used

getUseStartTLS

public boolean getUseStartTLS()

Returns whether startTLS will be used for connections.

Returns:

whether startTLS will be used

setUseStartTLS

public void setUseStartTLS(boolean b)

Sets whether startTLS will be used for connections.

Parameters:

b - whether startTLS will be used

getConnectionInitializer

public ConnectionInitializer getConnectionInitializer()

Returns the connection initializer.

Returns:

connection initializer

setConnectionInitializer

public void setConnectionInitializer(ConnectionInitializer initializer)

Sets the connection initializer.

Parameters:

initializer - connection initializer

newConnectionConfig

public static ConnectionConfig newConnectionConfig(ConnectionConfig config)

Returns a connection config initialized with the supplied config.

Parameters:

config - connection config to read properties from

Returns:

connection config

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object