com.ppm.logging.configuration

Class DefaultConfigurationFactory

java.lang.Object

org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilderFactory

org.apache.logging.log4j.core.config.ConfigurationFactory

com.ppm.logging.configuration.DefaultConfigurationFactory

public class DefaultConfigurationFactory
extends org.apache.logging.log4j.core.config.ConfigurationFactory

The PPM Logger Configuration Factory

During initialization, Log4j 2 will search for available ConfigurationFactories and then select the one to use. The selected ConfigurationFactory creates the Configuration that Log4j will use. Here is how Log4j finds the available ConfigurationFactories:

1. A system property named "log4j.configurationFactory" can be set with the name of the ConfigurationFactory to be used.
2. ConfigurationFactory.setConfigurationFactory(ConfigurationFactory) can be called with the instance of the ConfigurationFactory to be used. This must be called before any other calls to Log4j.
3. A ConfigurationFactory implementation can be added to the classpath and configured as a plugin in the "ConfigurationFactory" category. The Order annotation can be used to specify the relative priority when multiple applicable ConfigurationFactories are found.

ConfigurationFactories have the concept of "supported types", which basically maps to the file extension of the configuration file that the ConfigurationFactory can handle. If a configuration file location is specified, ConfigurationFactories whose supported type does not include "*" or the matching file extension will not be used.

See Also:

log4j/2.x/manual/customconfig.html

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	CONFIG_FILES_TYPES Valid file extensions for Configuration files.

Fields inherited from class org.apache.logging.log4j.core.config.ConfigurationFactory

CATEGORY, CONFIGURATION_FACTORY_PROPERTY, CONFIGURATION_FILE_PROPERTY, DEFAULT_PREFIX, LOGGER, substitutor, TEST_PREFIX

Constructor Summary

Constructors

Constructor and Description
DefaultConfigurationFactory(PropertiesLoader propertiesLoader)

Method Summary

Modifier and Type	Method and Description
org.apache.logging.log4j.core.config.Configuration	getConfiguration(org.apache.logging.log4j.core.LoggerContext loggerContext, org.apache.logging.log4j.core.config.ConfigurationSource source)
org.apache.logging.log4j.core.config.Configuration	getConfiguration(org.apache.logging.log4j.core.LoggerContext loggerContext, java.lang.String name, java.net.URI configLocation)
PropertiesLoader	getPropertiesLoader()
protected java.lang.String[]	getSupportedTypes()

Methods inherited from class org.apache.logging.log4j.core.config.ConfigurationFactory

getConfiguration, getInputFromString, getInstance, isActive, removeConfigurationFactory, resetConfigurationFactory, setConfigurationFactory

Methods inherited from class org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilderFactory

newConfigurationBuilder, newConfigurationBuilder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIG_FILES_TYPES

public static final java.lang.String[] CONFIG_FILES_TYPES

Valid file extensions for Configuration files. Because it specifies a supported type of "*" it will override any configuration files provided

Constructor Detail

DefaultConfigurationFactory

public DefaultConfigurationFactory(PropertiesLoader propertiesLoader)

Method Detail

getSupportedTypes

protected java.lang.String[] getSupportedTypes()

Specified by:

getSupportedTypes in class org.apache.logging.log4j.core.config.ConfigurationFactory

getConfiguration

public org.apache.logging.log4j.core.config.Configuration getConfiguration(org.apache.logging.log4j.core.LoggerContext loggerContext,
                                                                           org.apache.logging.log4j.core.config.ConfigurationSource source)

Specified by:

getConfiguration in class org.apache.logging.log4j.core.config.ConfigurationFactory

getConfiguration

public org.apache.logging.log4j.core.config.Configuration getConfiguration(org.apache.logging.log4j.core.LoggerContext loggerContext,
                                                                           java.lang.String name,
                                                                           java.net.URI configLocation)

Overrides:

getConfiguration in class org.apache.logging.log4j.core.config.ConfigurationFactory

getPropertiesLoader

public PropertiesLoader getPropertiesLoader()