org.opends.server.types.operation
Interface PostResponseOperation

All Superinterfaces:
PluginOperation
All Known Subinterfaces:
PostResponseAddOperation, PostResponseCompareOperation, PostResponseDeleteOperation, PostResponseModifyDNOperation, PostResponseModifyOperation, PostResponseSearchOperation
All Known Implementing Classes:
AbandonOperationBasis, AbstractOperation, AddOperationBasis, BindOperationBasis, CompareOperationBasis, DeleteOperationBasis, ExtendedOperationBasis, InternalSearchOperation, LocalBackendAddOperation, LocalBackendCompareOperation, LocalBackendDeleteOperation, LocalBackendModifyDNOperation, LocalBackendModifyOperation, ModifyDNOperationBasis, ModifyOperationBasis, SearchOperationBasis, UnbindOperationBasis

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public interface PostResponseOperation
extends PluginOperation

This class defines a set of methods that are available for use by post-response plugins for all types of operations. Note that this interface is intended only to define an API for use by plugins and is not intended to be implemented by any custom classes.


Method Summary
 MessageBuilder getAdditionalLogMessage()
          Retrieves the additional log message for this operation, which should be written to the log but not included in the response to the client.
 DN getAuthorizationDN()
          Retrieves the authorization DN for this operation.
 MessageBuilder getErrorMessage()
          Retrieves the error message for this operation.
 DN getMatchedDN()
          Retrieves the matched DN for this operation.
 long getProcessingStopTime()
          Retrieves the time that processing stopped for this operation.
 long getProcessingTime()
          Retrieves the length of time in milliseconds that the server spent processing this operation.
 java.util.List<java.lang.String> getReferralURLs()
          Retrieves the set of referral URLs for this operation.
 ResultCode getResultCode()
          Retrieves the result code for this operation.
 
Methods inherited from interface org.opends.server.types.operation.PluginOperation
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getOperationType, getProcessingStartTime, getRequestControls, getResponseControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString, toString
 

Method Detail

getResultCode

ResultCode getResultCode()
Retrieves the result code for this operation.

Returns:
The result code associated for this operation, or UNDEFINED if the operation has not yet completed.

getErrorMessage

MessageBuilder getErrorMessage()
Retrieves the error message for this operation. Its contents may be altered by the caller.

Returns:
The error message for this operation.

getAdditionalLogMessage

MessageBuilder getAdditionalLogMessage()
Retrieves the additional log message for this operation, which should be written to the log but not included in the response to the client. The contents of this buffer may be altered by the caller.

Returns:
The additional log message for this operation.

getMatchedDN

DN getMatchedDN()
Retrieves the matched DN for this operation.

Returns:
The matched DN for this operation, or null if the operation has not yet completed or does not have a matched DN.

getReferralURLs

java.util.List<java.lang.String> getReferralURLs()
Retrieves the set of referral URLs for this operation. Its contents must not be altered by the caller.

Returns:
The set of referral URLs for this operation, or null if the operation is not yet complete or does not have a set of referral URLs.

getAuthorizationDN

DN getAuthorizationDN()
Retrieves the authorization DN for this operation. In many cases, it will be the same as the DN of the authenticated user for the underlying connection, or the null DN if no authentication has been performed on that connection. However, it may be some other value if special processing has been requested (e.g., the operation included a proxied authorization control).

Returns:
The authorization DN for this operation.

getProcessingStopTime

long getProcessingStopTime()
Retrieves the time that processing stopped for this operation. This will actually hold a time immediately before the response was sent to the client.

Returns:
The time that processing stopped for this operation.

getProcessingTime

long getProcessingTime()
Retrieves the length of time in milliseconds that the server spent processing this operation.

Returns:
The length of time in milliseconds that the server spent processing this operation.