DefaultConnectionFactory.DefaultConnection

java.lang.Object
- org.ldaptive.DefaultConnectionFactory.DefaultConnection

All Implemented Interfaces:

java.lang.AutoCloseable, Connection

Enclosing class:

DefaultConnectionFactory
```
protected static class DefaultConnectionFactory.DefaultConnection
extends java.lang.Object
implements Connection
```
Default implementation for managing a connection to an LDAP.

Field Summary

Fields
Modifier and Type	Field and Description
`private ConnectionConfig`	`config` Connection configuration.
`protected org.slf4j.Logger`	`logger` Logger for this class.
`private ProviderConnection`	`providerConnection` Provider connection.
`private ProviderConnectionFactory<?>`	`providerConnectionFactory` Connection factory.

Constructor Summary

Constructors
Constructor and Description

DefaultConnection(ConnectionConfig cc, ProviderConnectionFactory<?> cf)
Creates a new default connection.

Constructors
Constructor and Description
`DefaultConnection(ConnectionConfig cc, ProviderConnectionFactory<?> cf)` Creates a new default connection.

Method Summary

All Methods Instance Methods Concrete Methods
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.
`protected void`	`finalize()`
`ConnectionConfig`	`getConnectionConfig()` Returns the connection config for this connection.
`ProviderConnection`	`getProviderConnection()` Returns the provider specific connection.
`boolean`	`isOpen()` Returns whether the underlying provider connection is not null.
`Response<java.lang.Void>`	`open()` This will establish a connection if one does not already exist.
`Response<java.lang.Void>`	`open(BindRequest request)` This will establish a connection if one does not already exist and bind 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.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - logger
```
protected final org.slf4j.Logger logger
```
    Logger for this class.
  - config
```
private final ConnectionConfig config
```
    Connection configuration.
  - providerConnectionFactory
```
private final ProviderConnectionFactory<?> providerConnectionFactory
```
    Connection factory.
  - providerConnection
```
private ProviderConnection providerConnection
```
    Provider connection.
- Constructor Detail
  - DefaultConnection
```
public DefaultConnection(ConnectionConfig cc,
                         ProviderConnectionFactory<?> cf)
```
    Creates a new default connection.
    
    Parameters:
    
    cc - connection configuration
    
    cf - provider connection factory
- Method Detail
  - getConnectionConfig
```
public ConnectionConfig getConnectionConfig()
```
    Description copied from interface: Connection
    
    Returns the connection config for this connection. The config may be read-only.
    
    Specified by:
    
    getConnectionConfig in interface Connection
    
    Returns:
    
    connection config
  - getProviderConnection
```
public ProviderConnection getProviderConnection()
```
    Returns the provider specific connection. Must be called after a successful call to open().
    
    Specified by:
    
    getProviderConnection in interface Connection
    
    Returns:
    
    provider connection
    
    Throws:
    
    java.lang.IllegalStateException - if the connection is not open
  - open
```
public Response<java.lang.Void> open()
                              throws LdapException
```
    This will establish a connection if one does not already exist. This connection should be closed using close().
    
    Specified by:
    
    open in interface Connection
    
    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
```
public Response<java.lang.Void> open(BindRequest request)
                              throws LdapException
```
    This will establish a connection if one does not already exist and bind to the LDAP using the supplied bind request. This connection should be closed using close().
    
    Specified by:
    
    open in interface Connection
    
    Parameters:
    
    request - bind request
    
    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
```
public boolean isOpen()
```
    Returns whether the underlying provider connection is not null.
    
    Specified by:
    
    isOpen in interface Connection
    
    Returns:
    
    whether the provider connection has been initialized
  - close
```
public void close()
```
    Description copied from interface: Connection
    
    This will close the connection to the LDAP.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface Connection
  - close
```
public void close(RequestControl[] controls)
```
    Description copied from interface: Connection
    
    This will close the connection to the LDAP using the supplied controls.
    
    Specified by:
    
    close in interface Connection
    
    Parameters:
    
    controls - request controls
  - reopen
```
public Response<java.lang.Void> reopen()
                                throws LdapException
```
    Description copied from interface: Connection
    
    This will close an existing connection to the LDAP and establish a new connection to the LDAP.
    
    Specified by:
    
    reopen in interface Connection
    
    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
```
public Response<java.lang.Void> reopen(BindRequest request)
                                throws LdapException
```
    Description copied from interface: Connection
    
    This will close an existing connection to the LDAP and establish a new connection to the LDAP using the supplied bind request.
    
    Specified by:
    
    reopen in interface Connection
    
    Parameters:
    
    request - containing bind information
    
    Returns:
    
    response associated with the bind operation
    
    Throws:
    
    LdapException - if the LDAP cannot be reached
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable

Class DefaultConnectionFactory.DefaultConnection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

config

providerConnectionFactory

providerConnection

Constructor Detail

DefaultConnection

Method Detail

getConnectionConfig

getProviderConnection

open

open

isOpen

close

close

reopen

reopen

toString

finalize