org.forgerock.opendj.ldap

Interface LoadBalancingAlgorithm

All Superinterfaces:

AutoCloseable, Closeable

public interface LoadBalancingAlgorithm
extends Closeable

A load balancing algorithm distributes connection requests across one or more underlying connection factories in an implementation defined manner.

See Also:

Connections.newLoadBalancer(LoadBalancingAlgorithm)

Field Summary

Fields

Modifier and Type	Field and Description
static org.forgerock.util.Option<LoadBalancerEventListener>	LOAD_BALANCER_EVENT_LISTENER Specifies the event listener which should be notified whenever a load-balanced connection factory changes state from online to offline or vice-versa.
static org.forgerock.util.Option<org.forgerock.util.time.Duration>	LOAD_BALANCER_MONITORING_INTERVAL Specifies the interval between successive attempts to reconnect to offline load-balanced connection factories.
static org.forgerock.util.Option<ScheduledExecutorService>	LOAD_BALANCER_SCHEDULER Specifies the scheduler which will be used for periodically reconnecting to offline connection factories.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Releases any resources associated with this algorithm, including any associated connection factories.
ConnectionFactory	getConnectionFactory() Returns a connection factory which should be used in order to satisfy the next connection request.

Field Detail

LOAD_BALANCER_MONITORING_INTERVAL

static final org.forgerock.util.Option<org.forgerock.util.time.Duration> LOAD_BALANCER_MONITORING_INTERVAL

Specifies the interval between successive attempts to reconnect to offline load-balanced connection factories. The default configuration is to attempt to reconnect every second.

LOAD_BALANCER_EVENT_LISTENER

static final org.forgerock.util.Option<LoadBalancerEventListener> LOAD_BALANCER_EVENT_LISTENER

Specifies the event listener which should be notified whenever a load-balanced connection factory changes state from online to offline or vice-versa. By default events will be logged to the LoadBalancingAlgorithm logger using the LoadBalancerEventListener.LOG_EVENTS listener.

LOAD_BALANCER_SCHEDULER

static final org.forgerock.util.Option<ScheduledExecutorService> LOAD_BALANCER_SCHEDULER

Specifies the scheduler which will be used for periodically reconnecting to offline connection factories. A system-wide scheduler will be used by default.

Method Detail

close

void close()

Releases any resources associated with this algorithm, including any associated connection factories.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

getConnectionFactory

ConnectionFactory getConnectionFactory()
                                       throws LdapException

Returns a connection factory which should be used in order to satisfy the next connection request.

Returns:

The connection factory.

Throws:

LdapException - If no connection factories are available for use.