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

Interface OperationResultAccessLogMessage

All Superinterfaces:

AccessLogMessage, LogMessage, OperationForwardAccessLogMessage, OperationRequestAccessLogMessage, java.io.Serializable

All Known Subinterfaces:

AbandonResultAccessLogMessage, AddAssuranceCompletedAccessLogMessage, AddResultAccessLogMessage, AssuranceCompletedAccessLogMessage, BindResultAccessLogMessage, CompareResultAccessLogMessage, DeleteAssuranceCompletedAccessLogMessage, DeleteResultAccessLogMessage, ExtendedResultAccessLogMessage, ModifyAssuranceCompletedAccessLogMessage, ModifyDNAssuranceCompletedAccessLogMessage, ModifyDNResultAccessLogMessage, ModifyResultAccessLogMessage, SearchResultAccessLogMessage

All Known Implementing Classes:

JSONAbandonResultAccessLogMessage, JSONAddAssuranceCompletedAccessLogMessage, JSONAddResultAccessLogMessage, JSONBindResultAccessLogMessage, JSONCompareResultAccessLogMessage, JSONDeleteAssuranceCompletedAccessLogMessage, JSONDeleteResultAccessLogMessage, JSONExtendedResultAccessLogMessage, JSONModifyAssuranceCompletedAccessLogMessage, JSONModifyDNAssuranceCompletedAccessLogMessage, JSONModifyDNResultAccessLogMessage, JSONModifyResultAccessLogMessage, JSONSearchResultAccessLogMessage, TextFormattedAbandonResultAccessLogMessage, TextFormattedAddAssuranceCompletedAccessLogMessage, TextFormattedAddResultAccessLogMessage, TextFormattedBindResultAccessLogMessage, TextFormattedCompareResultAccessLogMessage, TextFormattedDeleteAssuranceCompletedAccessLogMessage, TextFormattedDeleteResultAccessLogMessage, TextFormattedExtendedResultAccessLogMessage, TextFormattedModifyAssuranceCompletedAccessLogMessage, TextFormattedModifyDNAssuranceCompletedAccessLogMessage, TextFormattedModifyDNResultAccessLogMessage, TextFormattedModifyResultAccessLogMessage, TextFormattedSearchResultAccessLogMessage

@NotExtensible
 @ThreadSafety(level=INTERFACE_THREADSAFE)
public interface OperationResultAccessLogMessage
extends OperationRequestAccessLogMessage, OperationForwardAccessLogMessage

This class provides a data structure that holds information about an 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

Modifier and Type	Method and Description
java.lang.String	getAdditionalInformation() Retrieves a message with additional information about the result of the operation.
java.lang.String	getDiagnosticMessage() Retrieves the diagnostic message for the operation.
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.
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.Boolean	getUncachedDataAccessed() Indicates whether the server accessed any uncached data in the course of processing the operation.
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 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.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

Method Detail

getResultCode

@Nullable
ResultCode getResultCode()

Retrieves the result code for the operation.

Returns:

The result code for the operation, or null if it is not included in the log message.

getDiagnosticMessage

@Nullable
java.lang.String getDiagnosticMessage()

Retrieves the diagnostic message for the operation.

Returns:

The diagnostic message for the operation, or null if it is not included in the log message.

getAdditionalInformation

@Nullable
java.lang.String getAdditionalInformation()

Retrieves a message with additional information about the result of the operation.

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
java.lang.String getMatchedDN()

Retrieves the matched DN for the operation.

Returns:

The matched DN for the operation, or null if it is not included in the log message.

getReferralURLs

@NotNull
java.util.List<java.lang.String> getReferralURLs()

Retrieves the list of referral URLs for the operation.

Returns:

The list of referral URLs for the operation, or an empty list if it is not included in the log message.

getProcessingTimeMillis

@Nullable
java.lang.Double getProcessingTimeMillis()

Retrieves the length of time in milliseconds required to process the operation.

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
java.lang.Double getWorkQueueWaitTimeMillis()

Retrieves the length of time in milliseconds the operation was required to wait on the work queue.

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
java.util.Set<java.lang.String> getResponseControlOIDs()

Retrieves the OIDs of any response controls contained in the log message.

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
java.lang.Long getIntermediateResponsesReturned()

Retrieves the number of intermediate response messages returned in the course of processing the operation.

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
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.

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
java.lang.Boolean getUncachedDataAccessed()

Indicates whether the server accessed any uncached data in the course of processing the operation.

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
java.util.Set<java.lang.String> getUsedPrivileges()

Retrieves the names of any privileges used during the course of processing the operation.

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
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.

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
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.

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.