|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.ServerSet
com.unboundid.ldap.sdk.RoundRobinServerSet
public final class RoundRobinServerSet
This class provides a server set implementation that will use a round-robin
algorithm to select the server to which the connection should be established.
Any number of servers may be included in this server set, and each request
will attempt to retrieve a connection to the next server in the list,
circling back to the beginning of the list as necessary. If a server is
unavailable when an attempt is made to establish a connection to it, then
the connection will be established to the next available server in the set.
// Create arrays with the addresses and ports of the directory server // instances. String[] addresses = { server1Address, server2Address }; int[] ports = { server1Port, server2Port }; // Create the server set using the address and port arrays. RoundRobinServerSet roundRobinSet = new RoundRobinServerSet(addresses, ports); // Verify that we can establish a single connection using the server set. LDAPConnection connection = roundRobinSet.getConnection(); RootDSE rootDSEFromConnection = connection.getRootDSE(); connection.close(); // Verify that we can establish a connection pool using the server set. SimpleBindRequest bindRequest = new SimpleBindRequest("uid=pool.user,dc=example,dc=com", "password"); LDAPConnectionPool pool = new LDAPConnectionPool(roundRobinSet, bindRequest, 10); RootDSE rootDSEFromPool = pool.getRootDSE(); pool.close();
Constructor Summary | |
---|---|
RoundRobinServerSet(java.lang.String[] addresses,
int[] ports)
Creates a new round robin server set with the specified set of directory server addresses and port numbers. |
|
RoundRobinServerSet(java.lang.String[] addresses,
int[] ports,
LDAPConnectionOptions connectionOptions)
Creates a new round robin server set with the specified set of directory server addresses and port numbers. |
|
RoundRobinServerSet(java.lang.String[] addresses,
int[] ports,
javax.net.SocketFactory socketFactory)
Creates a new round robin server set with the specified set of directory server addresses and port numbers. |
|
RoundRobinServerSet(java.lang.String[] addresses,
int[] ports,
javax.net.SocketFactory socketFactory,
LDAPConnectionOptions connectionOptions)
Creates a new round robin server set with the specified set of directory server addresses and port numbers. |
Method Summary | |
---|---|
java.lang.String[] |
getAddresses()
Retrieves the addresses of the directory servers to which the connections should be established. |
LDAPConnection |
getConnection()
Attempts to establish a connection to one of the directory servers in this server set. |
LDAPConnection |
getConnection(LDAPConnectionPoolHealthCheck healthCheck)
Attempts to establish a connection to one of the directory servers in this server set, using the provided health check to further validate the connection. |
LDAPConnectionOptions |
getConnectionOptions()
Retrieves the set of connection options that will be used for underlying connections. |
int[] |
getPorts()
Retrieves the ports of the directory servers to which the connections should be established. |
javax.net.SocketFactory |
getSocketFactory()
Retrieves the socket factory that will be used to establish connections. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this server set to the provided buffer. |
Methods inherited from class com.unboundid.ldap.sdk.ServerSet |
---|
toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public RoundRobinServerSet(java.lang.String[] addresses, int[] ports)
addresses
- The addresses of the directory servers to which the
connections should be established. It must not be
null
or empty.ports
- The ports of the directory servers to which the
connections should be established. It must not be
null
, and it must have the same number of
elements as the addresses
array. The order of
elements in the addresses
array must correspond
to the order of elements in the ports
array.public RoundRobinServerSet(java.lang.String[] addresses, int[] ports, LDAPConnectionOptions connectionOptions)
addresses
- The addresses of the directory servers to which
the connections should be established. It must
not be null
or empty.ports
- The ports of the directory servers to which the
connections should be established. It must not
be null
, and it must have the same
number of elements as the addresses
array. The order of elements in the
addresses
array must correspond to the
order of elements in the ports
array.connectionOptions
- The set of connection options to use for the
underlying connections.public RoundRobinServerSet(java.lang.String[] addresses, int[] ports, javax.net.SocketFactory socketFactory)
addresses
- The addresses of the directory servers to which the
connections should be established. It must not be
null
or empty.ports
- The ports of the directory servers to which the
connections should be established. It must not be
null
, and it must have the same number of
elements as the addresses
array. The order
of elements in the addresses
array must
correspond to the order of elements in the
ports
array.socketFactory
- The socket factory to use to create the underlying
connections.public RoundRobinServerSet(java.lang.String[] addresses, int[] ports, javax.net.SocketFactory socketFactory, LDAPConnectionOptions connectionOptions)
addresses
- The addresses of the directory servers to which
the connections should be established. It must
not be null
or empty.ports
- The ports of the directory servers to which the
connections should be established. It must not
be null
, and it must have the same
number of elements as the addresses
array. The order of elements in the
addresses
array must correspond to the
order of elements in the ports
array.socketFactory
- The socket factory to use to create the
underlying connections.connectionOptions
- The set of connection options to use for the
underlying connections.Method Detail |
---|
public java.lang.String[] getAddresses()
public int[] getPorts()
public javax.net.SocketFactory getSocketFactory()
public LDAPConnectionOptions getConnectionOptions()
public LDAPConnection getConnection() throws LDAPException
LDAPConnection#getConnectedAddress
and
LDAPConnection#getConnectedPort
methods.
getConnection
in class ServerSet
LDAPConnection
object that is established to one of the
servers in this server set.
LDAPException
- If it is not possible to establish a connection to
any of the servers in this server set.public LDAPConnection getConnection(LDAPConnectionPoolHealthCheck healthCheck) throws LDAPException
LDAPConnection#getConnectedAddress
and
LDAPConnection#getConnectedPort
methods.
getConnection
in class ServerSet
healthCheck
- The health check to use to make the determination, or
null
if no additional health check should be
performed.
LDAPConnection
object that is established to one of the
servers in this server set.
LDAPException
- If it is not possible to establish a connection to
any of the servers in this server set.public void toString(java.lang.StringBuilder buffer)
toString
in class ServerSet
buffer
- The buffer to which the string representation should be
appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |