org.opends.server.types.operation
Interface PreParseModifyDNOperation

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

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

This class defines a set of methods that are available for use by pre-parse plugins for modify DN 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
 boolean deleteOldRDN()
          Indicates whether the current RDN value should be removed from the entry.
 ByteString getRawEntryDN()
          Retrieves the raw, unprocessed entry DN as included in the client request.
 ByteString getRawNewRDN()
          Retrieves the raw, unprocessed newRDN as included in the request from the client.
 ByteString getRawNewSuperior()
          Retrieves the raw, unprocessed newSuperior from the client request.
 void setDeleteOldRDN(boolean deleteOldRDN)
          Specifies whether the current RDN value should be removed from the entry.
 void setRawEntryDN(ByteString rawEntryDN)
          Specifies the raw, unprocessed entry DN as included in the client request.
 void setRawNewRDN(ByteString rawNewRDN)
          Specifies the raw, unprocessed newRDN as included in the request from the client.
 void setRawNewSuperior(ByteString rawNewSuperior)
          Specifies the raw, unprocessed newSuperior for this modify DN operation, as provided in the request from the client.
 
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. This should only be called by pre-parse plugins.

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

getRawNewRDN

ByteString getRawNewRDN()
Retrieves the raw, unprocessed newRDN as included in the request from the client. This may or may not contain a valid RDN, as no validation will have been performed on it.

Returns:
The raw, unprocessed newRDN as included in the request from the client.

setRawNewRDN

void setRawNewRDN(ByteString rawNewRDN)
Specifies the raw, unprocessed newRDN as included in the request from the client. This should only be called by pre-parse plugins and should not be used in later stages of processing.

Parameters:
rawNewRDN - The raw, unprocessed newRDN as included in the request from the client.

deleteOldRDN

boolean deleteOldRDN()
Indicates whether the current RDN value should be removed from the entry.

Returns:
true if the current RDN value should be removed from the entry, or false if not.

setDeleteOldRDN

void setDeleteOldRDN(boolean deleteOldRDN)
Specifies whether the current RDN value should be removed from the entry.

Parameters:
deleteOldRDN - Specifies whether the current RDN value should be removed from the entry.

getRawNewSuperior

ByteString getRawNewSuperior()
Retrieves the raw, unprocessed newSuperior from the client request. This may or may not contain a valid DN, as no validation will have been performed on it.

Returns:
The raw, unprocessed newSuperior from the client request, or null if there is none.

setRawNewSuperior

void setRawNewSuperior(ByteString rawNewSuperior)
Specifies the raw, unprocessed newSuperior for this modify DN operation, as provided in the request from the client. This method should only be called by pre-parse plugins.

Parameters:
rawNewSuperior - The raw, unprocessed newSuperior as provided in the request from the client.