org.forgerock.opendj.ldap.spi

Interface TransportProvider

All Superinterfaces:

Provider

public interface TransportProvider
extends Provider

Interface for transport providers, which provide implementation for LDAPConnectionFactory and LDAPListener classes, using a specific transport.

A transport provider must be declared in the provider-configuration file META-INF/services/org.forgerock.opendj.ldap.spi.TransportProvider in order to allow automatic loading of the implementation classes using the java.util.ServiceLoader facility.

Method Summary

Modifier and Type	Method and Description
LDAPConnectionFactoryImpl	getLDAPConnectionFactory(String host, int port, org.forgerock.util.Options options) Returns an implementation of LDAPConnectionFactory.
LDAPListenerImpl	getLDAPListener(Set<InetSocketAddress> addresses, org.forgerock.util.Function<LDAPClientContext,com.forgerock.reactive.ReactiveHandler<LDAPClientContext,LdapMessages.LdapRequestEnvelope,com.forgerock.reactive.Stream<Response>>,LdapException> factory, org.forgerock.util.Options options) Returns an implementation of LDAPListener.

Methods inherited from interface org.forgerock.opendj.ldap.spi.Provider

getName

Method Detail

getLDAPConnectionFactory

LDAPConnectionFactoryImpl getLDAPConnectionFactory(String host,
                                                   int port,
                                                   org.forgerock.util.Options options)

Returns an implementation of LDAPConnectionFactory. The address will be resolved each time a new connection is returned.

Parameters:

host - The hostname of the Directory Server to connect to.

port - The port number of the Directory Server to connect to.

options - The LDAP options to use when creating connections.

Returns:

an implementation of LDAPConnectionFactory

getLDAPListener

LDAPListenerImpl getLDAPListener(Set<InetSocketAddress> addresses,
                                 org.forgerock.util.Function<LDAPClientContext,com.forgerock.reactive.ReactiveHandler<LDAPClientContext,LdapMessages.LdapRequestEnvelope,com.forgerock.reactive.Stream<Response>>,LdapException> factory,
                                 org.forgerock.util.Options options)
                          throws IOException

Returns an implementation of LDAPListener.

Parameters:

addresses - The addresses to listen on.

factory - The handler factory which will be used to create handlers.

options - The LDAP listener options.

Returns:

an implementation of LDAPListener

Throws:

IOException - If an error occurred while trying to listen on the provided address.