Package com.unboundid.ldap.sdk.unboundidds.logs.v2

Interface SearchResultAccessLogMessage

All Superinterfaces:
AccessLogMessage, LogMessage, OperationForwardAccessLogMessage, OperationRequestAccessLogMessage, OperationResultAccessLogMessage, SearchForwardAccessLogMessage, SearchRequestAccessLogMessage, Serializable
All Known Implementing Classes:
JSONSearchResultAccessLogMessage, TextFormattedSearchResultAccessLogMessage
@NotExtensible @ThreadSafety(level=INTERFACE_THREADSAFE) public interface SearchResultAccessLogMessage extends OperationResultAccessLogMessage, SearchForwardAccessLogMessage
This class provides a data structure that holds information about a search operation result access log message.
NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

  • Method Details

    • getEntriesReturned

      @Nullable Long getEntriesReturned()
      Retrieves the number of entries returned to the client.
      Returns:
      The number of entries returned to the client, or null if it is not included in the log message.

    • getUnindexed

      @Nullable Boolean getUnindexed()
      Indicates whether the search was unindexed.
      Returns:
      Boolean.TRUE if the search was unindexed, Boolean.FALSE if it was not, or null if it is not included in the log message.

    • getAlternateAuthorizationDN

      @Nullable String getAlternateAuthorizationDN()
      Retrieves the alternate authorization DN for the operation.
      Returns:
      The alternate authorization DN for the operation, or null if it is not included in the log message.

    • getIndexesWithKeysAccessedNearEntryLimit

      @NotNull Set<String> getIndexesWithKeysAccessedNearEntryLimit()
      Retrieves the names of any indexes for which one or more keys near (typically, within 80% of) the index entry limit were accessed while processing the operation.
      Returns:
      The names of any indexes for which one or more keys near the index entry limit were accessed while processing the operation, or an empty list if no such index keys were accessed, or if this is not included in the log message.

    • getIndexesWithKeysAccessedExceedingEntryLimit

      @NotNull Set<String> getIndexesWithKeysAccessedExceedingEntryLimit()
      Retrieves the names of any indexes for which one or more keys over the index entry limit were accessed while processing the operation.
      Returns:
      The names of any indexes for which one or more keys over the index entry limit were accessed while processing the operation, or an empty list if no such index keys were accessed, or if this is not included in the log message.