Package org.forgerock.opendj.ldap

Class CommonLDAPOptions

java.lang.Object

org.forgerock.opendj.ldap.CommonLDAPOptions

Direct Known Subclasses:

LDAPConnectionFactory, LDAPListener

public abstract class CommonLDAPOptions
extends Object

Common options for LDAP clients and listeners.

Field Summary

Fields

Modifier and Type	Field	Description
static final org.forgerock.util.Option<DecodeOptions>	LDAP_DECODE_OPTIONS	Sets the decoding options which will be used to control how requests and responses are decoded.
static final org.forgerock.util.Option<Boolean>	SO_KEEPALIVE	Specifies the value of the SO_KEEPALIVE socket option for new connections.
static final org.forgerock.util.Option<Integer>	SO_LINGER_IN_SECONDS	Specifies the value of the SO_LINGER socket option for new connections.
static final org.forgerock.util.Option<Boolean>	SO_REUSE_ADDRESS	Specifies the value of the SO_REUSEADDR socket option for new connections.
static final org.forgerock.util.Option<Boolean>	TCP_NO_DELAY	Specifies the value of the TCP_NODELAY socket option for new connections.
static final org.forgerock.util.Option<String>	TRANSPORT_PROVIDER	Specifies the name of the provider to use for transport.
static final org.forgerock.util.Option<ClassLoader>	TRANSPORT_PROVIDER_CLASS_LOADER	Specifies the class loader which will be used to load the TransportProvider.

Constructor Summary

Constructors

Constructor	Description
CommonLDAPOptions()

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

TRANSPORT_PROVIDER_CLASS_LOADER

public static final org.forgerock.util.Option<ClassLoader> TRANSPORT_PROVIDER_CLASS_LOADER

Specifies the class loader which will be used to load the TransportProvider.

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

TRANSPORT_PROVIDER

public static final org.forgerock.util.Option<String> TRANSPORT_PROVIDER

Specifies the name of the provider to use for transport.

Transport providers implement TransportProvider interface.

The name should correspond to the name of an existing provider, as returned by TransportProvider#getName() method.

TCP_NO_DELAY

public static final org.forgerock.util.Option<Boolean> TCP_NO_DELAY

Specifies the value of the TCP_NODELAY socket option for new connections.

The default setting is true and may be configured using the org.forgerock.opendj.io.tcpNoDelay property.

SO_REUSE_ADDRESS

public static final org.forgerock.util.Option<Boolean> SO_REUSE_ADDRESS

Specifies the value of the 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_LINGER_IN_SECONDS

public static final org.forgerock.util.Option<Integer> SO_LINGER_IN_SECONDS

Specifies the value of the 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_KEEPALIVE

public static final org.forgerock.util.Option<Boolean> SO_KEEPALIVE

Specifies the value of the SO_KEEPALIVE socket option for new connections.

The default setting is true and may be configured using the org.forgerock.opendj.io.keepAlive property.

LDAP_DECODE_OPTIONS

public static final org.forgerock.util.Option<DecodeOptions> LDAP_DECODE_OPTIONS

Sets the decoding options which will be used to control how requests and responses are decoded.

Constructor Details

CommonLDAPOptions

public CommonLDAPOptions()