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

All Implemented Interfaces:

ConnectionFactory
```
public class SingleConnectionFactory
extends DefaultConnectionFactory
```
Creates a single connection which is proxied for LDAP operations.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`SingleConnectionFactory.Builder`
`protected static class`	`SingleConnectionFactory.ConnectionProxy`	Contains the connection used by this factory.
`class`	`SingleConnectionFactory.ReinitializeConnectionConsumer`	Invokes `destroyConnectionProxy()` followed by `initializeConnectionProxy()`.

Field Summary

Fields
Modifier and Type	Field	Description
`private ExecutorService`	`factoryExecutor`	Executor for scheduling factory tasks.
`private boolean`	`failFastInitialize`	Whether `initialize()` should throw if the connection cannot be opened.
`private boolean`	`initialized`	Whether `initialize()` has been successfully invoked.
`private boolean`	`nonBlockingInitialize`	Whether `initialize()` should occur on a separate thread.
`private Function<Connection,Boolean>`	`onClose`	To run when a connection is closed.
`private Function<Connection,Boolean>`	`onOpen`	To run when a connection is opened.
`private SingleConnectionFactory.ConnectionProxy`	`proxy`	The proxy used by this factory.
`private ConnectionValidator`	`validator`	For validating the connection.

Fields inherited from class org.ldaptive.DefaultConnectionFactory
logger

Constructor Summary

Constructors
Constructor	Description
`SingleConnectionFactory()`	Default constructor.
`SingleConnectionFactory(String ldapUrl)`	Creates a new single connection factory.
`SingleConnectionFactory(String ldapUrl, Transport t)`	Creates a new single connection factory.
`SingleConnectionFactory(ConnectionConfig cc)`	Creates a new single connection factory.
`SingleConnectionFactory(ConnectionConfig cc, Transport t)`	Creates a new single connection factory.
`SingleConnectionFactory(Transport t)`	Creates a new single connection factory.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SingleConnectionFactory.Builder`	`builder()`	Creates a builder for this class.
`static SingleConnectionFactory.Builder`	`builder(Transport t)`	Creates a builder for this class.
`void`	`close()`	Free any resources associated with this factory.
`private void`	`destroyConnectionProxy()`	Closes the connection and sets the proxy to null.
`Connection`	`getConnection()`	Creates a new connection.
`boolean`	`getFailFastInitialize()`	Returns whether `initialize()` should throw if the connection cannot be opened.
`boolean`	`getNonBlockingInitialize()`	Returns whether `initialize()` should execute on a separate thread.
`Function<Connection,Boolean>`	`getOnClose()`	Returns the function to run when the connection is closed.
`Function<Connection,Boolean>`	`getOnOpen()`	Returns the function to run when the connection is opened.
`ConnectionValidator`	`getValidator()`	Returns the connection validator for this factory.
`void`	`initialize()`	Prepares this factory for use.
`private void`	`initializeConnectionProxy()`	Opens the connection and creates the connection proxy.
`private void`	`initializeInternal()`	Attempts to open the connection and establish the proxy.
`boolean`	`isInitialized()`	Returns whether this factory has been initialized.
`void`	`setFailFastInitialize(boolean b)`	Sets whether `initialize()` should throw if the connection cannot be opened.
`void`	`setNonBlockingInitialize(boolean b)`	Sets whether `initialize()` should execute on a separate thread.
`void`	`setOnClose(Function<Connection,Boolean> function)`	Sets the function to run when the connection is closed.
`void`	`setOnOpen(Function<Connection,Boolean> function)`	Sets the function to run when the connection is opened.
`void`	`setValidator(ConnectionValidator cv)`	Sets the connection validator for this factory.
`String`	`toString()`

Methods inherited from class org.ldaptive.DefaultConnectionFactory
getConnectionConfig, getTransport, setConnectionConfig

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

- Field Detail
  - proxy
```
private SingleConnectionFactory.ConnectionProxy proxy
```
    The proxy used by this factory.
  - initialized
```
private boolean initialized
```
    Whether initialize() has been successfully invoked.
  - failFastInitialize
```
private boolean failFastInitialize
```
    Whether initialize() should throw if the connection cannot be opened.
  - nonBlockingInitialize
```
private boolean nonBlockingInitialize
```
    Whether initialize() should occur on a separate thread.
  - onOpen
```
private Function<Connection,Boolean> onOpen
```
    To run when a connection is opened.
  - onClose
```
private Function<Connection,Boolean> onClose
```
    To run when a connection is closed.
  - validator
```
private ConnectionValidator validator
```
    For validating the connection.
  - factoryExecutor
```
private ExecutorService factoryExecutor
```
    Executor for scheduling factory tasks.
- Constructor Detail
  - SingleConnectionFactory
```
public SingleConnectionFactory()
```
    Default constructor.
  - SingleConnectionFactory
```
public SingleConnectionFactory(Transport t)
```
    Creates a new single connection factory.
    
    Parameters:
    
    t - transport
  - SingleConnectionFactory
```
public SingleConnectionFactory(String ldapUrl)
```
    Creates a new single connection factory.
    
    Parameters:
    
    ldapUrl - to connect to
  - SingleConnectionFactory
```
public SingleConnectionFactory(String ldapUrl,
                               Transport t)
```
    Creates a new single connection factory.
    
    Parameters:
    
    ldapUrl - to connect to
    
    t - transport
  - SingleConnectionFactory
```
public SingleConnectionFactory(ConnectionConfig cc)
```
    Creates a new single connection factory.
    
    Parameters:
    
    cc - connection configuration
  - SingleConnectionFactory
```
public SingleConnectionFactory(ConnectionConfig cc,
                               Transport t)
```
    Creates a new single connection factory.
    
    Parameters:
    
    cc - connection configuration
    
    t - transport
- Method Detail
  - getFailFastInitialize
```
public boolean getFailFastInitialize()
```
    Returns whether initialize() should throw if the connection cannot be opened.
    
    Returns:
    
    whether initialize() should throw
  - setFailFastInitialize
```
public void setFailFastInitialize(boolean b)
```
    Sets whether initialize() should throw if the connection cannot be opened.
    
    Parameters:
    
    b - whether initialize() should throw
  - getNonBlockingInitialize
```
public boolean getNonBlockingInitialize()
```
    Returns whether initialize() should execute on a separate thread.
    
    Returns:
    
    whether initialize() should block
  - setNonBlockingInitialize
```
public void setNonBlockingInitialize(boolean b)
```
    Sets whether initialize() should execute on a separate thread.
    
    Parameters:
    
    b - whether initialize() should block
  - getOnOpen
```
public Function<Connection,Boolean> getOnOpen()
```
    Returns the function to run when the connection is opened.
    
    Returns:
    
    on open function
  - setOnOpen
```
public void setOnOpen(Function<Connection,Boolean> function)
```
    Sets the function to run when the connection is opened.
    
    Parameters:
    
    function - to run on connection open
  - getOnClose
```
public Function<Connection,Boolean> getOnClose()
```
    Returns the function to run when the connection is closed.
    
    Returns:
    
    on close function
  - setOnClose
```
public void setOnClose(Function<Connection,Boolean> function)
```
    Sets the function to run when the connection is closed.
    
    Parameters:
    
    function - to run on connection close
  - getValidator
```
public ConnectionValidator getValidator()
```
    Returns the connection validator for this factory.
    
    Returns:
    
    connection validator
  - setValidator
```
public void setValidator(ConnectionValidator cv)
```
    Sets the connection validator for this factory.
    
    Parameters:
    
    cv - connection validator
  - isInitialized
```
public boolean isInitialized()
```
    Returns whether this factory has been initialized.
    
    Returns:
    
    whether this factory has been initialized
  - initialize
```
public void initialize()
                throws LdapException
```
    Prepares this factory for use.
    
    Throws:
    
    LdapException - if the connection cannot be opened
  - initializeInternal
```
private void initializeInternal()
                         throws LdapException
```
    Attempts to open the connection and establish the proxy.
    
    Throws:
    
    LdapException - if Connection.open() fails and failFastInitialize is true
  - initializeConnectionProxy
```
private void initializeConnectionProxy()
                                throws LdapException
```
    Opens the connection and creates the connection proxy. Invokes onOpen and will tear down the connection if that function returns false.
    
    Throws:
    
    LdapException - if connection open fails
  - destroyConnectionProxy
```
private void destroyConnectionProxy()
```
    Closes the connection and sets the proxy to null. Invokes onClose prior to closing the connection.
  - getConnection
```
public Connection getConnection()
```
    Description copied from class: DefaultConnectionFactory
    
    Creates a new connection. Connections returned from this method must be opened before they can perform ldap operations.
    
    Specified by:
    
    getConnection in interface ConnectionFactory
    
    Overrides:
    
    getConnection in class DefaultConnectionFactory
    
    Returns:
    
    connection
  - close
```
public void close()
```
    Description copied from interface: ConnectionFactory
    
    Free any resources associated with this factory.
    
    Specified by:
    
    close in interface ConnectionFactory
    
    Overrides:
    
    close in class DefaultConnectionFactory
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class DefaultConnectionFactory
  - builder
```
public static SingleConnectionFactory.Builder builder()
```
    Creates a builder for this class.
    
    Returns:
    
    new builder
  - builder
```
public static SingleConnectionFactory.Builder builder(Transport t)
```
    Creates a builder for this class.
    
    Parameters:
    
    t - transport
    
    Returns:
    
    new builder

Class SingleConnectionFactory

Nested Class Summary

Field Summary

Fields inherited from class org.ldaptive.DefaultConnectionFactory

Constructor Summary

Method Summary

Methods inherited from class org.ldaptive.DefaultConnectionFactory

Methods inherited from class java.lang.Object

Field Detail

proxy

initialized

failFastInitialize

nonBlockingInitialize

onOpen

onClose

validator

factoryExecutor

Constructor Detail

SingleConnectionFactory

SingleConnectionFactory

SingleConnectionFactory

SingleConnectionFactory

SingleConnectionFactory

SingleConnectionFactory

Method Detail

getFailFastInitialize

setFailFastInitialize

getNonBlockingInitialize

setNonBlockingInitialize

getOnOpen

setOnOpen

getOnClose

setOnClose

getValidator

setValidator

isInitialized

initialize

initializeInternal

initializeConnectionProxy

destroyConnectionProxy

getConnection

close

toString

builder

builder