|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@NotExtensible @ThreadSafety(level=INTERFACE_NOT_THREADSAFE) public interface EntryBalancingRequestProcessor
This interface defines a set of methods that may be used to obtain information about and interact with an entry-balancing request processor and its component backend sets and servers.
Method Summary | |
---|---|
java.util.List<BackendSet> |
getBackendSets()
Retrieves a list of the backend sets for this entry-balancing request processor. |
com.unboundid.ldap.sdk.DN |
getBalancingPointBaseDN()
Retrieves the DN of the balancing point for the entry-balancing request processor. |
com.unboundid.util.ObjectPair<com.unboundid.ldap.sdk.SearchResultEntry,BackendSet> |
getEntry(OperationContext op,
java.lang.String dn)
Retrieves the specified entry from this entry-balancing request processor. |
BackendSet |
getGlobalIndexHint(com.unboundid.ldap.sdk.DN dn)
Retrieves the backend set in which the entry-balancing global index believes the entry with the specified DN may exist. |
BackendSet |
getGlobalIndexHint(java.lang.String attributeType,
byte[] value)
Retrieves the backend set in which the entry-balancing global index believes the entry with the specified attribute value may exist. |
BackendSet |
getGlobalIndexHint(java.lang.String attributeType,
java.lang.String value)
Retrieves the backend set in which the entry-balancing global index believes the entry with the specified attribute value may exist. |
com.unboundid.ldap.sdk.DN |
getRequestProcessorBaseDN()
Retrieves the base DN for the entry-balancing request processor. |
java.util.List<com.unboundid.util.ObjectPair<com.unboundid.ldap.sdk.SearchResultEntry,BackendSet>> |
search(ClientContext clientContext,
java.lang.String baseDN,
com.unboundid.ldap.sdk.SearchScope scope,
com.unboundid.ldap.sdk.Filter filter,
java.lang.String... attributes)
Performs a search for all entries in this entry-balancing request processor that match the provided criteria. |
Method Detail |
---|
com.unboundid.ldap.sdk.DN getRequestProcessorBaseDN()
com.unboundid.ldap.sdk.DN getBalancingPointBaseDN()
java.util.List<BackendSet> getBackendSets()
BackendSet getGlobalIndexHint(com.unboundid.ldap.sdk.DN dn)
dn
- The DN of the entry for which to retrieve the global index
hint.
null
if the
global index does not have any information that may help locate
the target entry, or if the provided DN is not below the balancing
point.BackendSet getGlobalIndexHint(java.lang.String attributeType, java.lang.String value)
attributeType
- The name or OID of the attribute type of the
attribute for which to retrieve the global index
hint.value
- The attribute value for which to retrieve the global
index hint.
null
if the global index does not have any information
that may help locate the target entry.BackendSet getGlobalIndexHint(java.lang.String attributeType, byte[] value)
attributeType
- The name or OID of the attribute type of the
attribute for which to retrieve the global index
hint.value
- The attribute value for which to retrieve the global
index hint.
null
if the global index does not have any information
that may help locate the target entry.com.unboundid.util.ObjectPair<com.unboundid.ldap.sdk.SearchResultEntry,BackendSet> getEntry(OperationContext op, java.lang.String dn) throws com.unboundid.ldap.sdk.LDAPException
op
- Information about the operation currently being processed.
This must not be null
.dn
- The DN of the entry to retrieve. It must not be null
.
If it is at or above the balancing point base DN, then the
backend set from which the entry will be retrieved is
undefined.
null
if
the specified entry was not found in any backend set.
com.unboundid.ldap.sdk.LDAPException
- If a problem is encountered while making the
determination.java.util.List<com.unboundid.util.ObjectPair<com.unboundid.ldap.sdk.SearchResultEntry,BackendSet>> search(ClientContext clientContext, java.lang.String baseDN, com.unboundid.ldap.sdk.SearchScope scope, com.unboundid.ldap.sdk.Filter filter, java.lang.String... attributes) throws com.unboundid.ldap.sdk.LDAPException
clientContext
- The client context to use when performing the
search. If this is null
, then an internal
root user will be used to retrieve the entry. If it
is non-null
, then its authorization identity
will be used.baseDN
- The base DN to use for the search.scope
- The scope to use for the search.filter
- The filter to use for the search.attributes
- The set of attributes to request to be included in
the entries that are returned. If this is
null
or empty, then all user attributes will
be requested.
com.unboundid.ldap.sdk.LDAPException
- If a problem is encountered while performing the
search.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |