Package org.opends.server.core

Interface ModifyOperation

All Superinterfaces:

Operation, Runnable

All Known Implementing Classes:

LocalBackendModifyOperation, ModifyOperationBasis, ModifyOperationWrapper

public interface ModifyOperation
extends Operation

This interface defines an operation used to modify an entry in the Directory Server.

Field Summary

Fields inherited from interface org.opends.server.types.Operation

LOCALBACKENDOPERATIONS

Method Summary

Modifier and Type	Method	Description
void	addModification(Modification modification)	Adds the provided modification to the set of modifications to this modify operation.
void	addRawModification(RawModification rawModification)	Adds the provided modification to the set of raw modifications for this modify operation.
DN	getEntryDN()	Retrieves the DN of the entry to modify.
List<Modification>	getModifications()	Retrieves the set of modifications for this modify operation.
DN	getProxiedAuthorizationDN()	Retrieves the proxied authorization DN for this operation if proxied authorization has been requested.
ByteString	getRawEntryDN()	Retrieves the raw, unprocessed entry DN as included in the client request.
List<RawModification>	getRawModifications()	Retrieves the set of raw, unprocessed modifications as included in the client request.
void	setProxiedAuthorizationDN(DN proxiedAuthorizationDN)	Set the proxied authorization DN for this operation if proxied authorization has been requested.
void	setRawEntryDN(ByteString rawEntryDN)	Specifies the raw, unprocessed entry DN as included in the client request.
void	setRawModifications(List<RawModification> rawModifications)	Specifies the raw modifications for this modify operation.

Methods inherited from interface org.opends.server.types.Operation

abort, addAdditionalLogItem, addRequestControl, addResponseControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperationID, getOperationType, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResponseControls, getResultCode, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, registerPostResponseCallback, removeAttachment, removeResponseControl, run, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setReferralURLs, setResponseData, setResultCode, setSynchronizationOperation, 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.

getEntryDN

DN getEntryDN()

Retrieves the DN of the entry to modify. This should not be called by pre-parse plugins because the processed DN will not be available yet. Instead, they should call the getRawEntryDN method.

Returns:

The DN of the entry to modify, or null if the raw entry DN has not yet been processed.

getRawModifications

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. This must only be called by pre-parse plugins.

Parameters:

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

setRawModifications

void setRawModifications(List<RawModification> rawModifications)

Specifies the raw modifications for this modify operation.

Parameters:

rawModifications - The raw modifications for this modify operation.

getModifications

List<Modification> getModifications()

Retrieves the set of modifications for this modify operation. Its contents should not be altered. It will not be available to pre-parse plugins.

Returns:

The set of modifications for this modify operation, or null if the modifications have not yet been processed.

addModification

void addModification(Modification modification)
              throws DirectoryException

Adds the provided modification to the set of modifications to this modify operation. This may only be called by pre-operation plugins.

Parameters:

modification - The modification to add to the set of changes for this modify operation.

Throws:

DirectoryException - If an unexpected problem occurs while applying the modification to the entry.

getProxiedAuthorizationDN

DN getProxiedAuthorizationDN()

Retrieves the proxied authorization DN for this operation if proxied authorization has been requested.

Specified by:

getProxiedAuthorizationDN in interface Operation

Returns:

The proxied authorization DN for this operation if proxied authorization has been requested, or null if proxied authorization has not been requested.

setProxiedAuthorizationDN

void setProxiedAuthorizationDN(DN proxiedAuthorizationDN)

Set the proxied authorization DN for this operation if proxied authorization has been requested.

Specified by:

setProxiedAuthorizationDN in interface Operation

Parameters:

proxiedAuthorizationDN - The proxied authorization DN for this operation if proxied authorization has been requested, or null if proxied authorization has not been requested.