|
|||||||||
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.ModifyOperationBasis
public class ModifyOperationBasis
This class defines an operation that may be used to modify an entry in 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 | |
---|---|
ModifyOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
java.util.List<Control> requestControls,
ByteString rawEntryDN,
java.util.List<RawModification> rawModifications)
Creates a new modify operation with the provided information. |
|
ModifyOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
java.util.List<Control> requestControls,
DN entryDN,
java.util.List<Modification> modifications)
Creates a new modify operation with the provided information. |
Method Summary | |
---|---|
void |
addModification(Modification modification)
Adds the provided modification to the set of modifications to this modify operation. |
void |
addRawModification(RawModification rawModification)
Adds the provided modification to the set of raw modifications for this modify 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. |
Entry |
getCurrentEntry()
Retrieves the current entry before any modifications are applied. |
java.util.List<AttributeValue> |
getCurrentPasswords()
Retrieves the set of clear-text current passwords for the user, if available. |
DN |
getEntryDN()
Retrieves the DN of the entry to modify. |
java.util.List<Modification> |
getModifications()
Retrieves the set of modifications for this modify operation. |
Entry |
getModifiedEntry()
Retrieves the modified entry that is to be written to the backend. |
java.util.List<AttributeValue> |
getNewPasswords()
Retrieves the set of clear-text new passwords for the user, if available. |
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. |
ByteString |
getRawEntryDN()
Retrieves the raw, unprocessed entry DN as included in the client request. |
java.util.List<RawModification> |
getRawModifications()
Retrieves the set of raw, unprocessed modifications as included in the client request. |
java.lang.String[][] |
getRequestLogElements()
Retrieves a standard set of elements that should be logged in requests for this type of operation. |
java.util.List<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. |
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 |
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 |
setRawEntryDN(ByteString rawEntryDN)
Specifies the raw, unprocessed entry DN as included in the client request. |
void |
setRawModifications(java.util.List<RawModification> rawModifications)
Specifies the raw modifications for this modify operation. |
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 ModifyOperationBasis(ClientConnection clientConnection, long operationID, int messageID, java.util.List<Control> requestControls, ByteString rawEntryDN, java.util.List<RawModification> rawModifications)
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, unprocessed DN of the entry to modify,
as included in the client request.rawModifications
- The raw, unprocessed set of modifications for
this modify operation as included in the client
request.public ModifyOperationBasis(ClientConnection clientConnection, long operationID, int messageID, java.util.List<Control> requestControls, DN entryDN, java.util.List<Modification> modifications)
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 entry DN for the modify operation.modifications
- The set of modifications for this modify
operation.Method Detail |
---|
public final ByteString getRawEntryDN()
getRawEntryDN
in interface ModifyOperation
getRawEntryDN
in interface PostResponseModifyOperation
getRawEntryDN
in interface PreParseModifyOperation
public final void setRawEntryDN(ByteString rawEntryDN)
setRawEntryDN
in interface ModifyOperation
setRawEntryDN
in interface PreParseModifyOperation
rawEntryDN
- The raw, unprocessed entry DN as included in the client
request.public final DN getEntryDN()
getRawEntryDN
method.
getEntryDN
in interface ModifyOperation
getEntryDN
in interface PostResponseModifyOperation
null
if the raw
entry DN has not yet been processed.public final java.util.List<RawModification> getRawModifications()
getRawModifications
in interface ModifyOperation
getRawModifications
in interface PostResponseModifyOperation
getRawModifications
in interface PreParseModifyOperation
public final void addRawModification(RawModification rawModification)
addRawModification
in interface ModifyOperation
addRawModification
in interface PreParseModifyOperation
rawModification
- The modification to add to the set of raw
modifications for this modify operation.public final void setRawModifications(java.util.List<RawModification> rawModifications)
setRawModifications
in interface ModifyOperation
setRawModifications
in interface PreParseModifyOperation
rawModifications
- The raw modifications for this modify operation.public final java.util.List<Modification> getModifications()
getModifications
in interface ModifyOperation
getModifications
in interface PostResponseModifyOperation
null
if the modifications have not yet been
processed.public final void addModification(Modification modification) throws DirectoryException
addModification
in interface ModifyOperation
modification
- The modification to add to the set of changes for
this modify operation.
DirectoryException
- If an unexpected problem occurs while applying
the modification to the entry.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 ModifyOperation
null
if proxied
authorization has not been requested.public final java.util.List<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 final long getChangeNumber()
getChangeNumber
in interface ModifyOperation
public void setChangeNumber(long changeNumber)
setChangeNumber
in interface ModifyOperation
changeNumber
- The change number that has been assigned to this
operation by the synchronization mechanism.public void setProxiedAuthorizationDN(DN proxiedAuthorizationDN)
setProxiedAuthorizationDN
in interface ModifyOperation
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 getCurrentEntry()
getCurrentEntry
in interface PostResponseModifyOperation
public java.util.List<AttributeValue> getCurrentPasswords()
getCurrentPasswords
in interface PostResponseModifyOperation
null
if
there were none.public Entry getModifiedEntry()
getModifiedEntry
in interface PostResponseModifyOperation
public java.util.List<AttributeValue> getNewPasswords()
getNewPasswords
in interface PostResponseModifyOperation
null
if there were none.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |