Interface PreOperationOperation

    • Method Detail

      • addResponseControl

        void addResponseControl​(Control control)
        Adds the provided control to the set of controls to include in the response to the client.
        Parameters:
        control - The control to add to the set of controls to include in the response to the client.
      • removeResponseControl

        void removeResponseControl​(Control control)
        Removes the provided control from the set of controls to include in the response to the client.
        Parameters:
        control - The control to remove from the set of controls to include in the response to the client.
      • getErrorMessage

        LocalizableMessageBuilder getErrorMessage()
        Retrieves the error message for this operation. Its contents may be altered by the caller.
        Returns:
        The error message for this operation.
      • setErrorMessage

        void setErrorMessage​(LocalizableMessageBuilder errorMessage)
        Specifies the error message for this operation.
        Parameters:
        errorMessage - The error message for this operation.
      • appendErrorMessage

        void appendErrorMessage​(LocalizableMessage message)
        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.
        Parameters:
        message - The message to append to the error message buffer.
      • getAuthorizationDN

        Dn getAuthorizationDN()
        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).
        Returns:
        The authorization DN for this operation.
      • getAdditionalLogItems

        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.
        Returns:
        An unmodifiable list containing the additional log items for this operation.
      • addAdditionalLogItem

        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. This method may not be called by post-response plugins.
        Parameters:
        item - The additional log item for this operation.