org.ldaptive

Interface Connection

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

DefaultConnectionFactory.DefaultConnection

public interface Connection
extends java.lang.AutoCloseable

Interface for ldap connection implementations.

Method Summary

Modifier and Type	Method and Description
void	close() This will close the connection to the LDAP.
void	close(RequestControl[] controls) This will close the connection to the LDAP using the supplied controls.
ConnectionConfig	getConnectionConfig() Returns the connection config for this connection.
ProviderConnection	getProviderConnection() Returns the provider connection to invoke the provider specific implementation.
boolean	isOpen() Returns whether open(BindRequest) was successfully invoked on this connection and close() has not been invoked.
Response<java.lang.Void>	open() This will establish a connection to the LDAP.
Response<java.lang.Void>	open(BindRequest request) This will establish a connection to the LDAP using the supplied bind request.
Response<java.lang.Void>	reopen() This will close an existing connection to the LDAP and establish a new connection to the LDAP.
Response<java.lang.Void>	reopen(BindRequest request) This will close an existing connection to the LDAP and establish a new connection to the LDAP using the supplied bind request.

Method Detail

getConnectionConfig

ConnectionConfig getConnectionConfig()

Returns the connection config for this connection. The config may be read-only.

Returns:

connection config

open

Response<java.lang.Void> open()
                       throws LdapException

This will establish a connection to the LDAP. This connection should be closed using close().

Returns:

response associated with the ConnectionInitializer or an empty response if no connection initializer was configured

Throws:

java.lang.IllegalStateException - if the connection is already open

LdapException - if the LDAP cannot be reached

open

Response<java.lang.Void> open(BindRequest request)
                       throws LdapException

This will establish a connection to the LDAP using the supplied bind request. This connection should be closed using close().

Parameters:

request - containing bind information

Returns:

response associated with the bind operation

Throws:

java.lang.IllegalStateException - if the connection is already open

LdapException - if the LDAP cannot be reached

isOpen

boolean isOpen()

Returns whether open(BindRequest) was successfully invoked on this connection and close() has not been invoked. This method does not indicate the viability of this connection for use.

Returns:

whether this connection is open

getProviderConnection

ProviderConnection getProviderConnection()

Returns the provider connection to invoke the provider specific implementation. Must be called after a successful call to open().

Returns:

provider connection

close

void close()

This will close the connection to the LDAP.

Specified by:

close in interface java.lang.AutoCloseable

close

void close(RequestControl[] controls)

This will close the connection to the LDAP using the supplied controls.

Parameters:

controls - request controls

reopen

Response<java.lang.Void> reopen()
                         throws LdapException

This will close an existing connection to the LDAP and establish a new connection to the LDAP.

Returns:

response associated with the ConnectionInitializer or an empty response if no connection initializer was configured

Throws:

LdapException - if the LDAP cannot be reached

reopen

Response<java.lang.Void> reopen(BindRequest request)
                         throws LdapException

This will close an existing connection to the LDAP and establish a new connection to the LDAP using the supplied bind request.

Parameters:

request - containing bind information

Returns:

response associated with the bind operation

Throws:

LdapException - if the LDAP cannot be reached