Package org.opends.server.core

Class AddOperation

java.lang.Object

org.opends.server.types.Operation

org.opends.server.core.AddOperation

All Implemented Interfaces:

PluginOperation, PostCommitAddOperation, PostCommitOperation, PostOperationAddOperation, PostOperationOperation, PostResponseAddOperation, PostResponseOperation, PostSynchronizationAddOperation, PostSynchronizationOperation, PreOperationAddOperation, PreOperationOperation, PreParseAddOperation, PreParseOperation

public final class AddOperation
extends Operation
implements PreParseAddOperation, PreOperationAddOperation, PostOperationAddOperation, PostResponseAddOperation, PostCommitAddOperation, PostSynchronizationAddOperation

This class defines an operation that may be used to add a new entry to the Directory Server.

Field Summary

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

backend, context, out, pluginConfigManager, request, serverContext

Constructor Summary

Constructors

Constructor	Description
AddOperation(RequestContext context, LocalBackend<?> backend, AddRequest request, Consumer<ResponseStream> out)	Creates a new add operation.

Method Summary

Modifier and Type	Method	Description
void	addAttribute(Attribute attribute)	Adds the provided attribute to the set of attributes for this add operation.
void	addObjectClass(ObjectClass objectClass, String name)	Adds the provided objectclass to the entry to add.
void	addResponseControl(Control control)	Adds the provided control to the set of controls to include in the response to the client.
Iterable<Attribute>	getAllAttributes()	Retrieves the set of attributes as read from the client request.
Dn	getEntryDN()	Retrieves the DN of the entry to add.
Entry	getEntryToAdd()	Retrieves the entry to be added to the server.
AddRequest	getRequest()	Returns the request associated to this operation.
List<Control>	getResponseControls()	Retrieves the set of controls to include in the response to the client.
protected void	invokePostResponsePlugins()	Invokes any applicable post-response plugins.
protected boolean	invokePreParsePlugins()	Invokes any applicable pre-parse plugins.
void	removeAttribute(AttributeType attributeType)	Removes the specified attribute from the entry to add.
void	removeObjectClass(ObjectClass objectClass)	Removes the provided objectclass from the entry to add.
void	removeResponseControl(Control control)	Removes the provided control from the set of controls to include in the response to the client.
void	replaceAttribute(Attribute attribute)	Adds all of the attribute values contained in attribute to this entry, replacing any existing attribute values (optional operation).
protected boolean	runImpl()	Performs the work of actually processing this operation.
void	setEntryDN(Dn entryDN)	Specifies the entry DN for the entry to add.
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, appendErrorMessage, appendMaskedErrorMessage, checkAttributeConformsToSyntax, checkIfBackendIsWritable, checkIfCanceled, createLdapException, equals, evaluateProxyAuthControls, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getClientConnection, getConnectionID, getErrorMessage, getLargestEntrySize, getMatchedDN, getMessageID, getOperationID, getProxiedAuthorizationDN, getReferralURLs, getRequestContext, getRequestControl, getRequestControls, getResultCode, hashCode, hasPrivilege, hasRequestControl, isInternalOperation, isProxyAuthzControl, isSynchronizationOperation, mustCheckSchema, operationToResult, processOperationResult, removeAllDisallowedControls, run, sendResponses, sendResult, setAttachment, setErrorMessage, setMatchedDN, setReferralURLs, setResult, setResult, setResultCode, setResultCodeAndMessageNoInfoDisclosure, 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, hasPrivilege, isInternalOperation, isSynchronizationOperation, setAttachment, toString

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

getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode

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

addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setErrorMessage, setMatchedDN, setReferralURLs, setResult, setResultCode

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

getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode

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

getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode

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

addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, sendResponses, setErrorMessage

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

addAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, sendResponses, setErrorMessage

Constructor Details

AddOperation

public AddOperation(RequestContext context,
 LocalBackend<?> backend,
 AddRequest request,
 Consumer<ResponseStream> out)

Creates a new add 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.

Method Details

setEntryDN

public void setEntryDN(Dn entryDN)

Description copied from interface: PreParseAddOperation

Specifies the entry DN for the entry to add.

Specified by:

setEntryDN in interface PreParseAddOperation

Parameters:

entryDN - The entry DN for the entry to add.

getEntryDN

public Dn getEntryDN()

Description copied from interface: PreParseAddOperation

Retrieves the DN of the entry to add.

Specified by:

getEntryDN in interface PostCommitAddOperation

Specified by:

getEntryDN in interface PostOperationAddOperation

Specified by:

getEntryDN in interface PostResponseAddOperation

Specified by:

getEntryDN in interface PostSynchronizationAddOperation

Specified by:

getEntryDN in interface PreOperationAddOperation

Specified by:

getEntryDN in interface PreParseAddOperation

Returns:

The DN of the entry to add.

addAttribute

public void addAttribute(Attribute attribute)

Description copied from interface: PreParseAddOperation

Adds the provided attribute to the set of attributes for this add operation.

Specified by:

addAttribute in interface PreParseAddOperation

Parameters:

attribute - The attribute to add to the set of attributes for this add operation.

addObjectClass

public void addObjectClass(ObjectClass objectClass,
 String name)

Adds the provided objectclass to the entry to add. This should only be called from pre-operation plugins. Note that pre-operation plugin processing is invoked after access control and schema validation, so plugins should be careful to only make changes that will not violate either schema or access control rules.

Specified by:

addObjectClass in interface PreOperationAddOperation

Parameters:

objectClass - The objectclass to add to the entry.

name - The name to use for the objectclass.

removeObjectClass

public void removeObjectClass(ObjectClass objectClass)

Removes the provided objectclass from the entry to add. This should only be called from pre-operation plugins. Note that pre-operation plugin processing is invoked after access control and schema validation, so plugins should be careful to only make changes that will not violate either schema or access control rules.

Specified by:

removeObjectClass in interface PreOperationAddOperation

Parameters:

objectClass - The objectclass to remove from the entry.

getAllAttributes

public Iterable<Attribute> getAllAttributes()

Description copied from interface: PreParseAddOperation

Retrieves the set of attributes as read from the client request. Some of these attributes may be invalid as no validation will have been performed on them.

Specified by:

getAllAttributes in interface PostCommitAddOperation

Specified by:

getAllAttributes in interface PostOperationAddOperation

Specified by:

getAllAttributes in interface PostResponseAddOperation

Specified by:

getAllAttributes in interface PostSynchronizationAddOperation

Specified by:

getAllAttributes in interface PreOperationAddOperation

Specified by:

getAllAttributes in interface PreParseAddOperation

Returns:

The set of attributes as read from the client request.

replaceAttribute

public void replaceAttribute(Attribute attribute)

Description copied from interface: PreOperationAddOperation

Adds all of the attribute values contained in attribute to this entry, replacing any existing attribute values (optional operation). If attribute is empty then the entire attribute will be removed if it is present.

NOTE: This method implements LDAP Modify replace semantics as described in RFC 4511 - Section 4.6. Modify Operation.

Specified by:

replaceAttribute in interface PreOperationAddOperation

Parameters:

attribute - The attribute values to be added to this entry, replacing any existing attribute values, and which may be empty if the entire attribute is to be removed.

removeAttribute

public void removeAttribute(AttributeType attributeType)

Removes the specified attribute from the entry to add. This should only be called from pre-operation plugins. Note that pre-operation processing is invoked after access control and schema validation, so plugins should be careful to only make changes that will not violate either schema or access control rules.

Specified by:

removeAttribute in interface PreOperationAddOperation

Parameters:

attributeType - The attribute type for the attribute to remove.

getRequest

public AddRequest 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.

getResponseControls

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

Returns:

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

addResponseControl

public void addResponseControl(Control control)

Description copied from class: Operation

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

This method may not be called by post-response plugins.

Specified by:

addResponseControl in interface PostOperationOperation

Specified by:

addResponseControl in interface PreOperationOperation

Specified by:

addResponseControl in interface PreParseOperation

Specified by:

addResponseControl in class Operation

Parameters:

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

removeResponseControl

public void removeResponseControl(Control control)

Description copied from class: Operation

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

This method may not be called by post-response plugins.

Specified by:

removeResponseControl in interface PostOperationOperation

Specified by:

removeResponseControl in interface PreOperationOperation

Specified by:

removeResponseControl in interface PreParseOperation

Specified by:

removeResponseControl in class Operation

Parameters:

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

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 boolean runImpl()
                   throws LdapException

Description copied from class: Operation

Performs the work of actually processing this operation.

Specified by:

runImpl in class Operation

Returns:

true if the result should be sent immediately, or false if it will be sent later, e.g. as part of a persistent search.

Throws:

LdapException - If an error occurred when processing the operation.

invokePreParsePlugins

protected boolean invokePreParsePlugins()
                                 throws LdapException

Description copied from class: Operation

Invokes any applicable pre-parse plugins.

Specified by:

invokePreParsePlugins in class Operation

Returns:

true if processing should continue.

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

getEntryToAdd

public Entry getEntryToAdd()

Retrieves the entry to be added to the server. Note that this will not be available to pre-parse plugins or during the conflict resolution portion of the synchronization processing.

Specified by:

getEntryToAdd in interface PostCommitAddOperation

Specified by:

getEntryToAdd in interface PostOperationAddOperation

Specified by:

getEntryToAdd in interface PostResponseAddOperation

Specified by:

getEntryToAdd in interface PostSynchronizationAddOperation

Specified by:

getEntryToAdd in interface PreOperationAddOperation

Returns:

The entry to be added to the server, or null if it is not yet available.