org.opends.server.types.operation
Interface PreParseAddOperation

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

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

This class defines a set of methods that are available for use by pre-parse plugins for add 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 addRawAttribute(RawAttribute rawAttribute)
          Adds the provided attribute to the set of raw attributes for this add operation.
 java.util.List<RawAttribute> getRawAttributes()
          Retrieves the set of attributes in their raw, unparsed form as read from the client request.
 ByteString getRawEntryDN()
          Retrieves the DN of the entry to add in a raw, unparsed form as it was included in the request.
 void setRawAttributes(java.util.List<RawAttribute> rawAttributes)
          Replaces the set of raw attributes for this add operation.
 void setRawEntryDN(ByteString rawEntryDN)
          Specifies the raw entry DN for the entry to add.
 
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 DN of the entry to add in a raw, unparsed form as it was included in the request. This may or may not actually contain a valid DN, since no validation will have been performed on it.

Returns:
The DN of the entry in a raw, unparsed form.

setRawEntryDN

void setRawEntryDN(ByteString rawEntryDN)
Specifies the raw entry DN for the entry to add.

Parameters:
rawEntryDN - The raw entry DN for the entry to add.

getRawAttributes

java.util.List<RawAttribute> getRawAttributes()
Retrieves the set of attributes in their raw, unparsed form as read from the client request. Some of these attributes may be invalid as no validation will have been performed on them. The returned list must not be altered by the caller.

Returns:
The set of attributes in their raw, unparsed form as read from the client request.

addRawAttribute

void addRawAttribute(RawAttribute rawAttribute)
Adds the provided attribute to the set of raw attributes for this add operation.

Parameters:
rawAttribute - The attribute to add to the set of raw attributes for this add operation.

setRawAttributes

void setRawAttributes(java.util.List<RawAttribute> rawAttributes)
Replaces the set of raw attributes for this add operation.

Parameters:
rawAttributes - The set of raw attributes for this add operation.