Package org.opends.server.core

Class DeleteOperationBasis

java.lang.Object

org.opends.server.types.AbstractOperation

org.opends.server.core.DeleteOperationBasis

All Implemented Interfaces:

Runnable, DeleteOperation, Operation, PluginOperation, PostResponseDeleteOperation, PostResponseOperation, PreParseDeleteOperation, PreParseOperation

public class DeleteOperationBasis
extends AbstractOperation
implements PreParseDeleteOperation, DeleteOperation, PostResponseDeleteOperation

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

Field Summary

Fields inherited from class org.opends.server.types.AbstractOperation

cancelRequest, cancelResult, clientConnection, messageID, NO_RESPONSE_CONTROLS, operationID

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

LOCALBACKENDOPERATIONS

Constructor Summary

Constructors

Constructor	Description
DeleteOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, ByteString rawEntryDN)	Creates a new delete operation with the provided information.
DeleteOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, DN entryDN)	Creates a new delete operation with the provided information.

Method Summary

Modifier and Type	Method	Description
void	addResponseControl(Control control)	Adds the provided control to the set of controls to include in the response to the client.
DN	getEntryDN()	Retrieves the DN of the entry to delete.
Entry	getEntryToDelete()	Retrieves the entry to be deleted.
OperationType	getOperationType()	Retrieves the operation type for this 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<Control>	getResponseControls()	Retrieves the set of controls to include in the response to the client.
void	removeResponseControl(Control control)	Removes the provided control from the set of controls to include in the response to the client.
void	run()	Performs the work of actually processing this operation.
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 for this delete operation.
void	toString(StringBuilder buffer)	Appends a string representation of this operation to the provided buffer.
void	updateOperationErrMsgAndResCode()	Updates the error message and the result code of the operation.

Methods inherited from class org.opends.server.types.AbstractOperation

abort, addAdditionalLogItem, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, equals, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperationID, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResultCode, getTransactionId, hashCode, invokePostResponseCallbacks, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, processOperationResult, processOperationResult, registerPostResponseCallback, removeAttachment, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setProcessingStartTime, setProcessingStopTime, 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.types.Operation

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

Methods inherited from interface org.opends.server.types.operation.PluginOperation

checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getProcessingStartTime, getRequestControl, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString

Methods inherited from interface org.opends.server.types.operation.PostResponseOperation

getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getProcessingStopTime, getProcessingTime, getReferralURLs, getResultCode

Methods inherited from interface org.opends.server.types.operation.PreParseOperation

addAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, setErrorMessage

Constructor Detail

DeleteOperationBasis

public DeleteOperationBasis(ClientConnection clientConnection,
                            long operationID,
                            int messageID,
                            List<Control> requestControls,
                            ByteString rawEntryDN)

Creates a new delete operation with the provided information.

Parameters:

clientConnection - The client connection with which this operation is associated.

operationID - The operation ID for this operation.

messageID - The message ID of the request with which this operation is associated.

requestControls - The set of controls included in the request.

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

DeleteOperationBasis

public DeleteOperationBasis(ClientConnection clientConnection,
                            long operationID,
                            int messageID,
                            List<Control> requestControls,
                            DN entryDN)

Creates a new delete operation with the provided information.

Parameters:

clientConnection - The client connection with which this operation is associated.

operationID - The operation ID for this operation.

messageID - The message ID of the request with which this operation is associated.

requestControls - The set of controls included in the request.

entryDN - The entry DN for this delete operation.

Method Detail

getRawEntryDN

public final ByteString getRawEntryDN()

Description copied from interface: PreParseDeleteOperation

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

Specified by:

getRawEntryDN in interface DeleteOperation

Specified by:

getRawEntryDN in interface PostResponseDeleteOperation

Specified by:

getRawEntryDN in interface PreParseDeleteOperation

Returns:

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

setRawEntryDN

public final void setRawEntryDN(ByteString rawEntryDN)

Description copied from interface: PreParseDeleteOperation

Specifies the raw, unprocessed entry DN for this delete operation.

Specified by:

setRawEntryDN in interface DeleteOperation

Specified by:

setRawEntryDN in interface PreParseDeleteOperation

Parameters:

rawEntryDN - The raw, unprocessed entry DN for this delete operation.

getEntryDN

public final DN getEntryDN()

Description copied from interface: DeleteOperation

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

Specified by:

getEntryDN in interface PostResponseDeleteOperation

Returns:

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

getOperationType

public final OperationType getOperationType()

Description copied from interface: PluginOperation

Retrieves the operation type for this operation.

Specified by:

getOperationType in interface Operation

Specified by:

getOperationType in interface PluginOperation

Returns:

The operation type for this operation.

getProxiedAuthorizationDN

public DN getProxiedAuthorizationDN()

Description copied from interface: DeleteOperation

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

Specified by:

getProxiedAuthorizationDN in interface DeleteOperation

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.

getResponseControls

public final List<Control> getResponseControls()

Description copied from interface: PluginOperation

Retrieves the set of controls to include in the response to the client. The contents of this list must not be altered.

Specified by:

getResponseControls in interface Operation

Specified by:

getResponseControls in interface PluginOperation

Returns:

The set of controls to include in the response to the client.

addResponseControl

public final void addResponseControl(Control control)

Description copied from interface: PreParseOperation

Adds the provided control to the set of controls to include in the response to the client.

Specified by:

addResponseControl in interface Operation

Specified by:

addResponseControl in interface PreParseOperation

Parameters:

control - The control to add to the set of controls to include in the response to the client.

removeResponseControl

public final void removeResponseControl(Control control)

Description copied from interface: PreParseOperation

Removes the provided control from the set of controls to include in the response to the client.

Specified by:

removeResponseControl in interface Operation

Specified by:

removeResponseControl in interface PreParseOperation

Parameters:

control - The control to remove from the set of controls to include in the response to the client.

toString

public final void toString(StringBuilder buffer)

Description copied from interface: PluginOperation

Appends a string representation of this operation to the provided buffer.

Specified by:

toString in interface Operation

Specified by:

toString in interface PluginOperation

Parameters:

buffer - The buffer into which a string representation of this operation should be appended.

setProxiedAuthorizationDN

public void setProxiedAuthorizationDN(DN proxiedAuthorizationDN)

Description copied from interface: DeleteOperation

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

Specified by:

setProxiedAuthorizationDN in interface DeleteOperation

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.

run

public final void run()

Description copied from interface: Operation

Performs the work of actually processing this operation. This should include all processing for the operation, including invoking pre-parse and post-response plugins, logging messages and any other work that might need to be done in the course of processing.

Specified by:

run in interface Operation

Specified by:

run in interface Runnable

updateOperationErrMsgAndResCode

public void updateOperationErrMsgAndResCode()

Description copied from class: AbstractOperation

Updates the error message and the result code of the operation. This method is called because no workflows were found to process the operation.

Overrides:

updateOperationErrMsgAndResCode in class AbstractOperation

getEntryToDelete

public Entry getEntryToDelete()

Retrieves the entry to be deleted. This method always returns null.

Specified by:

getEntryToDelete in interface PostResponseDeleteOperation

Returns:

The entry to be deleted.