org.forgerock.opendj.ldap.spi

Interface LDAPConnectionFactoryImpl

All Superinterfaces:

AutoCloseable, Closeable

public interface LDAPConnectionFactoryImpl
extends Closeable

Interface for all classes that implement LDAPConnectionFactory.

An implementation class is provided by a TransportProvider.

The implementation can be automatically loaded using the java.util.ServiceLoader facility if its provider extending TransportProvider is declared in the provider-configuration file META-INF/services/org.forgerock.opendj.ldap.spi.TransportProvider.

Method Summary

Modifier and Type	Method and Description
void	close() Releases any resources associated with this connection factory implementation.
org.forgerock.util.promise.Promise<LDAPConnectionImpl,LdapException>	getConnectionAsync() Asynchronously obtains a connection to the Directory Server associated with this connection factory.
String	getHostName() Returns the hostname used by the connections created by this factory.
int	getPort() Returns the remote port number used by the connections created by this factory.
InetSocketAddress	getSocketAddress() Returns the address used by the connections created by this factory.

Method Detail

getSocketAddress

InetSocketAddress getSocketAddress()

Returns the address used by the connections created by this factory.

Returns:

The address used by the connections.

getHostName

String getHostName()

Returns the hostname used by the connections created by this factory.

Returns:

The hostname used by the connections.

getPort

int getPort()

Returns the remote port number used by the connections created by this factory.

Returns:

The remote port number used by the connections.

close

void close()

Releases any resources associated with this connection factory implementation.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

getConnectionAsync

org.forgerock.util.promise.Promise<LDAPConnectionImpl,LdapException> getConnectionAsync()

Asynchronously obtains a connection to the Directory Server associated with this connection factory. The returned Promise can be used to retrieve the completed connection.

Returns:

A promise which can be used to retrieve the connection.