org.opends.server.core

Class DeleteOperationWrapper

java.lang.Object

org.opends.server.core.OperationWrapper<DeleteOperation>

org.opends.server.core.DeleteOperationWrapper

All Implemented Interfaces:

Runnable, DeleteOperation, Operation

Direct Known Subclasses:

LocalBackendDeleteOperation

public abstract class DeleteOperationWrapper
extends OperationWrapper<DeleteOperation>
implements DeleteOperation

This abstract class wraps/decorates a given delete operation. This class will be extended by sub-classes to enhance the functionality of the DeleteOperationBasis.

Field Summary

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

LOCALBACKENDOPERATIONS

Constructor Summary

Constructors

Constructor and Description
DeleteOperationWrapper(DeleteOperation delete) Creates a new delete operation based on the provided delete operation.

Method Summary

Methods

Modifier and Type	Method and Description
DN	getEntryDN() Retrieves the DN of the entry to delete.
org.forgerock.opendj.ldap.ByteString	getRawEntryDN() Retrieves the raw, unprocessed entry DN as included in the client request.
void	setRawEntryDN(org.forgerock.opendj.ldap.ByteString rawEntryDN) Specifies the raw, unprocessed entry DN as included in the client request.
String	toString() Retrieves a string representation of this operation.

Methods inherited from class org.opends.server.core.OperationWrapper

abort, addAdditionalLogItem, addRequestControl, addResponseControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, equals, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperation, getOperationID, getOperationType, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getProxiedAuthorizationDN, getReferralURLs, getRequestControl, getRequestControls, getResponseControls, getResultCode, hashCode, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, registerPostResponseCallback, removeAttachment, removeResponseControl, run, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setProxiedAuthorizationDN, setReferralURLs, setResponseData, setResultCode, setSynchronizationOperation, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opends.server.core.DeleteOperation

getProxiedAuthorizationDN, setProxiedAuthorizationDN

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

Constructor Detail

DeleteOperationWrapper

public DeleteOperationWrapper(DeleteOperation delete)

Creates a new delete operation based on the provided delete operation.

Parameters:

delete - The delete operation to wrap

Method Detail

getEntryDN

public DN getEntryDN()

Retrieves the DN of the entry to delete. 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.

Specified by:

getEntryDN in interface DeleteOperation

Returns:

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

getRawEntryDN

public org.forgerock.opendj.ldap.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.

Specified by:

getRawEntryDN in interface DeleteOperation

Returns:

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

setRawEntryDN

public void setRawEntryDN(org.forgerock.opendj.ldap.ByteString rawEntryDN)

Specifies the raw, unprocessed entry DN as included in the client request. This should only be called by pre-parse plugins. All other code that needs to set the entry DN should use the setEntryDN method.

Specified by:

setRawEntryDN in interface DeleteOperation

Parameters:

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

toString

public String toString()

Retrieves a string representation of this operation.

Specified by:

toString in interface Operation

Overrides:

toString in class OperationWrapper<DeleteOperation>

Returns:

A string representation of this operation.