org.forgerock.opendj.ldap

Interface ConnectionPool

All Superinterfaces:

AutoCloseable, Closeable, LdapClient

public interface ConnectionPool
extends LdapClient

An LDAP client which maintains and re-uses a pool of connections. Connections obtained from a connection pool are returned to the connection pool when closed, although connection pool implementations may choose to physically close the connection if needed (e.g. in order to reduce the size of the pool).

When connection pools are no longer needed they must be explicitly closed in order to close any remaining pooled connections.

Since pooled connections are re-used, applications must use operations such as binds and StartTLS with extreme caution.

See Also:

LdapClients.newCachedConnectionPool(LdapClient), LdapClients.newFixedConnectionPool(LdapClient, int)

Method Summary

Modifier and Type	Method and Description
void	close() Releases any resources associated with this connection pool.

Methods inherited from interface org.forgerock.opendj.ldap.LdapClient

connect

Method Detail

close

void close()

Releases any resources associated with this connection pool. Pooled connections will be permanently closed and this connection pool will no longer be available for use.

Attempts to use this connection pool after it has been closed will result in an IllegalStateException.

Calling close on a connection pool which is already closed has no effect.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface LdapClient