@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface InProgressOperation extends PluginOperation
Modifier and Type | Method and Description |
---|---|
void |
addAdditionalLogItem(AdditionalLogItem item)
Adds an additional log item to this operation, which should be written to
the log but not included in the response to the client.
|
void |
addResponseControl(Control control)
Adds the provided control to the set of controls to include in
the response to the client.
|
void |
appendErrorMessage(LocalizableMessage message)
Appends the provided message to the error message buffer.
|
List<AdditionalLogItem> |
getAdditionalLogItems()
Returns an unmodifiable list containing the additional log items for this
operation, which should be written to the log but not included in the
response to the client.
|
org.forgerock.opendj.ldap.Dn |
getAuthorizationDN()
Retrieves the authorization DN for this operation.
|
LocalizableMessageBuilder |
getErrorMessage()
Retrieves the error message for this operation.
|
org.forgerock.opendj.ldap.Dn |
getMatchedDN()
Retrieves the matched DN for this operation.
|
List<String> |
getReferralURLs()
Retrieves the set of referral URLs for this operation.
|
org.forgerock.opendj.ldap.ResultCode |
getResultCode()
Retrieves the result code for this operation.
|
void |
removeResponseControl(Control control)
Removes the provided control from the set of controls to include
in the response to the client.
|
void |
setErrorMessage(LocalizableMessageBuilder errorMessage)
Specifies the error message for this operation.
|
void |
setMatchedDN(org.forgerock.opendj.ldap.Dn matchedDN)
Specifies the matched DN for this operation.
|
void |
setReferralURLs(List<String> referralURLs)
Specifies the set of referral URLs for this operation.
|
void |
setResponseData(DirectoryException directoryException)
Sets the response elements for this operation based on the
information contained in the provided
DirectoryException object. |
void |
setResultCode(org.forgerock.opendj.ldap.ResultCode resultCode)
Specifies the result code for this operation.
|
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getOperationType, getProcessingStartTime, getRequestControl, getRequestControls, getResponseControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString, toString
void addResponseControl(Control control)
control
- The control to add to the set of controls to
include in the response to the client.void removeResponseControl(Control control)
control
- The control to remove from the set of controls
to include in the response to the client.org.forgerock.opendj.ldap.ResultCode getResultCode()
UNDEFINED
if the operation has not yet
completed.void setResultCode(org.forgerock.opendj.ldap.ResultCode resultCode)
resultCode
- The result code for this operation.LocalizableMessageBuilder getErrorMessage()
void setErrorMessage(LocalizableMessageBuilder errorMessage)
errorMessage
- The error message for this operation.void appendErrorMessage(LocalizableMessage message)
message
- The message to append to the error messageorg.forgerock.opendj.ldap.Dn getMatchedDN()
null
if the operation has not yet completed or does not have
a matched DN.void setMatchedDN(org.forgerock.opendj.ldap.Dn matchedDN)
matchedDN
- The matched DN for this operation.List<String> getReferralURLs()
null
if the operation is not yet complete
or does not have a set of referral URLs.void setReferralURLs(List<String> referralURLs)
referralURLs
- The set of referral URLs for this
operation.void setResponseData(DirectoryException directoryException)
DirectoryException
object.directoryException
- The exception containing the
information to use for the response
elements.org.forgerock.opendj.ldap.Dn getAuthorizationDN()
List<AdditionalLogItem> getAdditionalLogItems()
void addAdditionalLogItem(AdditionalLogItem item)
item
- The additional log item for this operation.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.