Package org.opends.server.core

Class PersistentSearch

java.lang.Object
org.opends.server.core.PersistentSearch
public final class PersistentSearch extends Object
This class defines a data structure that will be used to hold the information necessary for processing a persistent search. Operations are responsible for managing the persistent searches that they are currently handling. Typically, a search operation will first decode the persistent search control and construct a new PersistentSearch.

  • Method Details

    • abort

      public void abort()
      Server side abort of this persistent search operation. Has the same behaviour as client cancel cancel(LocalizableMessage), (invalidate persistent search, associated searches cancelled) and it sends a result code to the client to warn of the server error.

    • getSearchOperation

      public SearchOperation getSearchOperation()
      Get the search operation associated with this persistent search.
      Returns:
      The search operation associated with this persistent search.

    • isChangesOnly

      public boolean isChangesOnly()
      Returns whether only entries updated after the beginning of this persistent search should be returned.
      Returns:
      true if only entries updated after the beginning of this search should be returned, false otherwise

    • toString

      public String toString()
      Retrieves a string representation of this persistent search.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this persistent search.