All Superinterfaces:

Operation, Runnable

All Known Implementing Classes:

AddOperationBasis, AddOperationWrapper, LocalBackendAddOperation
```
public interface AddOperation
extends Operation
```
This interface defines an operation that may be used to add a new entry to the Directory Server.

Field Summary
- Fields inherited from interface org.opends.server.types.Operation
  LOCALBACKENDOPERATIONS

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addObjectClass(ObjectClass objectClass, String name)`	Adds the provided objectclass to the entry to add.
`void`	`addRawAttribute(RawAttribute rawAttribute)`	Adds the provided attribute to the set of raw attributes for this add operation.
`DN`	`getEntryDN()`	Retrieves the DN of the entry to add.
`Map<ObjectClass,String>`	`getObjectClasses()`	Retrieves the set of processed objectclasses for the entry to add.
`Map<AttributeType,List<Attribute>>`	`getOperationalAttributes()`	Retrieves the set of processed operational attributes for the entry to add.
`DN`	`getProxiedAuthorizationDN()`	Retrieves the proxied authorization DN for this operation if proxied authorization has been requested.
`List<RawAttribute>`	`getRawAttributes()`	Retrieves the set of attributes in their raw, unparsed form as read from the client request.
`ByteString`	`getRawEntryDN()`	Retrieves the DN of the entry to add in a raw, unparsed form as it was included in the request.
`Map<AttributeType,List<Attribute>>`	`getUserAttributes()`	Retrieves the set of processed user attributes for the entry to add.
`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`	`setAttribute(AttributeType attributeType, List<Attribute> attributeList)`	Sets the specified attribute in the entry to add, overwriting any existing attribute of the specified type if necessary.
`void`	`setProxiedAuthorizationDN(DN proxiedAuthorizationDN)`	Set the proxied authorization DN for this operation if proxied authorization has been requested.
`void`	`setRawAttributes(List<RawAttribute> rawAttributes)`	Replaces the set of raw attributes for this add operation.
`void`	`setRawEntryDN(ByteString rawEntryDN)`	Specifies the raw entry DN for the entry to add.

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 DN of the entry to add in a raw, unparsed form as it was included in the request. This may or may not actually contain a valid DN, since no validation will have been performed on it.
    
    Returns:
    
    The DN of the entry in a raw, unparsed form.
  - setRawEntryDN
```
void setRawEntryDN(ByteString rawEntryDN)
```
    Specifies the raw entry DN for the entry to add. This should only be called by pre-parse plugins to alter the DN before it has been processed. If the entry DN needs to be altered later in the process, then it should be done using the getEntryDN and setEntryDN methods.
    
    Parameters:
    
    rawEntryDN - The raw entry DN for the entry to add.
  - getEntryDN
```
DN getEntryDN()
```
    Retrieves the DN of the entry to add. This method should not be called by pre-parse plugins because the parsed DN will not be available at that time.
    
    Returns:
    
    The DN of the entry to add, or null if it has not yet been parsed from the raw DN.
  - getRawAttributes
```
List<RawAttribute> getRawAttributes()
```
    Retrieves the set of attributes in their raw, unparsed form as read from the client request. Some of these attributes may be invalid as no validation will have been performed on them. The returned list must not be altered by the caller.
    
    Returns:
    
    The set of attributes in their raw, unparsed form as read from the client request.
  - addRawAttribute
```
void addRawAttribute(RawAttribute rawAttribute)
```
    Adds the provided attribute to the set of raw attributes for this add operation. This should only be called by pre-parse plugins.
    
    Parameters:
    
    rawAttribute - The attribute to add to the set of raw attributes for this add operation.
  - setRawAttributes
```
void setRawAttributes(List<RawAttribute> rawAttributes)
```
    Replaces the set of raw attributes for this add operation. This should only be called by pre-parse plugins.
    
    Parameters:
    
    rawAttributes - The set of raw attributes for this add operation.
  - getUserAttributes
```
Map<AttributeType,List<Attribute>> getUserAttributes()
```
    Retrieves the set of processed user attributes for the entry to add. This should not be called by pre-parse plugins because this information will not yet be available. The contents of the returned map may be altered by the caller.
    
    Returns:
    
    The set of processed user attributes for the entry to add, or null if that information is not yet available.
  - setAttribute
```
void setAttribute(AttributeType attributeType,
                  List<Attribute> attributeList)
```
    Sets the specified attribute in the entry to add, overwriting any existing attribute of the specified type if necessary. 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.
    
    Parameters:
    
    attributeType - The attribute type for the attribute.
    
    attributeList - The attribute list for the provided attribute type.
  - removeAttribute
```
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.
    
    Parameters:
    
    attributeType - The attribute tyep for the attribute to remove.
  - getObjectClasses
```
Map<ObjectClass,String> getObjectClasses()
```
    Retrieves the set of processed objectclasses for the entry to add. This should not be called by pre-parse plugins because this information will not yet be available. The contents of the returned map may not be altered by the caller.
    
    Returns:
    
    The set of processed objectclasses for the entry to add, or null if that information is not yet available.
  - addObjectClass
```
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.
    
    Parameters:
    
    objectClass - The objectclass to add to the entry.
    
    name - The name to use for the objectclass.
  - removeObjectClass
```
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.
    
    Parameters:
    
    objectClass - The objectclass to remove from the entry.
  - getOperationalAttributes
```
Map<AttributeType,List<Attribute>> getOperationalAttributes()
```
    Retrieves the set of processed operational attributes for the entry to add. This should not be called by pre-parse plugins because this information will not yet be available. The contents of the returned map may be altered by the caller.
    
    Returns:
    
    The set of processed operational attributes for the entry to add, or null if that information is not yet available.
  - 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.

Interface AddOperation

Field Summary

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

Method Summary

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

Method Detail

getRawEntryDN

setRawEntryDN

getEntryDN

getRawAttributes

addRawAttribute

setRawAttributes

getUserAttributes

setAttribute

removeAttribute

getObjectClasses

addObjectClass

removeObjectClass

getOperationalAttributes

getProxiedAuthorizationDN

setProxiedAuthorizationDN