Package com.unboundid.ldap.sdk.persist

Interface ObjectSearchListener<T>

Type Parameters:
T - The type of object handled by this class.
@Extensible @ThreadSafety(level=INTERFACE_NOT_THREADSAFE) public interface ObjectSearchListener<T>
This interface defines a set of methods that provide access to objects returned by the LDAPPersister class in the course of performing a search.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    objectReturned(T o)
    Indicates that the provided object was created from an entry retrieved from the directory server in the course of processing the search operation.
    void
    searchReferenceReturned(SearchResultReference searchReference)
    Indicates that the provided search result reference was retrieved from the directory server in the course of processing the search operation.
    void
    unparsableEntryReturned(SearchResultEntry entry, LDAPPersistException exception)
    Indicates that the provided entry was retrieved from the director server in the course of processing the search operation, but an error occurred while attempting to instantiate an object from it.

  • Method Details

    • objectReturned

      void objectReturned(@NotNull T o)
      Indicates that the provided object was created from an entry retrieved from the directory server in the course of processing the search operation.
      Parameters:
      o - The object that has been decoded from the entry that was returned. It will never be null.

    • unparsableEntryReturned

      void unparsableEntryReturned(@NotNull SearchResultEntry entry, @NotNull LDAPPersistException exception)
      Indicates that the provided entry was retrieved from the director server in the course of processing the search operation, but an error occurred while attempting to instantiate an object from it.
      Parameters:
      entry - The entry that was retrieved from the directory server but could not be decoded as an object.
      exception - The exception that was encountered while trying to create and initialize an object from the provided entry.

    • searchReferenceReturned

      void searchReferenceReturned(@NotNull SearchResultReference searchReference)
      Indicates that the provided search result reference was retrieved from the directory server in the course of processing the search operation.
      Parameters:
      searchReference - The search result reference that has been retrieved from the server.