LDAP Resource Adaptor Guide

LDAP user to use for each connection, can be empty for anonymous connections

LDAP password to use for each connection, can be empty; also see AllowUnauthenticatedBind

LDAP server groups information to use for the connections

how long, in milliseconds, the resource adaptor should wait when trying to establish a TCP connection with a remote peer
0 = there should be no connection timeout

timeout, in milliseconds, for a specific query (any further results sent by the server won’t be processed for the query)
0 = there should be no timeout

maximum time, in seconds, that the server should spend processing a specific search query
0 = there should be no limit

how few TCP connections the resource adaptor will hold open in the connection pool (assuming the LDAP servers are reachable);
connections from this pool will be used for all query types except bind queries

how many TCP connections the resource adaptor will hold open in the connection pool

how few TCP connections the resource adaptor will hold open in the bind connection pool (assuming the LDAP servers are reachable);
connections from this pool will be used for bind queries exclusively
(for the LDAP bind queries feature)

how many TCP connections the resource adaptor will hold open in the bind connection pool
0 = no connections in the bind pool (the LDAP bind queries feature is disabled in the resource adaptor)

how long, in milliseconds, a connection to a backup server can exist in the bind connection pool before it is closed in order to try the primary server(s) again.
A value of 0 causes the connection to remain open indefinitely.
i.e. the primary server(s) will only be retried if the backup server fails.

how long, in milliseconds, a connection to a backup server can exist in the connection pool before it is closed in order to try the primary server(s) again.
A value of 0 causes the connection to remain open indefinitely.
i.e. the primary server(s) will only be retried if the backup server fails.

how many queued queries will wait for a thread pool thread before they execute
(active reconfiguration of MaxConnections and BindMaxConnections won’t affect value of MaxQueueSize if default was used until resource adaptor reactivation)

how long, in milliseconds, a query will wait in the queue before it executes

time, in milliseconds, between polls on a new connection in the connection pool to an LDAP server
(for the graceful connection establishment feature)

how many successful polls before sending regular queries to the LDAP server
(for the graceful connection establishment feature)

LDAP DN to use for poll queries
(for the graceful connection establishment feature)

the LDAP search filter to use for poll queries (see PollDN)

LDAP search scope; must be one of base, one, sub, or subordinate_subtree — for a base object, one-level, subtree, or any subordinate entries (excluding base DN) search

comma-separated list of result codes that should not be treated as poll failures
(for the graceful connection establishment feature)

how long, in milliseconds, to wait before closing idle connections in the connection pool
0 = do not close based on idle time

how many queries a specific TCP connection in the connection pool can have before it closes
0 = do not close based on number of queries

how long, in milliseconds, a specific TCP connection can stay open in the bind connection pool before it is automatically closed
(triggered by the periodic health checks, with frequency specified by BindHealthCheckInterval, or whenever connection is released to the bind pool, specified by BindCheckConnectionAgeOnRelease);
0 = do not close based on connection age

whether the resource adaptor should send an abandon request to any query for which no result is received in the query timeout period, specified by QueryTimeout (this does not affect the query timeout behaviour);
this is applicable to all query types except bind queries

maximum allowed message size, in bytes, for messages read from the server;
for example, 20971520 = 20MB
0 = no limit should be enforced

socket receive buffer size requested when establishing a connection to the server
0 = automatically determine by the JVM based on the underlying system settings

socket send buffer size requested when establishing a connection to the server
0 = automatically determine by the JVM based on the underlying system settings

whether connections should try to retrieve schema information from the server, which may be used to select the appropriate matching rules when comparing attribute values for the attributes included in a search result entry
(after reconfiguration will apply only to newly created connections)

whether to allow sending bind queries with a non-empty DN and empty password (that is, the unauthenticated authentication mechanism of the simple Bind method)

time, in milliseconds, between periodic health checks against the connections available in the bind pool (determine whether connections are valid and suitable for use)

whether to check the age of a connection against the configured maximum connection age, specified by BindMaxConnectionAge, whenever it is released to the bind pool

enable/disable secure transport connection

path to JKS key store file to load certificate key from

password for certificate key store

path to JKS key store for trust certificates

password for trust key store

comma-separated list of TLS cipher suites to be enabled for use when establishing TLS handshake

time, in seconds, after which TLS session should be invalidated and new session will be established (cipher keys change)
0 = sessions do not time out