public class AddOperationBasis extends AbstractOperation implements PreParseAddOperation, AddOperation, PostResponseAddOperation
cancelRequest, cancelResult, clientConnection, messageID, NO_RESPONSE_CONTROLS, operationID
LOCALBACKENDOPERATIONS
Constructor and Description |
---|
AddOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
org.forgerock.opendj.ldap.messages.AddRequest request)
Creates a new add operation with the provided information.
|
AddOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
List<Control> requestControls,
org.forgerock.opendj.ldap.ByteString rawEntryDN,
List<RawAttribute> rawAttributes)
Creates a new add operation with the provided information.
|
AddOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
List<Control> requestControls,
Entry entry)
Creates a new add operation with the provided information.
|
Modifier and Type | Method and Description |
---|---|
void |
addObjectClass(org.forgerock.opendj.ldap.schema.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.
|
void |
addResponseControl(Control control)
Adds the provided control to the set of controls to include in
the response to the client.
|
org.forgerock.opendj.ldap.Dn |
getEntryDN()
Retrieves the DN of the entry to add.
|
Entry |
getEntryToAdd()
Retrieves the entry to be added to the server.
|
Map<org.forgerock.opendj.ldap.schema.ObjectClass,String> |
getObjectClasses()
Retrieves the set of processed objectclasses for the entry to add.
|
Map<org.forgerock.opendj.ldap.schema.AttributeType,List<Attribute>> |
getOperationalAttributes()
Retrieves the set of processed operational attributes for the entry to add.
|
OperationType |
getOperationType()
Retrieves the operation type for this operation.
|
org.forgerock.opendj.ldap.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.
|
org.forgerock.opendj.ldap.ByteString |
getRawEntryDN()
Retrieves the DN of the entry to add in a raw, unparsed form as
it was included in the request.
|
ArrayList<Control> |
getResponseControls()
Retrieves the set of controls to include in the response to the
client.
|
Map<org.forgerock.opendj.ldap.schema.AttributeType,List<Attribute>> |
getUserAttributes()
Retrieves the set of processed user attributes for the entry to add.
|
void |
removeAttribute(org.forgerock.opendj.ldap.schema.AttributeType attributeType)
Removes the specified attribute from the entry to add.
|
void |
removeObjectClass(org.forgerock.opendj.ldap.schema.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(org.forgerock.opendj.ldap.schema.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(org.forgerock.opendj.ldap.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(org.forgerock.opendj.ldap.ByteString rawEntryDN)
Specifies the raw entry DN for the entry to add.
|
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.
|
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, 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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
addAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, setErrorMessage
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
getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getProcessingStopTime, getProcessingTime, getReferralURLs, getResultCode
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getProcessingStartTime, getRequestControl, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString
public AddOperationBasis(ClientConnection clientConnection, long operationID, int messageID, org.forgerock.opendj.ldap.messages.AddRequest request)
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.request
- The add request.public AddOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, org.forgerock.opendj.ldap.ByteString rawEntryDN, 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, List<Control> requestControls, Entry entry)
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.entry
- The entry to add.public final org.forgerock.opendj.ldap.ByteString getRawEntryDN()
PreParseAddOperation
getRawEntryDN
in interface AddOperation
getRawEntryDN
in interface PostResponseAddOperation
getRawEntryDN
in interface PreParseAddOperation
public final void setRawEntryDN(org.forgerock.opendj.ldap.ByteString rawEntryDN)
PreParseAddOperation
setRawEntryDN
in interface AddOperation
setRawEntryDN
in interface PreParseAddOperation
rawEntryDN
- The raw entry DN for the entry to add.public final org.forgerock.opendj.ldap.Dn getEntryDN()
AddOperation
getEntryDN
in interface AddOperation
getEntryDN
in interface PostResponseAddOperation
null
if it has not yet
been parsed from the raw DN.public final List<RawAttribute> getRawAttributes()
PreParseAddOperation
getRawAttributes
in interface AddOperation
getRawAttributes
in interface PostResponseAddOperation
getRawAttributes
in interface PreParseAddOperation
public final void addRawAttribute(RawAttribute rawAttribute)
PreParseAddOperation
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(List<RawAttribute> rawAttributes)
PreParseAddOperation
setRawAttributes
in interface AddOperation
setRawAttributes
in interface PreParseAddOperation
rawAttributes
- The set of raw attributes for this add
operation.public final Map<org.forgerock.opendj.ldap.schema.ObjectClass,String> getObjectClasses()
AddOperation
getObjectClasses
in interface AddOperation
getObjectClasses
in interface PostResponseAddOperation
null
if that information is not yet available.public final void addObjectClass(org.forgerock.opendj.ldap.schema.ObjectClass objectClass, String name)
AddOperation
addObjectClass
in interface AddOperation
objectClass
- The objectclass to add to the entry.name
- The name to use for the objectclass.public final void removeObjectClass(org.forgerock.opendj.ldap.schema.ObjectClass objectClass)
AddOperation
removeObjectClass
in interface AddOperation
objectClass
- The objectclass to remove from the entry.public final Map<org.forgerock.opendj.ldap.schema.AttributeType,List<Attribute>> getUserAttributes()
AddOperation
getUserAttributes
in interface AddOperation
getUserAttributes
in interface PostResponseAddOperation
null
if that information is not yet available.public final Map<org.forgerock.opendj.ldap.schema.AttributeType,List<Attribute>> getOperationalAttributes()
AddOperation
getOperationalAttributes
in interface AddOperation
getOperationalAttributes
in interface PostResponseAddOperation
null
if that information is not yet available.public final void setAttribute(org.forgerock.opendj.ldap.schema.AttributeType attributeType, List<Attribute> attributeList)
AddOperation
setAttribute
in interface AddOperation
attributeType
- The attribute type for the attribute.attributeList
- The attribute list for the provided attribute type.public final void removeAttribute(org.forgerock.opendj.ldap.schema.AttributeType attributeType)
AddOperation
removeAttribute
in interface AddOperation
attributeType
- The attribute tyep for the attribute to remove.public final OperationType getOperationType()
PluginOperation
getOperationType
in interface Operation
getOperationType
in interface PluginOperation
public org.forgerock.opendj.ldap.Dn getProxiedAuthorizationDN()
AddOperation
getProxiedAuthorizationDN
in interface AddOperation
getProxiedAuthorizationDN
in interface Operation
null
if proxied
authorization has not been requested.public final ArrayList<Control> getResponseControls()
PluginOperation
getResponseControls
in interface Operation
getResponseControls
in interface PluginOperation
public final void addResponseControl(Control control)
PreParseOperation
addResponseControl
in interface Operation
addResponseControl
in interface PreParseOperation
control
- The control to add to the set of controls to
include in the response to the client.public final void removeResponseControl(Control control)
PreParseOperation
removeResponseControl
in interface Operation
removeResponseControl
in interface PreParseOperation
control
- The control to remove from the set of controls
to include in the response to the client.public final void toString(StringBuilder buffer)
PluginOperation
toString
in interface Operation
toString
in interface PluginOperation
buffer
- The buffer into which a string representation of
this operation should be appended.public void setProxiedAuthorizationDN(org.forgerock.opendj.ldap.Dn proxiedAuthorizationDN)
AddOperation
setProxiedAuthorizationDN
in interface AddOperation
setProxiedAuthorizationDN
in interface Operation
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()
Operation
public void updateOperationErrMsgAndResCode()
AbstractOperation
updateOperationErrMsgAndResCode
in class AbstractOperation
public Entry getEntryToAdd()
getEntryToAdd
in interface PostResponseAddOperation
Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.