Package com.unboundid.directory.sdk.proxy.types

Interface EntryBalancingRequestProcessor

    • Method Detail

      • getBalancingPointBaseDN

        DN getBalancingPointBaseDN()
        Retrieves the DN of the balancing point for the entry-balancing request processor.
        Returns:
        The DN of the balancing point for the entry-balancing request processor.

      • getBackendSets

        java.util.List<BackendSet> getBackendSets()
        Retrieves a list of the backend sets for this entry-balancing request processor.
        Returns:
        A list of the backend sets for this entry-balancing request processor.

      • getGlobalIndexHint

        BackendSet getGlobalIndexHint​(DN dn)
        Retrieves the backend set in which the entry-balancing global index believes the entry with the specified DN may exist.
        Parameters:
        dn - The DN of the entry for which to retrieve the global index hint.
        Returns:
        The backend set in which the entry-balancing global index believes the entry with the specified DN may exist, or 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.

      • getGlobalIndexHint

        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. The value is expected to be unique across the entire data set.
        Parameters:
        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.
        Returns:
        The backend set in which the entry-balancing global index believes the entry with the specified attribute value may exist, or null if the global index does not have any information that may help locate the target entry.

      • getGlobalIndexHint

        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. The value is expected to be unique across the entire data set.
        Parameters:
        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.
        Returns:
        The backend set in which the entry-balancing global index believes the entry with the specified attribute value may exist, or null if the global index does not have any information that may help locate the target entry.

      • getEntry

        ObjectPair<SearchResultEntry,​BackendSet> getEntry​(OperationContext op,
                                                        java.lang.String dn)
                                                 throws LDAPException
        Retrieves the specified entry from this entry-balancing request processor. If a broadcast is needed to find the entry, it will be done in parallel.
        Parameters:
        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.
        Returns:
        An object that pairs the requested entry with information about the backend set from which it was retrieved, or null if the specified entry was not found in any backend set.
        Throws:
        LDAPException - If a problem is encountered while making the determination.

      • search

        java.util.List<ObjectPair<SearchResultEntry,​BackendSet>> search​(ClientContext clientContext,
                                                                      java.lang.String baseDN,
                                                                      SearchScope scope,
                                                                      Filter filter,
                                                                      java.lang.String... attributes)
                                                               throws LDAPException
        Performs a search for all entries in this entry-balancing request processor that match the provided criteria. The search will not be allowed to return more than 100 entries.
        Parameters:
        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.
        Returns:
        A list containing each matching entry paired with the backend set from which it was retrieved.
        Throws:
        LDAPException - If a problem is encountered while performing the search.