org.ldaptive.provider

Class RoundRobinConnectionStrategy

java.lang.Object

org.ldaptive.provider.RoundRobinConnectionStrategy

All Implemented Interfaces:

ConnectionStrategy

public class RoundRobinConnectionStrategy
extends java.lang.Object
implements ConnectionStrategy

Connection strategy that attempts each URL in the order they are configured. The next attempt uses the next URL in the list. The class orders the URLs by computing a modulus with the connection count. Since metadata is stored per connection, computing the URL based on connection count may not give the desired result when using a connection pool. Set useConnectionCount to false if using this strategy with a connection pool.

Field Summary

Fields

Modifier and Type	Field and Description
private int	invocationCount Internal method invocation counter.
private boolean	useConnectionCount Whether getLdapUrls(ConnectionFactoryMetadata) should use the connectionCount parameter or the invocationCount.

Fields inherited from interface org.ldaptive.provider.ConnectionStrategy

ACTIVE_PASSIVE, DEFAULT, RANDOM, ROUND_ROBIN

Constructor Summary

Constructors

Constructor and Description
RoundRobinConnectionStrategy() Creates a new round robin connection strategy.
RoundRobinConnectionStrategy(boolean b) Creates a new round robin connection strategy.

Method Summary

Modifier and Type	Method and Description
protected int	getCount(int connectionCount) Returns the supplied connection count if useConnectionCount is true.
java.lang.String[]	getLdapUrls(ConnectionFactoryMetadata metadata) Return a list of URLs that cycles the list order.
private int	returnAndIncrementInvocationCount() Increments the internal invocation count and returns the previous value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

invocationCount

private int invocationCount

Internal method invocation counter.

useConnectionCount

private final boolean useConnectionCount

Whether getLdapUrls(ConnectionFactoryMetadata) should use the connectionCount parameter or the invocationCount.

Constructor Detail

RoundRobinConnectionStrategy

public RoundRobinConnectionStrategy()

Creates a new round robin connection strategy.

RoundRobinConnectionStrategy

public RoundRobinConnectionStrategy(boolean b)

Creates a new round robin connection strategy.

Parameters:

b - whether getLdapUrls(ConnectionFactoryMetadata) should use the connectionCount parameter

Method Detail

getLdapUrls

public java.lang.String[] getLdapUrls(ConnectionFactoryMetadata metadata)

Return a list of URLs that cycles the list order. The first entry is moved to the end of the list for each invocation.

Specified by:

getLdapUrls in interface ConnectionStrategy

Parameters:

metadata - which can be used to produce the URL list

Returns:

list of URLs to attempt connections to

getCount

protected int getCount(int connectionCount)

Returns the supplied connection count if useConnectionCount is true. Otherwise returns invocationCount.

Parameters:

connectionCount - as reported by the connection

Returns:

count used to reorder the URL list

returnAndIncrementInvocationCount

private int returnAndIncrementInvocationCount()

Increments the internal invocation count and returns the previous value.

Returns:

previous invocation count