Package org.opends.server.core

Interface DeleteOperation

All Superinterfaces:

Operation, Runnable

All Known Implementing Classes:

DeleteOperationBasis, DeleteOperationWrapper, LocalBackendDeleteOperation

public interface DeleteOperation
extends Operation

This interface defines an operation that may be used to remove an entry from the Directory Server.

Field Summary

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

LOCALBACKENDOPERATIONS

Method Summary

Modifier and Type	Method	Description
DN	getEntryDN()	Retrieves the DN of the entry to delete.
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.
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.

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. All other code that needs to set the entry DN should use the setEntryDN method.

Parameters:

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

getEntryDN

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.

Returns:

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

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.