Package org.opends.server.core

Class DeleteOperation

java.lang.Object

org.opends.server.types.Operation

org.opends.server.core.DeleteOperation

All Implemented Interfaces:

PluginOperation, PostCommitDeleteOperation, PostCommitOperation, PostOperationDeleteOperation, PostOperationOperation, PostResponseDeleteOperation, PostResponseOperation, PostSynchronizationDeleteOperation, PostSynchronizationOperation, PreOperationDeleteOperation, PreOperationOperation, PreParseDeleteOperation, PreParseOperation

public final class DeleteOperation
extends Operation
implements PreParseDeleteOperation, PreOperationDeleteOperation, PostOperationDeleteOperation, PostResponseDeleteOperation, PostCommitDeleteOperation, PostSynchronizationDeleteOperation

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.Operation

backend, context, out, pluginConfigManager, request, result, serverContext

Constructor Summary

Constructors

Constructor	Description
DeleteOperation(RequestContext context, LocalBackend<?> backend, DeleteRequest request, Consumer<Response> out, ServerContext serverContext)	Creates a new delete operation.

Method Summary

Modifier and Type	Method	Description
Dn	getEntryDN()	Retrieves the entry DN as included in the client request.
Entry	getEntryToDelete()	Retrieves the entry to be deleted.
DeleteRequest	getRequest()	Returns the request associated to this operation.
protected void	invokePostResponsePlugins()	Invokes any applicable post-response plugins.
protected void	invokePreParsePlugins()	Invokes any applicable pre-parse plugins.
protected Result	runImpl()	Performs the work of actually processing this operation.
void	setEntryDN(Dn entryDN)	Specifies the entry DN for this delete operation.
void	toString(StringBuilder buffer)	Appends a string representation of this operation to the provided buffer.

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

addAdditionalLogItem, addPasswordPolicyWarningToLog, addPostReadResponse, addPreReadResponse, addRequestControl, addResponseControl, checkAttributeConformsToSyntax, checkIfBackendIsWritable, checkIfCanceled, createLdapException, equals, evaluateProxyAuthControls, filterNonDisclosableMatchedDn, getAccessControlHandler, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getClientConnection, getConnectionID, getMessageID, getOperationID, getProxiedAuthorizationDN, getRequestContext, getRequestControl, getRequestControls, getResponseControls, getResult, getResultCode, hashCode, hasPrivilege, hasRequestControl, isInternalOperation, isProxyAuthzControl, isSynchronizationOperation, mustCheckSchema, operationToResult, removeAllDisallowedControls, removeResponseControl, run, sendIntermediateResponse, sendResult, setAttachment, setResult, setResult, toString, trySetLargestEntrySize

Methods inherited from class java.lang.Object

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

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

checkIfCanceled, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getRequestControl, getRequestControl, getRequestControls, getResponseControls, hasPrivilege, isInternalOperation, isSynchronizationOperation, setAttachment, toString

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

getAdditionalLogItems, getAuthorizationDN, getResultCode

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

addAdditionalLogItem, addResponseControl, getAdditionalLogItems, getAuthorizationDN, getResultCode, removeResponseControl, setResult, setResult

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

getAdditionalLogItems, getAuthorizationDN, getResultCode

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

getAdditionalLogItems, getAuthorizationDN, getResultCode

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

addAdditionalLogItem, addResponseControl, getAdditionalLogItems, getAuthorizationDN, removeResponseControl, sendIntermediateResponse

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

addAdditionalLogItem, addRequestControl, addResponseControl, getAdditionalLogItems, removeResponseControl, sendIntermediateResponse

Constructor Details

DeleteOperation

public DeleteOperation(RequestContext context,
 LocalBackend<?> backend,
 DeleteRequest request,
 Consumer<Response> out,
 ServerContext serverContext)

Creates a new delete operation.

Parameters:

context - The context.

backend - The local backend in which this request is to be processed.

request - The request.

out - A consumer responsible for sending responses to the client.

serverContext - the server context

Method Details

setEntryDN

public void setEntryDN(Dn entryDN)

Description copied from interface: PreParseDeleteOperation

Specifies the entry DN for this delete operation.

Specified by:

setEntryDN in interface PreParseDeleteOperation

Parameters:

entryDN - The entry DN for this delete operation.

getEntryDN

public Dn getEntryDN()

Description copied from interface: PreParseDeleteOperation

Retrieves the entry DN as included in the client request.

Specified by:

getEntryDN in interface PostCommitDeleteOperation

Specified by:

getEntryDN in interface PostOperationDeleteOperation

Specified by:

getEntryDN in interface PostResponseDeleteOperation

Specified by:

getEntryDN in interface PostSynchronizationDeleteOperation

Specified by:

getEntryDN in interface PreOperationDeleteOperation

Specified by:

getEntryDN in interface PreParseDeleteOperation

Returns:

The entry DN as included in the client request.

getRequest

public DeleteRequest getRequest()

Description copied from class: Operation

Returns the request associated to this operation.

Specified by:

getRequest in interface PluginOperation

Overrides:

getRequest in class Operation

Returns:

The request associated to this operation.

toString

public 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 PluginOperation

Specified by:

toString in class Operation

Parameters:

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

runImpl

protected Result runImpl()
                  throws LdapException

Description copied from class: Operation

Performs the work of actually processing this operation.

Specified by:

runImpl in class Operation

Returns:

null if the result is delayed (e.g. persistent search), Result otherwise.

Throws:

LdapException - If an error occurred when processing the operation.

invokePreParsePlugins

protected void invokePreParsePlugins()
                              throws LdapException

Description copied from class: Operation

Invokes any applicable pre-parse plugins.

Specified by:

invokePreParsePlugins in class Operation

Throws:

LdapException - If an error occurred when invoking the pre-parse plugins.

invokePostResponsePlugins

protected void invokePostResponsePlugins()

Description copied from class: Operation

Invokes any applicable post-response plugins.

Specified by:

invokePostResponsePlugins in class Operation

getEntryToDelete

public Entry getEntryToDelete()

Description copied from interface: PreOperationDeleteOperation

Retrieves the entry to be deleted.

Specified by:

getEntryToDelete in interface PostCommitDeleteOperation

Specified by:

getEntryToDelete in interface PostOperationDeleteOperation

Specified by:

getEntryToDelete in interface PostResponseDeleteOperation

Specified by:

getEntryToDelete in interface PostSynchronizationDeleteOperation

Specified by:

getEntryToDelete in interface PreOperationDeleteOperation

Returns:

The entry to be deleted.