Package org.jboss.as.controller.audit

Interface ManagedAuditLogger

    • Method Detail

      • isLogReadOnly

        boolean isLogReadOnly()
        Get whether this audit logger logs read-only operations
        Returns:
        whether this audit logger logs read-only operations

      • setLogReadOnly

        void setLogReadOnly​(boolean logReadOnly)
        Set whether to log read-only operations
        Parameters:
        logReadOnly - wheter to log read-only operations

      • isLogBoot

        boolean isLogBoot()
        Get whether this audit logger logs operations on boot
        Returns:
        whether this audit logger logs operations on boot

      • setLogBoot

        void setLogBoot​(boolean logBoot)
        Set whether to log operations on boot
        Parameters:
        logBoot - whether to log operations on boot

      • getLoggerStatus

        AuditLogger.Status getLoggerStatus()
        Gets the status of the audit logger
        Returns:
        the status

      • setLoggerStatus

        void setLoggerStatus​(AuditLogger.Status newStatus)
        Sets the status of the audit logger
        Parameters:
        newStatus - the status

      • recycleHandler

        void recycleHandler​(String name)
        Recycles a handler. This stops it, and resets the failure count so that the next time it is used it will reinitialize.
        Parameters:
        name - the name of the handler

      • createNewConfiguration

        ManagedAuditLogger createNewConfiguration​(boolean manualCommit)
        Create another audit logger configuration, e.g. for JMX which has its own global config of the audit logger
        Parameters:
        manualCommit - if true the caller is responsible for applying the changes themselves, if false the changes will be committed after the next log records has been written
        Returns:
        the new configuration

      • addFormatter

        void addFormatter​(AuditLogItemFormatter formatter)
        Add a formatter
        Parameters:
        formatter - the formatter

      • updateHandlerFormatter

        void updateHandlerFormatter​(String name,
                            String formatterName)
        Update the handler formatter. This will take effect immediately.
        Parameters:
        name - the name of the handler
        formatterName - the name of the formatter

      • updateHandlerMaxFailureCount

        void updateHandlerMaxFailureCount​(String name,
                                  int count)
        Update the handler max failure count. This will take effect immediately
        Parameters:
        name - the name of the handler
        count - the max failure count

      • updateSyslogHandlerFacility

        void updateSyslogHandlerFacility​(String name,
                                 SyslogAuditLogHandler.Facility facility)
        Update the syslog handler facility. This will take effect immediately.
        Parameters:
        name - the name of the syslog handler
        facility - the facility

      • updateSyslogHandlerAppName

        void updateSyslogHandlerAppName​(String name,
                                String appName)
        Update the handler app-name. This will take effect immediately
        Parameters:
        name - the name of the handler
        appName - the app name

      • updateSyslogHandlerReconnectTimeout

        void updateSyslogHandlerReconnectTimeout​(String name,
                                         int reconnectTimeout)
        Update the handler reconnect timeout. This will take effect immediately
        Parameters:
        name - the name of the handler
        reconnectTimeout - the app name

      • updateInMemoryHandlerMaxHistory

        void updateInMemoryHandlerMaxHistory​(String name,
                                     int maxHistory)
        Update the handler history size.
        Parameters:
        name - the name of the handler
        maxHistory - the history size of the handler

      • removeFormatter

        void removeFormatter​(String name)
        Remove a formatter
        Parameters:
        name - the formatter name

      • getHandlerFailureCount

        int getHandlerFailureCount​(String name)
        Get the current failure count of a handler
        Parameters:
        name - the name of the handler
        Returns:
        the failure count

      • getHandlerDisabledDueToFailure

        boolean getHandlerDisabledDueToFailure​(String name)
        Get whether a handler was disabled due to failures
        Parameters:
        name - the name of the handler
        Returns:
        whether it is disabled

      • getJsonFormatter

        JsonAuditLogItemFormatter getJsonFormatter​(String name)
        Gets a formatter by its name
        Parameters:
        name - the name of the formatter
        Returns:
        the formatter

      • listLastEntries

        default List<org.jboss.dmr.ModelNode> listLastEntries​(String name)
        Gets the last log entries
        Parameters:
        name - the name of the handler
        Returns:
        the last log entries of the handler

      • startBoot

        void startBoot()
        Callback for the controller to call before the controller is booted

      • bootDone

        void bootDone()
        Callback for the controller to call when the controller has been booted