com.unboundid.ldap.sdk.unboundidds.logs
Interface OperationResultAccessLogMessage

All Superinterfaces:
MinimalOperationResultAccessLogMessage
All Known Implementing Classes:
AddAssuranceCompletedAccessLogMessage, AddResultAccessLogMessage, BindResultAccessLogMessage, CompareResultAccessLogMessage, DeleteAssuranceCompletedAccessLogMessage, DeleteResultAccessLogMessage, ExtendedResultAccessLogMessage, ModifyAssuranceCompletedAccessLogMessage, ModifyDNAssuranceCompletedAccessLogMessage, ModifyDNResultAccessLogMessage, ModifyResultAccessLogMessage, SearchResultAccessLogMessage

@NotExtensible
@ThreadSafety(level=INTERFACE_THREADSAFE)
public interface OperationResultAccessLogMessage
extends MinimalOperationResultAccessLogMessage

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This interface defines a number of methods common to all types of operation result access log messages.


Method Summary
 java.lang.String getIntermediateClientResult()
          Retrieves the content of the intermediate client result for the operation.
 java.lang.Long getIntermediateResponsesReturned()
          Retrieves the number of intermediate response messages returned in the course of processing the operation.
 java.util.List<java.lang.String> getResponseControlOIDs()
          Retrieves the OIDs of any response controls contained in the log message.
 java.util.List<java.lang.String> getServersAccessed()
          Retrieves a list of the additional servers that were accessed in the course of processing the operation.
 
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.MinimalOperationResultAccessLogMessage
getAdditionalInformation, getDiagnosticMessage, getMatchedDN, getProcessingTimeMillis, getQueueTimeMillis, getReferralURLs, getResultCode
 

Method Detail

getIntermediateResponsesReturned

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.

getResponseControlOIDs

java.util.List<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.

getServersAccessed

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.

getIntermediateClientResult

java.lang.String getIntermediateClientResult()
Retrieves the content of the intermediate client result for the operation.

Returns:
The content of the intermediate client result for the operation, or null if it is not included in the log message.