Package org.jboss.as.logging.logmanager

Class ConfigurationPersistence

  • All Implemented Interfaces:
    org.jboss.logmanager.config.LogContextConfiguration, org.jboss.logmanager.Configurator
    public class ConfigurationPersistence
extends Object
implements org.jboss.logmanager.Configurator, org.jboss.logmanager.config.LogContextConfiguration
    Persists the logging.properties file.

    Commits any changes remaining on the LogContextConfiguration and writes out the configuration to the configuration file.

    Author:
    James R. Perkins

    • Method Detail

      • getOrCreateConfigurationPersistence

        public static ConfigurationPersistence getOrCreateConfigurationPersistence()
        Gets the property configurator. If the ConfigurationPersistence does not exist a new one is created.
        Returns:
        the property configurator

      • getOrCreateConfigurationPersistence

        public static ConfigurationPersistence getOrCreateConfigurationPersistence​(org.jboss.logmanager.LogContext logContext)
        Gets the property configurator. If the ConfigurationPersistence does not exist a new one is created.
        Parameters:
        logContext - the log context used to find the property configurator or to attach it to.
        Returns:
        the property configurator

      • getConfigurationPersistence

        public static ConfigurationPersistence getConfigurationPersistence​(org.jboss.logmanager.LogContext logContext)
        Gets the property configurator. If the ConfigurationPersistence does not exist a null is returned.
        Parameters:
        logContext - the log context used to find the property configurator or to attach it to.
        Returns:
        the property configurator or null

      • configure

        public void configure​(InputStream inputStream)
               throws IOException
        Specified by:
        configure in interface org.jboss.logmanager.Configurator
        Throws:
        IOException

      • getLogContext

        public org.jboss.logmanager.LogContext getLogContext()
        Specified by:
        getLogContext in interface org.jboss.logmanager.config.LogContextConfiguration

      • addLoggerConfiguration

        public org.jboss.logmanager.config.LoggerConfiguration addLoggerConfiguration​(String loggerName)
        Specified by:
        addLoggerConfiguration in interface org.jboss.logmanager.config.LogContextConfiguration

      • removeLoggerConfiguration

        public boolean removeLoggerConfiguration​(String loggerName)
        Specified by:
        removeLoggerConfiguration in interface org.jboss.logmanager.config.LogContextConfiguration

      • getLoggerConfiguration

        public org.jboss.logmanager.config.LoggerConfiguration getLoggerConfiguration​(String loggerName)
        Specified by:
        getLoggerConfiguration in interface org.jboss.logmanager.config.LogContextConfiguration

      • getLoggerNames

        public List<String> getLoggerNames()
        Specified by:
        getLoggerNames in interface org.jboss.logmanager.config.LogContextConfiguration

      • addHandlerConfiguration

        public org.jboss.logmanager.config.HandlerConfiguration addHandlerConfiguration​(String moduleName,
                                                                                String className,
                                                                                String handlerName,
                                                                                String... constructorProperties)
        Specified by:
        addHandlerConfiguration in interface org.jboss.logmanager.config.LogContextConfiguration

      • removeHandlerConfiguration

        public boolean removeHandlerConfiguration​(String handlerName)
        Specified by:
        removeHandlerConfiguration in interface org.jboss.logmanager.config.LogContextConfiguration

      • getHandlerConfiguration

        public org.jboss.logmanager.config.HandlerConfiguration getHandlerConfiguration​(String handlerName)
        Specified by:
        getHandlerConfiguration in interface org.jboss.logmanager.config.LogContextConfiguration

      • getHandlerNames

        public List<String> getHandlerNames()
        Specified by:
        getHandlerNames in interface org.jboss.logmanager.config.LogContextConfiguration

      • addFormatterConfiguration

        public org.jboss.logmanager.config.FormatterConfiguration addFormatterConfiguration​(String moduleName,
                                                                                    String className,
                                                                                    String formatterName,
                                                                                    String... constructorProperties)
        Specified by:
        addFormatterConfiguration in interface org.jboss.logmanager.config.LogContextConfiguration

      • removeFormatterConfiguration

        public boolean removeFormatterConfiguration​(String formatterName)
        Specified by:
        removeFormatterConfiguration in interface org.jboss.logmanager.config.LogContextConfiguration

      • getFormatterConfiguration

        public org.jboss.logmanager.config.FormatterConfiguration getFormatterConfiguration​(String formatterName)
        Specified by:
        getFormatterConfiguration in interface org.jboss.logmanager.config.LogContextConfiguration

      • getFormatterNames

        public List<String> getFormatterNames()
        Specified by:
        getFormatterNames in interface org.jboss.logmanager.config.LogContextConfiguration

      • addFilterConfiguration

        public org.jboss.logmanager.config.FilterConfiguration addFilterConfiguration​(String moduleName,
                                                                              String className,
                                                                              String filterName,
                                                                              String... constructorProperties)
        Specified by:
        addFilterConfiguration in interface org.jboss.logmanager.config.LogContextConfiguration

      • removeFilterConfiguration

        public boolean removeFilterConfiguration​(String filterName)
        Specified by:
        removeFilterConfiguration in interface org.jboss.logmanager.config.LogContextConfiguration

      • getFilterConfiguration

        public org.jboss.logmanager.config.FilterConfiguration getFilterConfiguration​(String filterName)
        Specified by:
        getFilterConfiguration in interface org.jboss.logmanager.config.LogContextConfiguration

      • getFilterNames

        public List<String> getFilterNames()
        Specified by:
        getFilterNames in interface org.jboss.logmanager.config.LogContextConfiguration

      • addErrorManagerConfiguration

        public org.jboss.logmanager.config.ErrorManagerConfiguration addErrorManagerConfiguration​(String moduleName,
                                                                                          String className,
                                                                                          String errorManagerName,
                                                                                          String... constructorProperties)
        Specified by:
        addErrorManagerConfiguration in interface org.jboss.logmanager.config.LogContextConfiguration

      • removeErrorManagerConfiguration

        public boolean removeErrorManagerConfiguration​(String errorManagerName)
        Specified by:
        removeErrorManagerConfiguration in interface org.jboss.logmanager.config.LogContextConfiguration

      • getErrorManagerConfiguration

        public org.jboss.logmanager.config.ErrorManagerConfiguration getErrorManagerConfiguration​(String errorManagerName)
        Specified by:
        getErrorManagerConfiguration in interface org.jboss.logmanager.config.LogContextConfiguration

      • getErrorManagerNames

        public List<String> getErrorManagerNames()
        Specified by:
        getErrorManagerNames in interface org.jboss.logmanager.config.LogContextConfiguration

      • prepare

        public void prepare()
        Specified by:
        prepare in interface org.jboss.logmanager.config.LogContextConfiguration

      • addPojoConfiguration

        public org.jboss.logmanager.config.PojoConfiguration addPojoConfiguration​(String moduleName,
                                                                          String className,
                                                                          String pojoName,
                                                                          String... constructorProperties)
        Specified by:
        addPojoConfiguration in interface org.jboss.logmanager.config.LogContextConfiguration

      • removePojoConfiguration

        public boolean removePojoConfiguration​(String pojoName)
        Specified by:
        removePojoConfiguration in interface org.jboss.logmanager.config.LogContextConfiguration

      • getPojoConfiguration

        public org.jboss.logmanager.config.PojoConfiguration getPojoConfiguration​(String pojoName)
        Specified by:
        getPojoConfiguration in interface org.jboss.logmanager.config.LogContextConfiguration

      • getPojoNames

        public List<String> getPojoNames()
        Specified by:
        getPojoNames in interface org.jboss.logmanager.config.LogContextConfiguration

      • commit

        public void commit()
        Specified by:
        commit in interface org.jboss.logmanager.config.LogContextConfiguration

      • forget

        public void forget()
        Specified by:
        forget in interface org.jboss.logmanager.config.LogContextConfiguration

      • rollback

        public void rollback()
        Rolls back the runtime changes.

      • getLogContextConfiguration

        public org.jboss.logmanager.config.LogContextConfiguration getLogContextConfiguration()
        Get the log context configuration.

        WARNING: this instance is not thread safe in any way. The returned object should never be used from more than one thread at a time; furthermore the writeConfiguration(OperationContext) method also accesses this object directly.

        Returns:
        the log context configuration instance

      • writeConfiguration

        public void writeConfiguration​(OperationContext context)
        Write the logging configuration to the logging.properties file.
        Parameters:
        context - the context used to determine the file location.