Uses of Interface
org.forgerock.opendj.ldap.LdapClient

Packages that use LdapClient

Package	Description
org.forgerock.opendj.ldap	Classes and interfaces for core types including connections, entries, and attributes.
org.forgerock.opendj.rest2ldap	APIs for implementing REST to LDAP gateways.
org.forgerock.opendj.rest2ldap.authz	This package contains Filter to authenticate and authorize LDAP connections.

Uses of LdapClient in org.forgerock.opendj.ldap

Classes in org.forgerock.opendj.ldap that implement LdapClient

Modifier and Type	Class	Description
final class	ConnectionPool	A connection pool which maintains a cache of client sockets with a configurable core pool size, maximum size, and expiration policy.

Methods in org.forgerock.opendj.ldap that return LdapClient

Modifier and Type	Method	Description
static LdapClient	LdapClients.newAffinityRequestLoadBalancer(Map<com.forgerock.opendj.util.HostPort,? 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(BiFunction<Integer,Request,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> bootstrapReplicationServerAdminEndpoints, 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(Map<com.forgerock.opendj.util.HostPort,? 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

Modifier	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.

Uses of LdapClient in org.forgerock.opendj.rest2ldap

Methods in org.forgerock.opendj.rest2ldap that return LdapClient

Modifier and Type	Method	Description
static LdapClient	Rest2LdapJsonConfigurator.configureLdapClient(JsonValue configuration, String name, TrustManager trustManager, X509KeyManager keyManager)	Creates a new LDAP client using the named configuration in the provided JSON list of client configurations.
protected LdapClient	Rest2LdapHttpApplication.getLdapClient(String name)	Gets a LdapClient from its name.

Methods in org.forgerock.opendj.rest2ldap with parameters of type LdapClient

Modifier and Type	Method	Description
protected ConditionalFilters.ConditionalFilter	Rest2LdapHttpApplication.newAnonymousFilter(LdapClient ldapClient)	Creates a new Filter in charge of injecting LdapClientContext directly from a LdapClient.
protected org.forgerock.http.Filter	Rest2LdapHttpApplication.newProxyAuthzFilter(LdapClient ldapClient)	Creates a new Filter in charge of injecting LdapClientContext.

Constructors in org.forgerock.opendj.rest2ldap with parameters of type LdapClient

Modifier	Constructor	Description
	LdapClientContext(org.forgerock.services.context.Context parent, LdapClient ldapClientForReadingSchema, LdapClientSocket ldapClientSocketForUserRequests)	Creates a new LDAP client context having the provided parent and an ID automatically generated using UUID.randomUUID().
	LdapClientContext(org.forgerock.services.context.Context parent, LdapClient ldapClientForReadingSchema, LdapClientSocket ldapClientSocketForUserRequests, Control proxiedAuthControl)	Creates a new LDAP client context having the provided parent and an ID automatically generated using UUID.randomUUID().

Uses of LdapClient in org.forgerock.opendj.rest2ldap.authz

Methods in org.forgerock.opendj.rest2ldap.authz with parameters of type LdapClient

Modifier and Type	Method	Description
static ConditionalFilters.ConditionalFilter	Authorization.newConditionalDirectConnectionFilter(LdapClient ldapClient)	Creates a ConditionalFilters.ConditionalFilter injecting an LdapClientContext with a connection issued from the given connectionFactory.
static org.forgerock.http.oauth2.AccessTokenResolver	Authorization.newCtsAccessTokenResolver(LdapClient ldapClient, String ctsBaseDNTemplate)	Creates a new CTS access token resolver.
static org.forgerock.http.Filter	Authorization.newProxyAuthorizationFilter(LdapClient ldapClient)	Creates a filter injecting an LdapClientContext given the information provided in the SecurityContext.
static AuthenticationStrategy	AuthenticationStrategies.newSaslPlainStrategy(LdapClient ldapClient, Schema schema, String authcIdTemplate)	Creates an AuthenticationStrategy performing authentication against an LDAP server using a plain SASL bind request.
static AuthenticationStrategy	AuthenticationStrategies.newSaslScramStrategy(LdapClient ldapClient, ScramMechanism scramMechanism, Schema schema, String authcIdTemplate)	Creates an AuthenticationStrategy performing authentication against an LDAP server using a SCRAM SASL bind request.
static AuthenticationStrategy	AuthenticationStrategies.newSearchThenBindStrategy(LdapClient searchLdapClient, LdapClient bindLdapClient, Dn baseDN, SearchScope searchScope, String filterTemplate)	Creates an AuthenticationStrategy performing authentication against an LDAP server by first performing a lookup of the entry to bind with.
static AuthenticationStrategy	AuthenticationStrategies.newSimpleBindStrategy(LdapClient ldapClient, String bindDNTemplate, Schema schema)	Creates an AuthenticationStrategy performing simple BIND authentication against an LDAP server.
static AuthenticationStrategy	AuthenticationStrategies.newSimpleBindStrategy(LdapClient ldapClient, Function<String,Dn> dnMapper)	Creates an AuthenticationStrategy performing simple BIND authentication against an LDAP server.