Interface PreOperationSearchOperation

    • Method Detail

      • getBaseDN

        Dn getBaseDN()
        Retrieves the base DN for this search operation.
        Returns:
        The base DN for this search operation.
      • getScope

        SearchScope getScope()
        Retrieves the scope for this search operation.
        Returns:
        The scope for this search operation.
      • getDerefPolicy

        DereferenceAliasesPolicy getDerefPolicy()
        Retrieves the alias dereferencing policy for this search operation.
        Returns:
        The alias dereferencing policy for this search operation.
      • getSizeLimit

        int getSizeLimit()
        Retrieves the size limit for this search operation.
        Returns:
        The size limit for this search operation.
      • getTimeLimit

        int getTimeLimit()
        Retrieves the time limit for this search operation.
        Returns:
        The time limit for this search operation.
      • getTypesOnly

        boolean getTypesOnly()
        Retrieves the typesOnly flag for this search operation.
        Returns:
        The typesOnly flag for this search operation.
      • getFilter

        Filter getFilter()
        Retrieves the filter for this search operation.
        Returns:
        The filter for this search operation.
      • getAttributes

        Set<String> getAttributes()
        Retrieves the set of requested attributes for this search operation. Its contents should not be altered.
        Returns:
        The set of requested attributes for this search operation.
      • returnEntry

        boolean returnEntry​(Entry entry,
                            List<Control> controls)
        Returns the provided entry to the client.
        Parameters:
        entry - The entry that should be returned.
        controls - The set of controls to include with the entry (may be null if no controls should be included with the entry).
        Returns:
        true if the caller should continue processing the search request and sending additional entries and references, or false if not for some reason (e.g., the size limit has been reached or the search has been abandoned).
      • returnReference

        boolean returnReference​(Dn dn,
                                SearchResultReference reference)
        Returns the provided search result reference to the client.
        Parameters:
        dn - A DN related to the specified search reference.
        reference - The search reference that should be returned.
        Returns:
        true if the caller should continue processing the search request and sending additional entries and references, or false if not for some reason (e.g., the size limit has been reached or the search has been abandoned).