Interface PostSynchronizationOperation
-
- All Superinterfaces:
PluginOperation
- All Known Subinterfaces:
PostSynchronizationAddOperation
,PostSynchronizationDeleteOperation
,PostSynchronizationModifyDNOperation
,PostSynchronizationModifyOperation
- All Known Implementing Classes:
AddOperation
,DeleteOperation
,ModifyDnOperation
,ModifyOperation
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface PostSynchronizationOperation extends PluginOperation
This class defines a set of methods that are available for use by post-synchronization 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<AdditionalLogItem>
getAdditionalLogItems()
Returns an unmodifiable list containing the additional log items 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.LocalizableMessageBuilder
getErrorMessage()
Retrieves the error message for this operation.Dn
getMatchedDN()
Retrieves the matched DN for this operation.List<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, getRequestControl, getRequestControl, 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
LocalizableMessageBuilder getErrorMessage()
Retrieves the error message for this operation. Its contents may be altered by the caller.- Returns:
- The error 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
List<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.
-
getAdditionalLogItems
List<AdditionalLogItem> getAdditionalLogItems()
Returns an unmodifiable list containing the additional log items for this operation, which should be written to the log but not included in the response to the client.- Returns:
- An unmodifiable list containing the additional log items for this operation.
-
-