public final class LDAPListenerOptions extends Object
| Constructor and Description |
|---|
LDAPListenerOptions()
Creates a new set of listener options with default settings.
|
LDAPListenerOptions(LDAPListenerOptions options)
Creates a new set of listener options having the same initial set of
options as the provided set of listener options.
|
| Modifier and Type | Method and Description |
|---|---|
int |
getBacklog()
Returns the maximum queue length for incoming connections requests.
|
DecodeOptions |
getDecodeOptions()
Returns the decoding options which will be used to control how requests
and responses are decoded.
|
int |
getLinger()
Returns the value of the
SO_LINGER socket option for new connections. |
int |
getMaxRequestSize()
Returns the maximum request size in bytes for incoming LDAP requests.
|
ClassLoader |
getProviderClassLoader()
Returns the class loader which will be used to load the
TransportProvider. |
String |
getTransportProvider()
Returns the name of the provider used for transport.
|
boolean |
isKeepAlive()
Returns the value of the
SO_KEEPALIVE socket option for new connections. |
boolean |
isReuseAddress()
Returns the value of the
SO_REUSEADDR socket option for new connections. |
boolean |
isTCPNoDelay()
Returns the value of the
TCP_NODELAY socket option for new connections. |
LDAPListenerOptions |
setBacklog(int backlog)
Sets the maximum queue length for incoming connections requests.
|
T |
setDecodeOptions(DecodeOptions decodeOptions)
Sets the decoding options which will be used to control how requests and
responses are decoded.
|
T |
setKeepAlive(boolean keepAlive)
Specifies the value of the
SO_KEEPALIVE socket option for new connections. |
T |
setLinger(int linger)
Specifies the value of the
SO_LINGER socket option for new connections. |
LDAPListenerOptions |
setMaxRequestSize(int maxRequestSize)
Sets the maximum request size in bytes for incoming LDAP requests.
|
T |
setProviderClassLoader(ClassLoader classLoader)
Sets the class loader which will be used to load the
TransportProvider. |
T |
setReuseAddress(boolean reuseAddress)
Specifies the value of the
SO_REUSEADDR socket option for new connections. |
T |
setTCPNoDelay(boolean tcpNoDelay)
Specifies the value of the
TCP_NODELAY socket option for new connections. |
T |
setTransportProvider(String providerName)
Sets the name of the provider to use for transport.
|
public LDAPListenerOptions()
public LDAPListenerOptions(LDAPListenerOptions options)
options - The set of listener options to be copied.public int getBacklog()
1 then a default value of
50 will be used.public int getMaxRequestSize()
1 then a default value
of 5MB will be used.public LDAPListenerOptions setBacklog(int backlog)
1 then a default value of
50 will be used.backlog - The maximum queue length for incoming connections requests.public LDAPListenerOptions setMaxRequestSize(int maxRequestSize)
1 then a default value of
5MB will be used.maxRequestSize - The maximum request size in bytes for incoming LDAP requests.public DecodeOptions getDecodeOptions()
null).public int getLinger()
SO_LINGER socket option for new connections.
The default setting is -1 (disabled) and may be configured using
the org.forgerock.opendj.io.linger property.
SO_LINGER socket option for new connections, or -1 if linger
should be disabled.public ClassLoader getProviderClassLoader()
TransportProvider.
By default this method will return null indicating that the
default class loader will be used.
The transport provider is loaded using java.util.ServiceLoader,
the JDK service-provider loading facility. The provider must be
accessible from the same class loader that was initially queried to
locate the configuration file; note that this is not necessarily the
class loader from which the file was actually loaded. This method allows
to provide a class loader to be used for loading the provider.
null if the default class loader should be
used.public String getTransportProvider()
Transport providers implement TransportProvider interface.
The name should correspond to the name of an existing provider, as
returned by TransportProvider#getName() method.
null if no
specific provider has been selected. In that case, the first
provider found will be used.public boolean isKeepAlive()
SO_KEEPALIVE socket option for new connections.
The default setting is true and may be configured using the
org.forgerock.opendj.io.keepAlive property.
SO_KEEPALIVE socket option for new connections.public boolean isReuseAddress()
SO_REUSEADDR socket option for new connections.
The default setting is true and may be configured using the
org.forgerock.opendj.io.reuseAddress property.
SO_REUSEADDR socket option for new connections.public boolean isTCPNoDelay()
TCP_NODELAY socket option for new connections.
The default setting is true and may be configured using the
org.forgerock.opendj.io.tcpNoDelay property.
TCP_NODELAY socket option for new connections.public T setDecodeOptions(DecodeOptions decodeOptions)
decodeOptions - The decoding options which will be used to control how
requests and responses are decoded (never null).NullPointerException - If decodeOptions was null.public T setKeepAlive(boolean keepAlive)
SO_KEEPALIVE socket option for new connections.
The default setting is true and may be configured using the
org.forgerock.opendj.io.keepAlive property.
keepAlive - The value of the SO_KEEPALIVE socket option for new connections.public T setLinger(int linger)
SO_LINGER socket option for new connections.
The default setting is -1 (disabled) and may be configured using
the org.forgerock.opendj.io.linger property.
linger - The value of the SO_LINGER socket option for new connections, or -1 if linger
should be disabled.public T setProviderClassLoader(ClassLoader classLoader)
TransportProvider.
The default class loader will be used if no class loader is set using this method.
The transport provider is loaded using java.util.ServiceLoader,
the JDK service-provider loading facility. The provider must be
accessible from the same class loader that was initially queried to
locate the configuration file; note that this is not necessarily the
class loader from which the file was actually loaded. This method allows
to provide a class loader to be used for loading the provider.
classLoader - The class loader which will be used when loading the transport
provider, or null if the default class loader should
be used.public T setReuseAddress(boolean reuseAddress)
SO_REUSEADDR socket option for new connections.
The default setting is true and may be configured using the
org.forgerock.opendj.io.reuseAddress property.
reuseAddress - The value of the SO_REUSEADDR socket option for new connections.public T setTCPNoDelay(boolean tcpNoDelay)
TCP_NODELAY socket option for new connections.
The default setting is true and may be configured using the
org.forgerock.opendj.io.tcpNoDelay property.
tcpNoDelay - The value of the TCP_NODELAY socket option for new connections.public T setTransportProvider(String providerName)
Transport providers implement TransportProvider interface.
The name should correspond to the name of an existing provider, as
returned by TransportProvider#getName() method.
providerName - The name of transport provider, or null if no specific
provider is preferred. In that case, the first provider found
will be used.Copyright © 2011-2015 ForgeRock AS. All Rights Reserved.