java.lang.Object
- com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONLogMessage
- - com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONAccessLogMessage
  - - com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONRequestAccessLogMessage
    - - com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONSearchRequestAccessLogMessage
      - com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONSearchResultAccessLogMessage

All Implemented Interfaces:

AccessLogMessage, LogMessage, OperationForwardAccessLogMessage, OperationRequestAccessLogMessage, OperationResultAccessLogMessage, SearchForwardAccessLogMessage, SearchRequestAccessLogMessage, SearchResultAccessLogMessage, java.io.Serializable
```
@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class JSONSearchResultAccessLogMessage
extends JSONSearchRequestAccessLogMessage
implements SearchResultAccessLogMessage
```
This class provides a data structure that holds information about a JSON-formatted search 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.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

JSONSearchResultAccessLogMessage(JSONObject jsonObject)
Creates a new JSON search result access log message from the provided JSON object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getAdditionalInformation()`	Retrieves a message with additional information about the result of the operation.
`java.lang.String`	`getAlternateAuthorizationDN()`	Retrieves the alternate authorization DN for the operation.
`java.lang.String`	`getDiagnosticMessage()`	Retrieves the diagnostic message 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.
`JSONIntermediateClientResponseControl`	`getIntermediateClientResponseControl()`	Retrieves information about an intermediate client response control included in the log message.
`java.lang.Long`	`getIntermediateResponsesReturned()`	Retrieves the number of intermediate response messages returned in the course of processing the operation.
`java.lang.String`	`getMatchedDN()`	Retrieves the matched DN for the operation.
`AccessLogMessageType`	`getMessageType()`	Retrieves the message type for this access log message.
`java.util.Set<java.lang.String>`	`getMissingPrivileges()`	Retrieves the names of any privileges that would have been required for processing the operation but that the requester did not have.
`java.util.Set<java.lang.String>`	`getPreAuthorizationUsedPrivileges()`	Retrieves the names of any privileges used during the course of processing the operation before an alternate authorization identity was assigned.
`java.lang.Double`	`getProcessingTimeMillis()`	Retrieves the length of time in milliseconds required to process the operation.
`java.util.List<java.lang.String>`	`getReferralURLs()`	Retrieves the list of referral URLs for the operation.
`java.util.Set<java.lang.String>`	`getResponseControlOIDs()`	Retrieves the OIDs of any response controls contained in the log message.
`ResultCode`	`getResultCode()`	Retrieves the result code for the operation.
`java.util.List<java.lang.String>`	`getServersAccessed()`	Retrieves a list of the additional servers that were accessed in the course of processing the operation.
`java.lang.String`	`getTargetHost()`	Retrieves the address of the backend server to which the request has been forwarded.
`java.lang.Integer`	`getTargetPort()`	Retrieves the port of the backend server to which the request has been forwarded.
`java.lang.String`	`getTargetProtocol()`	Retrieves the protocol used to forward the request to the backend server.
`java.lang.Boolean`	`getUncachedDataAccessed()`	Indicates whether the server accessed any uncached data in the course of processing the operation.
`java.lang.Boolean`	`getUnindexed()`	Indicates whether the search was unindexed.
`java.util.Set<java.lang.String>`	`getUsedPrivileges()`	Retrieves the names of any privileges used during the course of processing the operation.
`java.lang.Double`	`getWorkQueueWaitTimeMillis()`	Retrieves the length of time in milliseconds the operation was required to wait on the work queue.

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONSearchRequestAccessLogMessage
getBaseDN, getDereferencePolicy, getFilter, getOperationType, getRequestedAttributes, getScope, getSizeLimit, getTimeLimitSeconds, getTypesOnly

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONRequestAccessLogMessage
getAdministrativeOperationMessage, getIntermediateClientRequestControl, getMessageID, getOperationID, getOperationPurposeRequestControl, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONAccessLogMessage
getConnectionID, getInstanceName, getProductName, getStartupID, getThreadID

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONLogMessage
getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getJSONObject, getLogType, getLong, getRFC3339Timestamp, getString, getTimestamp, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.AccessLogMessage
getConnectionID, getInstanceName, 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.OperationRequestAccessLogMessage
getAdministrativeOperationMessage, getMessageID, getOperationID, getOperationType, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.SearchRequestAccessLogMessage
getBaseDN, getDereferencePolicy, getFilter, getRequestedAttributes, getScope, getSizeLimit, getTimeLimitSeconds, getTypesOnly

- Constructor Detail
  - JSONSearchResultAccessLogMessage
```
public JSONSearchResultAccessLogMessage(@NotNull
                                        JSONObject jsonObject)
                                 throws LogException
```
    Creates a new JSON search result access log message from the provided JSON object.
    
    Parameters:
    
    jsonObject - The JSON object that contains an encoded representation of this log message. It must not be null.
    
    Throws:
    
    LogException - If the provided JSON object cannot be parsed as a valid log message.
- Method Detail
  - getMessageType
```
@NotNull
public AccessLogMessageType getMessageType()
```
    Retrieves the message type for this access log message.
    
    Specified by:
    
    getMessageType in interface AccessLogMessage
    
    Overrides:
    
    getMessageType in class JSONRequestAccessLogMessage
    
    Returns:
    
    The message type for this access log message.
  - getResultCode
```
@Nullable
public ResultCode getResultCode()
```
    Retrieves the result code for the operation.
    
    Specified by:
    
    getResultCode in interface OperationResultAccessLogMessage
    
    Returns:
    
    The result code for the operation, or null if it is not included in the log message.
  - getDiagnosticMessage
```
@Nullable
public java.lang.String getDiagnosticMessage()
```
    Retrieves the diagnostic message for the operation.
    
    Specified by:
    
    getDiagnosticMessage in interface OperationResultAccessLogMessage
    
    Returns:
    
    The diagnostic message for the operation, or null if it is not included in the log message.
  - getAdditionalInformation
```
@Nullable
public java.lang.String getAdditionalInformation()
```
    Retrieves a message with additional information about the result of the operation.
    
    Specified by:
    
    getAdditionalInformation in interface OperationResultAccessLogMessage
    
    Returns:
    
    A message with additional information about the result of the operation, or null if it is not included in the log message.
  - getMatchedDN
```
@Nullable
public java.lang.String getMatchedDN()
```
    Retrieves the matched DN for the operation.
    
    Specified by:
    
    getMatchedDN in interface OperationResultAccessLogMessage
    
    Returns:
    
    The matched DN for the operation, or null if it is not included in the log message.
  - getReferralURLs
```
@NotNull
public java.util.List<java.lang.String> getReferralURLs()
```
    Retrieves the list of referral URLs for the operation.
    
    Specified by:
    
    getReferralURLs in interface OperationResultAccessLogMessage
    
    Returns:
    
    The list of referral URLs for the operation, or an empty list if it is not included in the log message.
  - getProcessingTimeMillis
```
@Nullable
public java.lang.Double getProcessingTimeMillis()
```
    Retrieves the length of time in milliseconds required to process the operation.
    
    Specified by:
    
    getProcessingTimeMillis in interface OperationResultAccessLogMessage
    
    Returns:
    
    The length of time in milliseconds required to process the operation, or null if it is not included in the log message.
  - getWorkQueueWaitTimeMillis
```
@Nullable
public java.lang.Double getWorkQueueWaitTimeMillis()
```
    Retrieves the length of time in milliseconds the operation was required to wait on the work queue.
    
    Specified by:
    
    getWorkQueueWaitTimeMillis in interface OperationResultAccessLogMessage
    
    Returns:
    
    The length of time in milliseconds the operation was required to wait on the work queue, or null if it is not included in the log message.
  - getResponseControlOIDs
```
@NotNull
public java.util.Set<java.lang.String> getResponseControlOIDs()
```
    Retrieves the OIDs of any response controls contained in the log message.
    
    Specified by:
    
    getResponseControlOIDs in interface OperationResultAccessLogMessage
    
    Returns:
    
    The OIDs of any response controls contained in the log message, or an empty list if it is not included in the log message.
  - getIntermediateResponsesReturned
```
@Nullable
public java.lang.Long getIntermediateResponsesReturned()
```
    Retrieves the number of intermediate response messages returned in the course of processing the operation.
    
    Specified by:
    
    getIntermediateResponsesReturned in interface OperationResultAccessLogMessage
    
    Returns:
    
    The number of intermediate response messages returned to the client in the course of processing the operation, or null if it is not included in the log message.
  - getServersAccessed
```
@NotNull
public java.util.List<java.lang.String> getServersAccessed()
```
    Retrieves a list of the additional servers that were accessed in the course of processing the operation. For example, if the access log message is from a Directory Proxy Server instance, then this may contain a list of the backend servers used to process the operation.
    
    Specified by:
    
    getServersAccessed in interface OperationResultAccessLogMessage
    
    Returns:
    
    A list of the additional servers that were accessed in the course of processing the operation, or an empty list if it is not included in the log message.
  - getUncachedDataAccessed
```
@Nullable
public java.lang.Boolean getUncachedDataAccessed()
```
    Indicates whether the server accessed any uncached data in the course of processing the operation.
    
    Specified by:
    
    getUncachedDataAccessed in interface OperationResultAccessLogMessage
    
    Returns:
    
    true if the server was known to access uncached data in the course of processing the operation, false if the server was known not to access uncached data, or null if it is not included in the log message (and the server likely did not access uncached data).
  - getUsedPrivileges
```
@NotNull
public java.util.Set<java.lang.String> getUsedPrivileges()
```
    Retrieves the names of any privileges used during the course of processing the operation.
    
    Specified by:
    
    getUsedPrivileges in interface OperationResultAccessLogMessage
    
    Returns:
    
    The names of any privileges used during the course of processing the operation, or an empty list if no privileges were used or this is not included in the log message.
  - getPreAuthorizationUsedPrivileges
```
@NotNull
public java.util.Set<java.lang.String> getPreAuthorizationUsedPrivileges()
```
    Retrieves the names of any privileges used during the course of processing the operation before an alternate authorization identity was assigned.
    
    Specified by:
    
    getPreAuthorizationUsedPrivileges in interface OperationResultAccessLogMessage
    
    Returns:
    
    The names of any privileges used during the course of processing the operation before an alternate authorization identity was assigned, or an empty list if no privileges were used or this is not included in the log message.
  - getMissingPrivileges
```
@NotNull
public java.util.Set<java.lang.String> getMissingPrivileges()
```
    Retrieves the names of any privileges that would have been required for processing the operation but that the requester did not have.
    
    Specified by:
    
    getMissingPrivileges in interface OperationResultAccessLogMessage
    
    Returns:
    
    The names of any privileges that would have been required for processing the operation but that the requester did not have, or an empty list if there were no missing privileges or this is not included in the log message.
  - getAlternateAuthorizationDN
```
@Nullable
public java.lang.String getAlternateAuthorizationDN()
```
    Retrieves the alternate authorization DN for the operation.
    
    Specified by:
    
    getAlternateAuthorizationDN in interface SearchResultAccessLogMessage
    
    Returns:
    
    The alternate authorization DN for the operation, or null if it is not included in the log message.
  - getIndexesWithKeysAccessedNearEntryLimit
```
@NotNull
public 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.
    
    Specified by:
    
    getIndexesWithKeysAccessedNearEntryLimit in interface SearchResultAccessLogMessage
    
    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
public 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.
    
    Specified by:
    
    getIndexesWithKeysAccessedExceedingEntryLimit in interface SearchResultAccessLogMessage
    
    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.
  - getIntermediateClientResponseControl
```
@Nullable
public JSONIntermediateClientResponseControl getIntermediateClientResponseControl()
```
    Retrieves information about an intermediate client response control included in the log message.
    
    Returns:
    
    An intermediate client response control included in the log message, or null if no intermediate client response control is available.
  - getTargetHost
```
@Nullable
public java.lang.String getTargetHost()
```
    Retrieves the address of the backend server to which the request has been forwarded.
    
    Specified by:
    
    getTargetHost in interface OperationForwardAccessLogMessage
    
    Returns:
    
    The address of the backend server to which the request has been forwarded, or null if it is not included in the log message.
  - getTargetPort
```
@Nullable
public java.lang.Integer getTargetPort()
```
    Retrieves the port of the backend server to which the request has been forwarded.
    
    Specified by:
    
    getTargetPort in interface OperationForwardAccessLogMessage
    
    Returns:
    
    The port of the backend server to which the request has been forwarded, or null if it is not included in the log message.
  - getTargetProtocol
```
@Nullable
public java.lang.String getTargetProtocol()
```
    Retrieves the protocol used to forward the request to the backend server.
    
    Specified by:
    
    getTargetProtocol in interface OperationForwardAccessLogMessage
    
    Returns:
    
    The protocol used to forward the request to the backend server, or null if it is not included in the log message.
  - getEntriesReturned
```
@Nullable
public java.lang.Long getEntriesReturned()
```
    Retrieves the number of entries returned to the client.
    
    Specified by:
    
    getEntriesReturned in interface SearchResultAccessLogMessage
    
    Returns:
    
    The number of entries returned to the client, or null if it is not included in the log message.
  - getUnindexed
```
@Nullable
public java.lang.Boolean getUnindexed()
```
    Indicates whether the search was unindexed.
    
    Specified by:
    
    getUnindexed in interface SearchResultAccessLogMessage
    
    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.

Class JSONSearchResultAccessLogMessage

Constructor Summary

Method Summary

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONSearchRequestAccessLogMessage

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONRequestAccessLogMessage

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONAccessLogMessage

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONLogMessage

Methods inherited from class java.lang.Object

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.AccessLogMessage

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.LogMessage

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.OperationRequestAccessLogMessage

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.SearchRequestAccessLogMessage

Constructor Detail

JSONSearchResultAccessLogMessage

Method Detail

getMessageType

getResultCode

getDiagnosticMessage

getAdditionalInformation

getMatchedDN

getReferralURLs

getProcessingTimeMillis

getWorkQueueWaitTimeMillis

getResponseControlOIDs

getIntermediateResponsesReturned

getServersAccessed

getUncachedDataAccessed

getUsedPrivileges

getPreAuthorizationUsedPrivileges

getMissingPrivileges

getAlternateAuthorizationDN

getIndexesWithKeysAccessedNearEntryLimit

getIndexesWithKeysAccessedExceedingEntryLimit

getIntermediateClientResponseControl

getTargetHost

getTargetPort

getTargetProtocol

getEntriesReturned

getUnindexed