|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.AbstractOperation
org.opends.server.core.AddOperationBasis
public class AddOperationBasis
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.AbstractOperation |
---|
cancelRequest, cancelResult, clientConnection, messageID, NO_RESPONSE_CONTROLS, operationID, useNanoTime |
Fields inherited from interface org.opends.server.types.Operation |
---|
LOCALBACKENDOPERATIONS |
Constructor Summary | |
---|---|
AddOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
java.util.List<Control> requestControls,
ByteString rawEntryDN,
java.util.List<RawAttribute> rawAttributes)
Creates a new add operation with the provided information. |
|
AddOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
java.util.List<Control> requestControls,
DN entryDN,
java.util.Map<ObjectClass,java.lang.String> objectClasses,
java.util.Map<AttributeType,java.util.List<Attribute>> userAttributes,
java.util.Map<AttributeType,java.util.List<Attribute>> operationalAttributes)
Creates a new add operation with the provided information. |
Method Summary | |
---|---|
void |
addObjectClass(ObjectClass objectClass,
java.lang.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. |
void |
addResponseControl(Control control)
Adds the provided control to the set of controls to include in the response to the client. |
long |
getChangeNumber()
Retrieves the change number that has been assigned to this operation. |
DN |
getEntryDN()
Retrieves the DN of the entry to add. |
Entry |
getEntryToAdd()
Retrieves the entry to be added to the server. |
java.util.Map<ObjectClass,java.lang.String> |
getObjectClasses()
Retrieves the set of processed objectclasses for the entry to add. |
java.util.Map<AttributeType,java.util.List<Attribute>> |
getOperationalAttributes()
Retrieves the set of processed operational attributes for the entry to add. |
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. |
java.util.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. |
java.lang.String[][] |
getRequestLogElements()
Retrieves a standard set of elements that should be logged in requests for this type of operation. |
java.util.ArrayList<Control> |
getResponseControls()
Retrieves the set of controls to include in the response to the client. |
java.lang.String[][] |
getResponseLogElements()
Retrieves a standard set of elements that should be logged in responses for this type of operation. |
java.util.Map<AttributeType,java.util.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 |
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 |
setAttribute(AttributeType attributeType,
java.util.List<Attribute> attributeList)
Sets the specified attribute in the entry to add, overwriting any existing attribute of the specified type if necessary. |
void |
setChangeNumber(long changeNumber)
Specifies the change number that has been assigned to this operation by the synchronization mechanism. |
void |
setProxiedAuthorizationDN(DN proxiedAuthorizationDN)
Set the proxied authorization DN for this operation if proxied authorization has been requested. |
void |
setRawAttributes(java.util.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. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this operation to the provided buffer. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.opends.server.types.operation.PreParseOperation |
---|
addRequestControl, appendAdditionalLogMessage, appendErrorMessage, getAdditionalLogMessage, getErrorMessage, removeRequestControl, setAdditionalLogMessage, setErrorMessage |
Methods inherited from interface org.opends.server.types.operation.PostResponseOperation |
---|
getAdditionalLogMessage, getAuthorizationDN, getErrorMessage, getMatchedDN, getProcessingStopTime, getProcessingTime, getReferralURLs, getResultCode |
Methods inherited from interface org.opends.server.types.operation.PluginOperation |
---|
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getProcessingStartTime, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString |
Constructor Detail |
---|
public AddOperationBasis(ClientConnection clientConnection, long operationID, int messageID, java.util.List<Control> requestControls, ByteString rawEntryDN, java.util.List<RawAttribute> rawAttributes)
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 DN of the entry to add from the client
request. This may or may not be a valid DN.rawAttributes
- The raw set of attributes from the client
request (including the objectclass attribute).
This may contain invalid attributes.public AddOperationBasis(ClientConnection clientConnection, long operationID, int messageID, java.util.List<Control> requestControls, DN entryDN, java.util.Map<ObjectClass,java.lang.String> objectClasses, java.util.Map<AttributeType,java.util.List<Attribute>> userAttributes, java.util.Map<AttributeType,java.util.List<Attribute>> operationalAttributes)
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 DN for the entry.objectClasses
- The set of objectclasses for the entry.userAttributes
- The set of user attributes for the entry.operationalAttributes
- The set of operational attributes for the
entry.Method Detail |
---|
public final ByteString getRawEntryDN()
getRawEntryDN
in interface AddOperation
getRawEntryDN
in interface PostResponseAddOperation
getRawEntryDN
in interface PreParseAddOperation
public final void setRawEntryDN(ByteString rawEntryDN)
setRawEntryDN
in interface AddOperation
setRawEntryDN
in interface PreParseAddOperation
rawEntryDN
- The raw entry DN for the entry to add.public final DN getEntryDN()
getEntryDN
in interface AddOperation
getEntryDN
in interface PostResponseAddOperation
null
if it has not yet
been parsed from the raw DN.public final java.util.List<RawAttribute> getRawAttributes()
getRawAttributes
in interface AddOperation
getRawAttributes
in interface PostResponseAddOperation
getRawAttributes
in interface PreParseAddOperation
public final void addRawAttribute(RawAttribute rawAttribute)
addRawAttribute
in interface AddOperation
addRawAttribute
in interface PreParseAddOperation
rawAttribute
- The attribute to add to the set of raw
attributes for this add operation.public final void setRawAttributes(java.util.List<RawAttribute> rawAttributes)
setRawAttributes
in interface AddOperation
setRawAttributes
in interface PreParseAddOperation
rawAttributes
- The set of raw attributes for this add
operation.public final java.util.Map<ObjectClass,java.lang.String> getObjectClasses()
getObjectClasses
in interface AddOperation
getObjectClasses
in interface PostResponseAddOperation
null
if that information is not yet available.public final void addObjectClass(ObjectClass objectClass, java.lang.String name)
addObjectClass
in interface AddOperation
objectClass
- The objectclass to add to the entry.name
- The name to use for the objectclass.public final void removeObjectClass(ObjectClass objectClass)
removeObjectClass
in interface AddOperation
objectClass
- The objectclass to remove from the entry.public final java.util.Map<AttributeType,java.util.List<Attribute>> getUserAttributes()
getUserAttributes
in interface AddOperation
getUserAttributes
in interface PostResponseAddOperation
null
if that information is not yet available.public final java.util.Map<AttributeType,java.util.List<Attribute>> getOperationalAttributes()
getOperationalAttributes
in interface AddOperation
getOperationalAttributes
in interface PostResponseAddOperation
null
if that information is not yet available.public final void setAttribute(AttributeType attributeType, java.util.List<Attribute> attributeList)
setAttribute
in interface AddOperation
attributeType
- The attribute type for the attribute.attributeList
- The attribute list for the provided attribute type.public final void removeAttribute(AttributeType attributeType)
removeAttribute
in interface AddOperation
attributeType
- The attribute tyep for the attribute to remove.public final long getChangeNumber()
getChangeNumber
in interface AddOperation
public final void setChangeNumber(long changeNumber)
setChangeNumber
in interface AddOperation
changeNumber
- The change number that has been assigned to this
operation by the synchronization mechanism.public final OperationType getOperationType()
getOperationType
in interface Operation
getOperationType
in interface PluginOperation
getOperationType
in class AbstractOperation
public final java.lang.String[][] getRequestLogElements()
null
if there is no value for that
field.
getRequestLogElements
in interface Operation
getRequestLogElements
in class AbstractOperation
public final java.lang.String[][] getResponseLogElements()
null
if there is no value for that
field.
getResponseLogElements
in interface Operation
getResponseLogElements
in class AbstractOperation
public DN getProxiedAuthorizationDN()
getProxiedAuthorizationDN
in interface AddOperation
null
if proxied
authorization has not been requested.public final java.util.ArrayList<Control> getResponseControls()
getResponseControls
in interface Operation
getResponseControls
in interface PluginOperation
getResponseControls
in class AbstractOperation
public final void addResponseControl(Control control)
addResponseControl
in interface Operation
addResponseControl
in interface PreParseOperation
addResponseControl
in class AbstractOperation
control
- The control to add to the set of controls to
include in the response to the client.public final void removeResponseControl(Control control)
removeResponseControl
in interface Operation
removeResponseControl
in interface PreParseOperation
removeResponseControl
in class AbstractOperation
control
- The control to remove from the set of controls
to include in the response to the client.public final void toString(java.lang.StringBuilder buffer)
toString
in interface Operation
toString
in interface PluginOperation
toString
in class AbstractOperation
buffer
- The buffer into which a string representation of
this operation should be appended.public void setProxiedAuthorizationDN(DN proxiedAuthorizationDN)
setProxiedAuthorizationDN
in interface AddOperation
proxiedAuthorizationDN
- The proxied authorization DN for this operation if proxied
authorization has been requested, or null
if proxied
authorization has not been requested.public final void run()
run
in interface java.lang.Runnable
run
in class AbstractOperation
public Entry getEntryToAdd()
getEntryToAdd
in interface PostResponseAddOperation
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |