org.opends.server.types.operation
Interface PostOperationModifyOperation

All Superinterfaces:
PluginOperation, PostOperationOperation
All Known Implementing Classes:
LocalBackendModifyOperation

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

This class defines a set of methods that are available for use by post-operation plugins for modify 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
 Entry getCurrentEntry()
          Retrieves the current entry before any modifications are applied.
 java.util.List<AttributeValue> getCurrentPasswords()
          Retrieves the set of clear-text current passwords for the user, if available.
 DN getEntryDN()
          Retrieves the DN of the entry to modify.
 java.util.List<Modification> getModifications()
          Retrieves the set of modifications for this modify operation.
 Entry getModifiedEntry()
          Retrieves the modified entry that is to be written to the backend.
 java.util.List<AttributeValue> getNewPasswords()
          Retrieves the set of clear-text new passwords for the user, if available.
 ByteString getRawEntryDN()
          Retrieves the raw, unprocessed entry DN as included in the client request.
 java.util.List<RawModification> getRawModifications()
          Retrieves the set of raw, unprocessed modifications as included in the client request.
 
Methods inherited from interface org.opends.server.types.operation.PostOperationOperation
addResponseControl, appendAdditionalLogMessage, appendErrorMessage, getAdditionalLogMessage, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, removeResponseControl, setAdditionalLogMessage, setErrorMessage, setMatchedDN, setReferralURLs, setResponseData, setResultCode
 
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

getRawEntryDN

ByteString getRawEntryDN()
Retrieves the raw, unprocessed entry DN as included in the client request. The DN that is returned may or may not be a valid DN, since no validation will have been performed upon it.

Returns:
The raw, unprocessed entry DN as included in the client request.

getEntryDN

DN getEntryDN()
Retrieves the DN of the entry to modify.

Returns:
The DN of the entry to modify.

getRawModifications

java.util.List<RawModification> getRawModifications()
Retrieves the set of raw, unprocessed modifications as included in the client request. Note that this may contain one or more invalid modifications, as no validation will have been performed on this information. The list returned must not be altered by the caller.

Returns:
The set of raw, unprocessed modifications as included in the client request.

getModifications

java.util.List<Modification> getModifications()
Retrieves the set of modifications for this modify operation. Its contents should not be altered.

Returns:
The set of modifications for this modify operation.

getCurrentEntry

Entry getCurrentEntry()
Retrieves the current entry before any modifications are applied. It should not be modified by the caller.

Returns:
The current entry before any modifications are applied.

getModifiedEntry

Entry getModifiedEntry()
Retrieves the modified entry that is to be written to the backend. It should not be modified by the caller.

Returns:
The modified entry that is to be written to the backend.

getCurrentPasswords

java.util.List<AttributeValue> getCurrentPasswords()
Retrieves the set of clear-text current passwords for the user, if available. This will only be available if the modify operation contains one or more delete elements that target the password attribute and provide the values to delete in the clear. This list should not be altered by the caller.

Returns:
The set of clear-text current password values as provided in the modify request, or null if there were none.

getNewPasswords

java.util.List<AttributeValue> getNewPasswords()
Retrieves the set of clear-text new passwords for the user, if available. This will only be available if the modify operation contains one or more add or replace elements that target the password attribute and provide the values in the clear. This list should not be altered by the caller.

Returns:
The set of clear-text new passwords as provided in the modify request, or null if there were none.