com.unboundid.directory.sdk.proxy.types

Interface BackendSet

@NotExtensible
 @ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface BackendSet

This interface defines a set of methods that may be used to interact with a set of backend servers to be accessed through an entry-balancing request processor. All the servers in the set will have an identical set of data for the entry-balanced portion.

Method Summary

Modifier and Type	Method and Description
java.util.List<BackendServer>	getBackendServers() Retrieves the list of servers associated with this backend set.
java.lang.String	getBackendSetID() Retrieves a unique identifier for this backend set.
java.lang.String	getConfigEntryDN() Retrieves the DN of the configuration entry for the proxying request processor that defines this backend set.
LDAPConnection	getConnection(LDAPConnectionOptions options, OperationType... opTypes) Retrieves a newly-established connection to one of the servers in this backend set which is capable of processing all of the specified types of operations.

Method Detail

getBackendSetID

java.lang.String getBackendSetID()

Retrieves a unique identifier for this backend set.

Returns:

A unique identifier for this backend set.

getConfigEntryDN

java.lang.String getConfigEntryDN()

Retrieves the DN of the configuration entry for the proxying request processor that defines this backend set.

Returns:

The DN of the configuration entry for the proxying request processor that defines this backend set.

getBackendServers

java.util.List<BackendServer> getBackendServers()

Retrieves the list of servers associated with this backend set.

Returns:

The list of servers associated with this backend set.

getConnection

LDAPConnection getConnection(LDAPConnectionOptions options,
                             OperationType... opTypes)
                      throws LDAPException

Retrieves a newly-established connection to one of the servers in this backend set which is capable of processing all of the specified types of operations. The caller is responsible for closing the connection when it is no longer needed.

Parameters:

options - The set of connection options to use for the connection. It may be null if a default set of connection options should be used.

opTypes - The types of operations expected to be processed on the connection that is created. It must not be null or empty.

Returns:

The newly-created connection to one of the servers in this backend set.

Throws:

LDAPException - If a problem occurred while attempting to create the connection, or if none of the backend servers is available for the provided set of operation types.