Interface SearchResultAccessLogMessage
-
- All Superinterfaces:
AccessLogMessage
,LogMessage
,OperationForwardAccessLogMessage
,OperationRequestAccessLogMessage
,OperationResultAccessLogMessage
,SearchForwardAccessLogMessage
,SearchRequestAccessLogMessage
,java.io.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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getAlternateAuthorizationDN()
Retrieves the alternate authorization DN for the operation.java.lang.Long
getEntriesReturned()
Retrieves the number of entries returned to the client.java.util.Set<java.lang.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.java.util.Set<java.lang.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.java.lang.Boolean
getUnindexed()
Indicates whether the search was unindexed.-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.AccessLogMessage
getConnectionID, getInstanceName, getMessageType, getProductName, getStartupID, getThreadID
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.LogMessage
getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.OperationForwardAccessLogMessage
getTargetHost, getTargetPort, getTargetProtocol
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.OperationRequestAccessLogMessage
getAdministrativeOperationMessage, getMessageID, getOperationID, getOperationType, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.OperationResultAccessLogMessage
getAdditionalInformation, getDiagnosticMessage, getIntermediateResponsesReturned, getMatchedDN, getMissingPrivileges, getPreAuthorizationUsedPrivileges, getProcessingTimeMillis, getReferralURLs, getResponseControlOIDs, getResultCode, getServersAccessed, getUncachedDataAccessed, getUsedPrivileges, getWorkQueueWaitTimeMillis
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.SearchRequestAccessLogMessage
getBaseDN, getDereferencePolicy, getFilter, getRequestedAttributes, getScope, getSizeLimit, getTimeLimitSeconds, getTypesOnly
-
-
-
-
Method Detail
-
getEntriesReturned
@Nullable java.lang.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 java.lang.Boolean getUnindexed()
Indicates whether the search was unindexed.- Returns:
Boolean.TRUE
if the search was unindexed,Boolean.FALSE
if it was not, ornull
if it is not included in the log message.
-
getAlternateAuthorizationDN
@Nullable java.lang.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 java.util.Set<java.lang.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 java.util.Set<java.lang.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.
-
-