Package org.opends.server.core

Class OperationWrapper<W extends Operation>

    • Constructor Summary

      Constructors 
      Constructor Description
      OperationWrapper​(W operation)
      Creates a new generic operation wrapper.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void abort​(CancelRequest cancelRequest)
      Attempts to abort this operation before processing has completed.
      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 addRequestControl​(Control control)
      Adds the provided control to the set of request controls for this operation.
      void addResponseControl​(Control control)
      Adds the provided control to the set of controls to include in the response to the client.
      void appendErrorMessage​(org.forgerock.i18n.LocalizableMessage message)
      Appends the provided message to the error message buffer.
      void appendMaskedErrorMessage​(org.forgerock.i18n.LocalizableMessage maskedMessage)
      Appends the provided message to the real, masked error message buffer.
      CancelResult cancel​(CancelRequest cancelRequest)
      Attempts to cancel this operation before processing has completed.
      void checkIfCanceled​(boolean signalTooLate)
      Checks to see if this operation requested to cancel in which case CanceledOperationException will be thrown.
      void disconnectClient​(DisconnectReason disconnectReason, boolean sendNotification, org.forgerock.i18n.LocalizableMessage message)
      Terminates the client connection being used to process this operation.
      boolean dontSynchronize()
      Indicates whether this operation needs to be synchronized to other copies of the data.
      boolean equals​(Object obj)  
      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.
      <T> T getAttachment​(String name)
      Retrieves the attachment with the specified name.
      Map<String,​Object> getAttachments()
      Retrieves the set of attachments defined for this operation, as a mapping between the attachment name and the associated object.
      DN getAuthorizationDN()
      Retrieves the authorization DN for this operation.
      Entry getAuthorizationEntry()
      Retrieves the entry for the user that should be considered the authorization identity for this operation.
      CancelRequest getCancelRequest()
      Retrieves the cancel request that has been issued for this operation, if there is one.
      CancelResult getCancelResult()
      Retrieves the cancel result for this operation.
      ClientConnection getClientConnection()
      Retrieves the client connection with which this operation is associated.
      long getConnectionID()
      Retrieves the unique identifier that is assigned to the client connection that submitted this operation.
      org.forgerock.i18n.LocalizableMessageBuilder getErrorMessage()
      Retrieves the error message for this operation.
      org.forgerock.i18n.LocalizableMessageBuilder getMaskedErrorMessage()
      Retrieves the real, masked error message for this operation.
      ResultCode getMaskedResultCode()
      Retrieves the real, masked result code for this operation.
      DN getMatchedDN()
      Retrieves the matched DN for this operation.
      int getMessageID()
      Retrieves the message ID assigned to this operation.
      protected W getOperation()
      Returns the wrapped Operation.
      long getOperationID()
      Retrieves the operation ID for this operation.
      OperationType getOperationType()
      Retrieves the operation type for this operation.
      long getProcessingNanoTime()
      Retrieves the length of time in nanoseconds that the server spent processing this operation if available.
      long getProcessingStartTime()
      Retrieves the time that processing started for this operation.
      long getProcessingStopTime()
      Retrieves the time that processing stopped for this operation.
      long getProcessingTime()
      Retrieves the length of time in milliseconds that the server spent processing this operation.
      DN getProxiedAuthorizationDN()
      Retrieves the proxied authorization DN for this operation if proxied authorization has been requested.
      List<String> getReferralURLs()
      Retrieves the set of referral URLs for this operation.
      <T extends Control>
      T      		 getRequestControl​(ControlDecoder<T> d)
      Retrieves a control included in the request from the client.
      List<Control> getRequestControls()
      Retrieves the set of controls included in the request from the client.
      List<Control> getResponseControls()
      Retrieves the set of controls to include in the response to the client.
      ResultCode getResultCode()
      Retrieves the result code for this operation.
      int hashCode()  
      boolean isInnerOperation()
      Indicates whether this is an inner operation rather than one that was directly requested by an external client.
      boolean isInternalOperation()
      Indicates whether this is an internal operation rather than one that was requested by an external client.
      boolean isSynchronizationOperation()
      Indicates whether this is a synchronization operation rather than one that was requested by an external client.
      void operationCompleted()
      Indicates that processing on this operation has completed successfully and that the client should perform any associated cleanup work.
      void registerPostResponseCallback​(Runnable callback)
      Registers a callback which should be run once this operation has completed and the response sent back to the client.
      <T> T removeAttachment​(String name)
      Removes the attachment with the specified name.
      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.
      <T> T setAttachment​(String name, Object value)
      Sets the value of the specified attachment.
      void setAttachments​(Map<String,​Object> attachments)
      Set the attachments to the operation.
      void setAuthorizationEntry​(Entry authorizationEntry)
      Provides the entry for the user that should be considered the authorization identity for this operation.
      void setDontSynchronize​(boolean dontSynchronize)
      Specifies whether this operation must be synchronized to other copies of the data.
      void setErrorMessage​(org.forgerock.i18n.LocalizableMessageBuilder errorMessage)
      Specifies the error message for this operation.
      void setInnerOperation​(boolean isInnerOperation)
      Specifies whether this is an inner operation rather than one that was directly requested by an external client.
      void setInternalOperation​(boolean isInternalOperation)
      Specifies whether this is an internal operation rather than one that was requested by an external client.
      void setMaskedErrorMessage​(org.forgerock.i18n.LocalizableMessageBuilder maskedErrorMessage)
      Specifies the real, masked error message for this operation.
      void setMaskedResultCode​(ResultCode maskedResultCode)
      Specifies the real, masked result code for this operation.
      void setMatchedDN​(DN matchedDN)
      Specifies the matched DN for this operation.
      void setProxiedAuthorizationDN​(DN proxiedAuthorizationDN)
      Set the proxied authorization DN for this operation if proxied authorization has been requested.
      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​(ResultCode resultCode)
      Specifies the result code for this operation.
      void setSynchronizationOperation​(boolean isSynchronizationOperation)
      Specifies whether this is a synchronization operation rather than one that was requested by an external client.
      String toString()
      Retrieves a string representation of this operation.
      void toString​(StringBuilder buffer)
      Appends a string representation of this operation to the provided buffer.

    • Constructor Detail

      • OperationWrapper

        public OperationWrapper​(W operation)
        Creates a new generic operation wrapper.
        Parameters:
        operation - the generic operation to wrap

    • Method Detail

      • addRequestControl

        public void addRequestControl​(Control control)
        Description copied from interface: Operation
        Adds the provided control to the set of request controls for this operation. This method may only be called by pre-parse plugins.
        Specified by:
        addRequestControl in interface Operation
        Parameters:
        control - The control to add to the set of request controls for this operation.

      • addResponseControl

        public void addResponseControl​(Control control)
        Description copied from interface: Operation
        Adds the provided control to the set of controls to include in the response to the client. This method may not be called by post-response plugins.
        Specified by:
        addResponseControl in interface Operation
        Parameters:
        control - The control to add to the set of controls to include in the response to the client.

      • appendErrorMessage

        public void appendErrorMessage​(org.forgerock.i18n.LocalizableMessage message)
        Description copied from interface: Operation
        Appends the provided message to the error message buffer. If the buffer has not yet been created, then this will create it first and then add the provided message. This method may not be called by post-response plugins.
        Specified by:
        appendErrorMessage in interface Operation
        Parameters:
        message - The message to append to the error message

      • appendMaskedErrorMessage

        public void appendMaskedErrorMessage​(org.forgerock.i18n.LocalizableMessage maskedMessage)
        Description copied from interface: Operation
        Appends the provided message to the real, masked error message buffer. If the buffer has not yet been created, then this will create it first and then add the provided message. This method may not be called by post-response plugins.
        Specified by:
        appendMaskedErrorMessage in interface Operation
        Parameters:
        maskedMessage - The message to append to the real, masked error message

      • cancel

        public CancelResult cancel​(CancelRequest cancelRequest)
        Description copied from interface: Operation
        Attempts to cancel this operation before processing has completed.
        Specified by:
        cancel in interface Operation
        Parameters:
        cancelRequest - Information about the way in which the operation should be canceled.
        Returns:
        A code providing information on the result of the cancellation.

      • abort

        public void abort​(CancelRequest cancelRequest)
        Description copied from interface: Operation
        Attempts to abort this operation before processing has completed.
        Specified by:
        abort in interface Operation
        Parameters:
        cancelRequest - Information about the way in which the operation should be canceled.

      • disconnectClient

        public void disconnectClient​(DisconnectReason disconnectReason,
                             boolean sendNotification,
                             org.forgerock.i18n.LocalizableMessage message)
        Description copied from interface: Operation
        Terminates the client connection being used to process this operation. If this is called by a plugin, then that plugin must return a result indicating that the client connection has been terminated.
        Specified by:
        disconnectClient in interface Operation
        Parameters:
        disconnectReason - The disconnect reason that provides the generic cause for the disconnect.
        sendNotification - Indicates whether to try to provide notification to the client that the connection will be closed.
        message - The message to send to the client. It may be null if no notification is to be sent.

      • dontSynchronize

        public boolean dontSynchronize()
        Description copied from interface: Operation
        Indicates whether this operation needs to be synchronized to other copies of the data.
        Specified by:
        dontSynchronize in interface Operation
        Returns:
        true if this operation should not be synchronized, or false if it should be synchronized.

      • getAttachment

        public <T> T getAttachment​(String name)
        Description copied from interface: Operation
        Retrieves the attachment with the specified name.
        Specified by:
        getAttachment in interface Operation
        Type Parameters:
        T - the type of the attached object
        Parameters:
        name - The name for the attachment to retrieve. It will be treated in a case-sensitive manner.
        Returns:
        The requested attachment object, or null if it does not exist.

      • getAttachments

        public Map<String,​Object> getAttachments()
        Description copied from interface: Operation
        Retrieves the set of attachments defined for this operation, as a mapping between the attachment name and the associated object.
        Specified by:
        getAttachments in interface Operation
        Returns:
        The set of attachments defined for this operation.

      • getAuthorizationDN

        public DN getAuthorizationDN()
        Description copied from interface: Operation
        Retrieves the authorization DN for this operation. In many cases, it will be the same as the DN of the authenticated user for the underlying connection, or the null DN if no authentication has been performed on that connection. However, it may be some other value if special processing has been requested (e.g., the operation included a proxied authorization control). This method should not be called by pre-parse plugins because the correct value may not have yet been determined.
        Specified by:
        getAuthorizationDN in interface Operation
        Returns:
        The authorization DN for this operation, or the null DN if it should be the unauthenticated user..

      • getAuthorizationEntry

        public Entry getAuthorizationEntry()
        Description copied from interface: Operation
        Retrieves the entry for the user that should be considered the authorization identity for this operation. In many cases, it will be the same as the authorization entry for the underlying client connection, or null if no authentication has been performed on that connection. However, it may be some other value if special processing has been requested (e.g., the operation included a proxied authorization control). This method should not be called by pre-parse plugins because the correct value may not yet have been determined.
        Specified by:
        getAuthorizationEntry in interface Operation
        Returns:
        The entry for the user that should be considered the authorization identity for this operation, or null if the authorization identity should be the unauthenticated user.

      • getProxiedAuthorizationDN

        public DN getProxiedAuthorizationDN()
        Description copied from interface: Operation
        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

        public void setProxiedAuthorizationDN​(DN proxiedAuthorizationDN)
        Description copied from interface: Operation
        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.

      • getCancelRequest

        public CancelRequest getCancelRequest()
        Description copied from interface: Operation
        Retrieves the cancel request that has been issued for this operation, if there is one. This method should not be called by post-operation or post-response plugins.
        Specified by:
        getCancelRequest in interface Operation
        Returns:
        The cancel request that has been issued for this operation, or null if there has not been any request to cancel.

      • getCancelResult

        public CancelResult getCancelResult()
        Description copied from interface: Operation
        Retrieves the cancel result for this operation.
        Specified by:
        getCancelResult in interface Operation
        Returns:
        The cancel result for this operation. It will be null if the operation has not seen and reacted to a cancel request.

      • getClientConnection

        public ClientConnection getClientConnection()
        Description copied from interface: Operation
        Retrieves the client connection with which this operation is associated.
        Specified by:
        getClientConnection in interface Operation
        Returns:
        The client connection with which this operation is associated.

      • getConnectionID

        public long getConnectionID()
        Description copied from interface: Operation
        Retrieves the unique identifier that is assigned to the client connection that submitted this operation.
        Specified by:
        getConnectionID in interface Operation
        Returns:
        The unique identifier that is assigned to the client connection that submitted this operation.

      • getErrorMessage

        public org.forgerock.i18n.LocalizableMessageBuilder getErrorMessage()
        Description copied from interface: Operation
        Retrieves the error message for this operation. Its contents may be altered by pre-parse, pre-operation, and post-operation plugins, but not by post-response plugins.
        Specified by:
        getErrorMessage in interface Operation
        Returns:
        The error message for this operation.

      • getMaskedErrorMessage

        public org.forgerock.i18n.LocalizableMessageBuilder getMaskedErrorMessage()
        Description copied from interface: Operation
        Retrieves the real, masked error message for this operation. Its contents may be altered by pre-parse, pre-operation, and post-operation plugins, but not by post-response plugins.
        Specified by:
        getMaskedErrorMessage in interface Operation
        Returns:
        The real, masked error message for this operation.

      • getMaskedResultCode

        public ResultCode getMaskedResultCode()
        Description copied from interface: Operation
        Retrieves the real, masked result code for this operation.
        Specified by:
        getMaskedResultCode in interface Operation
        Returns:
        The real, masked result code associated for this operation, or UNDEFINED if the operation has not yet completed.

      • getMatchedDN

        public DN getMatchedDN()
        Description copied from interface: Operation
        Retrieves the matched DN for this operation.
        Specified by:
        getMatchedDN in interface Operation
        Returns:
        The matched DN for this operation, or null if the operation has not yet completed or does not have a matched DN.

      • getMessageID

        public int getMessageID()
        Description copied from interface: Operation
        Retrieves the message ID assigned to this operation.
        Specified by:
        getMessageID in interface Operation
        Returns:
        The message ID assigned to this operation.

      • getOperation

        protected W getOperation()
        Returns the wrapped Operation.
        Returns:
        the wrapped Operation.

      • getOperationID

        public long getOperationID()
        Description copied from interface: Operation
        Retrieves the operation ID for this operation.
        Specified by:
        getOperationID in interface Operation
        Returns:
        The operation ID for this operation.

      • getOperationType

        public OperationType getOperationType()
        Description copied from interface: Operation
        Retrieves the operation type for this operation.
        Specified by:
        getOperationType in interface Operation
        Returns:
        The operation type for this operation.

      • getProcessingStartTime

        public long getProcessingStartTime()
        Description copied from interface: Operation
        Retrieves the time that processing started for this operation.
        Specified by:
        getProcessingStartTime in interface Operation
        Returns:
        The time that processing started for this operation.

      • getProcessingStopTime

        public long getProcessingStopTime()
        Description copied from interface: Operation
        Retrieves the time that processing stopped for this operation. This will actually hold a time immediately before the response was sent to the client.
        Specified by:
        getProcessingStopTime in interface Operation
        Returns:
        The time that processing stopped for this operation.

      • getProcessingTime

        public long getProcessingTime()
        Description copied from interface: Operation
        Retrieves the length of time in milliseconds that the server spent processing this operation. This should not be called until after the server has sent the response to the client.
        Specified by:
        getProcessingTime in interface Operation
        Returns:
        The length of time in milliseconds that the server spent processing this operation.

      • getProcessingNanoTime

        public long getProcessingNanoTime()
        Description copied from interface: Operation
        Retrieves the length of time in nanoseconds that the server spent processing this operation if available. This should not be called until after the server has sent the response to the client.
        Specified by:
        getProcessingNanoTime in interface Operation
        Returns:
        The length of time in nanoseconds that the server spent processing this operation or -1 if its not available.

      • getReferralURLs

        public List<String> getReferralURLs()
        Description copied from interface: Operation
        Retrieves the set of referral URLs for this operation. Its contents must not be altered by the caller.
        Specified by:
        getReferralURLs in interface Operation
        Returns:
        The set of referral URLs for this operation, or null if the operation is not yet complete or does not have a set of referral URLs.

      • getRequestControls

        public List<Control> getRequestControls()
        Description copied from interface: Operation
        Retrieves the set of controls included in the request from the client. The returned list must not be altered.
        Specified by:
        getRequestControls in interface Operation
        Returns:
        The set of controls included in the request from the client.

      • getRequestControl

        public <T extends Control> T getRequestControl​(ControlDecoder<T> d)
                                        throws DirectoryException
        Description copied from interface: Operation
        Retrieves a control included in the request from the client.
        Specified by:
        getRequestControl in interface Operation
        Type Parameters:
        T - The type of control requested.
        Parameters:
        d - The requested control's decoder.
        Returns:
        The decoded form of the requested control included in the request from the client or null if the control was not found.
        Throws:
        DirectoryException - if an error occurs while decoding the control.

      • getResponseControls

        public List<Control> getResponseControls()
        Description copied from interface: Operation
        Retrieves the set of controls to include in the response to the client. The contents of this list must not be altered.
        Specified by:
        getResponseControls in interface Operation
        Returns:
        The set of controls to include in the response to the client.

      • getResultCode

        public ResultCode getResultCode()
        Description copied from interface: Operation
        Retrieves the result code for this operation.
        Specified by:
        getResultCode in interface Operation
        Returns:
        The result code associated for this operation, or UNDEFINED if the operation has not yet completed.

      • isInnerOperation

        public boolean isInnerOperation()
        Description copied from interface: Operation
        Indicates whether this is an inner operation rather than one that was directly requested by an external client. Said otherwise, inner operations include internal operations, but also operations in the server indirectly mandated by external requests like Rest2LDAP for example. This may not be called from within a plugin.
        Specified by:
        isInnerOperation in interface Operation
        Returns:
        true if this is an inner operation, or false if it is not.

      • isInternalOperation

        public boolean isInternalOperation()
        Description copied from interface: Operation
        Indicates whether this is an internal operation rather than one that was requested by an external client.
        Specified by:
        isInternalOperation in interface Operation
        Returns:
        true if this is an internal operation, or false if it is not.

      • isSynchronizationOperation

        public boolean isSynchronizationOperation()
        Description copied from interface: Operation
        Indicates whether this is a synchronization operation rather than one that was requested by an external client.
        Specified by:
        isSynchronizationOperation in interface Operation
        Returns:
        true if this is a data synchronization operation, or false if it is not.

      • operationCompleted

        public void operationCompleted()
        Description copied from interface: Operation
        Indicates that processing on this operation has completed successfully and that the client should perform any associated cleanup work.
        Specified by:
        operationCompleted in interface Operation

      • removeAttachment

        public <T> T removeAttachment​(String name)
        Description copied from interface: Operation
        Removes the attachment with the specified name.
        Specified by:
        removeAttachment in interface Operation
        Type Parameters:
        T - the type of the attached object
        Parameters:
        name - The name for the attachment to remove. It will be treated in a case-sensitive manner.
        Returns:
        The attachment that was removed, or null if it does not exist.

      • removeResponseControl

        public void removeResponseControl​(Control control)
        Description copied from interface: Operation
        Removes the provided control from the set of controls to include in the response to the client. This method may not be called by post-response plugins.
        Specified by:
        removeResponseControl in interface Operation
        Parameters:
        control - The control to remove from the set of controls to include in the response to the client.

      • setAttachment

        public <T> T setAttachment​(String name,
                           Object value)
        Description copied from interface: Operation
        Sets the value of the specified attachment. If an attachment already exists with the same name, it will be replaced. Otherwise, a new attachment will be added.
        Specified by:
        setAttachment in interface Operation
        Type Parameters:
        T - the type of the attached object
        Parameters:
        name - The name to use for the attachment.
        value - The value to use for the attachment.
        Returns:
        The former value held by the attachment with the given name, or null if there was previously no such attachment.

      • setAttachments

        public void setAttachments​(Map<String,​Object> attachments)
        Description copied from interface: Operation
        Set the attachments to the operation.
        Specified by:
        setAttachments in interface Operation
        Parameters:
        attachments - - Attachments to register within the operation

      • setAuthorizationEntry

        public void setAuthorizationEntry​(Entry authorizationEntry)
        Description copied from interface: Operation
        Provides the entry for the user that should be considered the authorization identity for this operation. This must not be called from within a plugin.
        Specified by:
        setAuthorizationEntry in interface Operation
        Parameters:
        authorizationEntry - The entry for the user that should be considered the authorization identity for this operation, or null if it should be the unauthenticated user.

      • setDontSynchronize

        public void setDontSynchronize​(boolean dontSynchronize)
        Description copied from interface: Operation
        Specifies whether this operation must be synchronized to other copies of the data.
        Specified by:
        setDontSynchronize in interface Operation
        Parameters:
        dontSynchronize - Specifies whether this operation must be synchronized to other copies of the data.

      • setErrorMessage

        public void setErrorMessage​(org.forgerock.i18n.LocalizableMessageBuilder errorMessage)
        Description copied from interface: Operation
        Specifies the error message for this operation. This method may not be called by post-response plugins.
        Specified by:
        setErrorMessage in interface Operation
        Parameters:
        errorMessage - The error message for this operation.

      • setInnerOperation

        public void setInnerOperation​(boolean isInnerOperation)
        Description copied from interface: Operation
        Specifies whether this is an inner operation rather than one that was directly requested by an external client. Said otherwise, inner operations include internal operations, but also operations in the server indirectly mandated by external requests like Rest2LDAP for example. This may not be called from within a plugin.
        Specified by:
        setInnerOperation in interface Operation
        Parameters:
        isInnerOperation - Specifies whether this is an inner operation rather than one that was requested by an external client.

      • setInternalOperation

        public void setInternalOperation​(boolean isInternalOperation)
        Description copied from interface: Operation
        Specifies whether this is an internal operation rather than one that was requested by an external client. This may not be called from within a plugin.
        Specified by:
        setInternalOperation in interface Operation
        Parameters:
        isInternalOperation - Specifies whether this is an internal operation rather than one that was requested by an external client.

      • setMaskedErrorMessage

        public void setMaskedErrorMessage​(org.forgerock.i18n.LocalizableMessageBuilder maskedErrorMessage)
        Description copied from interface: Operation
        Specifies the real, masked error message for this operation. This method may not be called by post-response plugins.
        Specified by:
        setMaskedErrorMessage in interface Operation
        Parameters:
        maskedErrorMessage - The real, masked error message for this operation.

      • setMaskedResultCode

        public void setMaskedResultCode​(ResultCode maskedResultCode)
        Description copied from interface: Operation
        Specifies the real, masked result code for this operation. This method may not be called by post-response plugins.
        Specified by:
        setMaskedResultCode in interface Operation
        Parameters:
        maskedResultCode - The real, masked result code for this operation.

      • setMatchedDN

        public void setMatchedDN​(DN matchedDN)
        Description copied from interface: Operation
        Specifies the matched DN for this operation. This may not be called by post-response plugins.
        Specified by:
        setMatchedDN in interface Operation
        Parameters:
        matchedDN - The matched DN for this operation.

      • setReferralURLs

        public void setReferralURLs​(List<String> referralURLs)
        Description copied from interface: Operation
        Specifies the set of referral URLs for this operation. This may not be called by post-response plugins.
        Specified by:
        setReferralURLs in interface Operation
        Parameters:
        referralURLs - The set of referral URLs for this operation.

      • setResponseData

        public void setResponseData​(DirectoryException directoryException)
        Description copied from interface: Operation
        Sets the response elements for this operation based on the information contained in the provided DirectoryException object. This method may not be called by post-response plugins.
        Specified by:
        setResponseData in interface Operation
        Parameters:
        directoryException - The exception containing the information to use for the response elements.

      • setResultCode

        public void setResultCode​(ResultCode resultCode)
        Description copied from interface: Operation
        Specifies the result code for this operation. This method may not be called by post-response plugins.
        Specified by:
        setResultCode in interface Operation
        Parameters:
        resultCode - The result code for this operation.

      • setSynchronizationOperation

        public void setSynchronizationOperation​(boolean isSynchronizationOperation)
        Description copied from interface: Operation
        Specifies whether this is a synchronization operation rather than one that was requested by an external client. This method may not be called from within a plugin.
        Specified by:
        setSynchronizationOperation in interface Operation
        Parameters:
        isSynchronizationOperation - Specifies whether this is a synchronization operation rather than one that was requested by an external client.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public String toString()
        Description copied from interface: Operation
        Retrieves a string representation of this operation.
        Specified by:
        toString in interface Operation
        Overrides:
        toString in class Object
        Returns:
        A string representation of this operation.

      • toString

        public void toString​(StringBuilder buffer)
        Description copied from interface: Operation
        Appends a string representation of this operation to the provided buffer.
        Specified by:
        toString in interface Operation
        Parameters:
        buffer - The buffer into which a string representation of this operation should be appended.

      • checkIfCanceled

        public final void checkIfCanceled​(boolean signalTooLate)
                           throws CanceledOperationException
        Description copied from interface: Operation
        Checks to see if this operation requested to cancel in which case CanceledOperationException will be thrown.
        Specified by:
        checkIfCanceled in interface Operation
        Parameters:
        signalTooLate - true to signal that any further cancel requests will be too late after return from this call or false otherwise.
        Throws:
        CanceledOperationException - if this operation should be cancelled.

      • registerPostResponseCallback

        public void registerPostResponseCallback​(Runnable callback)
        Description copied from interface: Operation
        Registers a callback which should be run once this operation has completed and the response sent back to the client.
        Specified by:
        registerPostResponseCallback in interface Operation
        Parameters:
        callback - The callback to be run once this operation has completed and the response sent back to the client.

      • run

        public void run()
        Description copied from interface: Operation
        Performs the work of actually processing this operation. This should include all processing for the operation, including invoking pre-parse and post-response plugins, logging messages and any other work that might need to be done in the course of processing.
        Specified by:
        run in interface Operation
        Specified by:
        run in interface Runnable

      • getAdditionalLogItems

        public List<AdditionalLogItem> getAdditionalLogItems()
        Description copied from interface: Operation
        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.
        Specified by:
        getAdditionalLogItems in interface Operation
        Returns:
        An unmodifiable list containing the additional log items for this operation.

      • addAdditionalLogItem

        public void addAdditionalLogItem​(AdditionalLogItem item)
        Description copied from interface: Operation
        Adds an additional log item to this operation, which should be written to the log but not included in the response to the client. This method may not be called by post-response plugins.
        Specified by:
        addAdditionalLogItem in interface Operation
        Parameters:
        item - The additional log item for this operation.