org.opends.server.types.operation
Interface PreParseModifyOperation

All Superinterfaces:
PluginOperation, PreParseOperation
All Known Implementing Classes:
ModifyOperationBasis

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

This class defines a set of methods that are available for use by pre-parse 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
 void addRawModification(RawModification rawModification)
          Adds the provided modification to the set of raw modifications for this modify operation.
 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.
 void setRawEntryDN(ByteString rawEntryDN)
          Specifies the raw, unprocessed entry DN as included in the client request.
 void setRawModifications(java.util.List<RawModification> rawModifications)
          Specifies the set of raw modifications for this modify operation.
 
Methods inherited from interface org.opends.server.types.operation.PreParseOperation
addRequestControl, addResponseControl, appendAdditionalLogMessage, appendErrorMessage, getAdditionalLogMessage, getErrorMessage, removeRequestControl, removeResponseControl, setAdditionalLogMessage, setErrorMessage
 
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.

setRawEntryDN

void setRawEntryDN(ByteString rawEntryDN)
Specifies the raw, unprocessed entry DN as included in the client request.

Parameters:
rawEntryDN - The raw, unprocessed entry DN as included in the client request.

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.

addRawModification

void addRawModification(RawModification rawModification)
Adds the provided modification to the set of raw modifications for this modify operation.

Parameters:
rawModification - The modification to add to the set of raw modifications for this modify operation.

setRawModifications

void setRawModifications(java.util.List<RawModification> rawModifications)
Specifies the set of raw modifications for this modify operation.

Parameters:
rawModifications - The raw modifications for this modify operation.