Uses of Interface org.forgerock.opendj.ldap.LdapClient (OpenAM Server Only 7.2.2 Documentation)

Packages that use LdapClient
Package	Description
org.forgerock.openam.ldap	This package contains utility methods to ease/unify development when using the OpenDJ LDAP SDK.
org.forgerock.opendj.ldap	Classes and interfaces for core types including connections, entries, and attributes.

Uses of LdapClient in org.forgerock.openam.ldap

Classes in org.forgerock.openam.ldap that implement LdapClient
Modifier and Type Class Description

static class LDAPUtils.FailoverLdapClient
Simple failover Ldap Client.

Constructor parameters in org.forgerock.openam.ldap with type arguments of type LdapClient
Constructor Description

FailoverLdapClient(List<LdapClient> clients)
Constructor.

Uses of LdapClient in org.forgerock.opendj.ldap

Subinterfaces of LdapClient in org.forgerock.opendj.ldap
Modifier and Type	Interface	Description
`interface`	`ConnectionPool`	An LDAP client which maintains and re-uses a pool of connections.

Methods in org.forgerock.opendj.ldap that return LdapClient
Modifier and Type	Method	Description
`static LdapClient`	LdapClients.`newAffinityRequestLoadBalancer(Collection<? extends LdapClient> clients, Options options)`	Creates a new "affinity" load-balancer which will load-balance individual requests across the provided set of LDAP clients, each typically representing a single replica, using an algorithm that ensures that requests targeting a given DN will always be routed to the same replica.
`static LdapClient`	LdapClients.`newFailoverLoadBalancer(Collection<? extends LdapClient> clients, Options options)`	Creates a new "fail-over" load-balancer which will load-balance connections across the provided set of LDAP clients.
`static LdapClient`	LdapClients.`newFixedSizeDistributionLoadBalancer(Set<Dn> partitionBaseDns, ConsistentHashMap<? extends LdapClient> partitions, Options options)`	Creates a distribution load balancer which uses consistent hashing to distributes requests across a set of partitions based on a hash of each request's target DN.
`static LdapClient`	LdapClients.`newInternalLdapClient(io.reactivex.rxjava3.functions.BiFunction<Integer,Request,io.reactivex.rxjava3.core.Flowable<Response>> requestHandler)`	Creates a new `LdapClient` which will route requests to the provided `requestHandler`.
`static LdapClient`	LdapClients.`newLdapClient(String host, int port)`	Creates a new LDAP client which can be used to create LDAP connections to the Directory Server at the provided host and port number, and using default options.
`static LdapClient`	LdapClients.`newLdapClient(String host, int port, Options options)`	Creates a new LDAP client which can be used to create LDAP connections to the Directory Server at the provided host and port number and custom options.
`static LdapClient`	LdapClients.`newLdapService(Collection<String> bootstrapReplicationServerAdminHostPorts, Supplier<BindRequest> bindRequestSupplier, Options loadBalancingOptions, Options serviceDiscoveryOptions)`	Creates a new LDAP load-balancer able to discover all the replicas in a directory service, load balance across them all, and reconfigure itself according to changes affecting the availability of the replicas.
`static LdapClient`	LdapClients.`newLeastRequestsLoadBalancer(Collection<? extends LdapClient> clients, Options options)`	Creates a new "least requests" load-balancer which will load-balance individual requests across the provided set of LDAP clients, each typically representing a single replica, using an algorithm that ensures that requests are routed to the replica which has the minimum number of active requests.
`static LdapClient`	LdapClients.`newNamedLdapClient(LdapClient client, String name)`	Creates a new LDAP client which forwards connection requests to the provided client, but whose `toString` method will always return `name`.
`static LdapClient`	LdapClients.`newNullLdapClient()`	Returns an LDAP client which always throws `ResultCode.CLIENT_SIDE_CONNECT_ERROR`, without any error message.
`static LdapClient`	LdapClients.`newNullLdapClient(String name, LocalizableMessage connectErrorMessage)`	Returns an LDAP client which always throws `ResultCode.CLIENT_SIDE_CONNECT_ERROR` using the provided error message.
`static LdapClient`	LdapClients.`newProxyLdapService(Collection<String> bootstrapReplicationServerAdminHostPorts, Options loadBalancingOptions, Options serviceDiscoveryOptions)`	Creates a new LDAP load-balancer able to discover all the replicas in a directory service, load balance across them all, and reconfigure itself according to changes affecting the availability of the replicas.

Methods in org.forgerock.opendj.ldap with parameters of type LdapClient
Modifier and Type	Method	Description
`void`	LoadBalancerEventListener.`handleLdapClientOffline(LdapClient client, LdapException error)`	Invoked when the load-balancer is unable to obtain a connection from the specified LDAP client.
`void`	LoadBalancerEventListener.`handleLdapClientOnline(LdapClient client)`	Invoked when the load-balancer detects that a previously offline LDAP client is available for use again.
`static ConnectionPool`	LdapClients.`newCachedConnectionPool(LdapClient client)`	Creates a new connection pool which creates new connections as needed using the provided LDAP client, but will reuse previously allocated connections when they are available.
`static ConnectionPool`	LdapClients.`newCachedConnectionPool(LdapClient client, int corePoolSize, int maximumPoolSize, long idleTimeout, TimeUnit unit)`	Creates a new connection pool which creates new connections as needed using the provided LDAP client, but will reuse previously allocated connections when they are available.
`static ConnectionPool`	LdapClients.`newCachedConnectionPool(LdapClient client, int corePoolSize, int maximumPoolSize, long idleTimeout, TimeUnit unit, ScheduledExecutorService scheduler)`	Creates a new connection pool which creates new connections as needed using the provided LDAP client, but will reuse previously allocated connections when they are available.
`static ConnectionPool`	LdapClients.`newCachedConnectionPool(LdapClient client, Options options)`	Creates a new connection pool which creates new connections as needed using the provided LDAP client, but will reuse previously allocated connections when they are available.
`static ConnectionPool`	LdapClients.`newFixedConnectionPool(LdapClient client, int poolSize)`	Creates a new connection pool which will maintain `poolSize` connections created using the provided LDAP client.
`static LdapClient`	LdapClients.`newNamedLdapClient(LdapClient client, String name)`	Creates a new LDAP client which forwards connection requests to the provided client, but whose `toString` method will always return `name`.

Method parameters in org.forgerock.opendj.ldap with type arguments of type LdapClient
Modifier and Type	Method	Description
`static LdapClient`	LdapClients.`newAffinityRequestLoadBalancer(Collection<? extends LdapClient> clients, Options options)`	Creates a new "affinity" load-balancer which will load-balance individual requests across the provided set of LDAP clients, each typically representing a single replica, using an algorithm that ensures that requests targeting a given DN will always be routed to the same replica.
`static LdapClient`	LdapClients.`newFailoverLoadBalancer(Collection<? extends LdapClient> clients, Options options)`	Creates a new "fail-over" load-balancer which will load-balance connections across the provided set of LDAP clients.
`static LdapClient`	LdapClients.`newFixedSizeDistributionLoadBalancer(Set<Dn> partitionBaseDns, ConsistentHashMap<? extends LdapClient> partitions, Options options)`	Creates a distribution load balancer which uses consistent hashing to distributes requests across a set of partitions based on a hash of each request's target DN.
`static LdapClient`	LdapClients.`newLeastRequestsLoadBalancer(Collection<? extends LdapClient> clients, Options options)`	Creates a new "least requests" load-balancer which will load-balance individual requests across the provided set of LDAP clients, each typically representing a single replica, using an algorithm that ensures that requests are routed to the replica which has the minimum number of active requests.

Constructors in org.forgerock.opendj.ldap with parameters of type LdapClient
Constructor	Description
`LdapConnectionFactory(LdapClient ldapClient)`	Creates a new LDAP connection factory which can be used to create LDAP connections to the Directory Server at the provided host and port number.