de.griefed.serverpackcreator

Class LoggingConfig

java.lang.Object

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

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

de.griefed.serverpackcreator.LoggingConfig

@Plugin(name="ServerPackCreatorConfigFactory",
        category="ConfigurationFactory")
public final class LoggingConfig
extends org.apache.logging.log4j.core.config.ConfigurationFactory

Custom logging configuration setup to prevent incorrect log-directories when executing ServerPackCreator from CLI from a completely other directory. Or possibly when using symlinks, too. This class prevents the logs being written to the logs-directory inside the directory from which SPC is being run from.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LoggingConfig.CustomXmlConfiguration Custom XmlConfiguration to pass our custom log4j2.xml config to log4j.

Field Summary

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

AUTHORIZATION_PROVIDER, CATEGORY, CONFIGURATION_FACTORY_PROPERTY, CONFIGURATION_FILE_PROPERTY, DEFAULT_PREFIX, LOG4J1_CONFIGURATION_FILE_PROPERTY, LOG4J1_EXPERIMENTAL, LOG4J1_VERSION, LOG4J2_VERSION, LOGGER, substitutor, TEST_PREFIX

Constructor Summary

Constructors

Constructor and Description
LoggingConfig() Check possible home-directories for a viable serverpackcreator.properties and ceck whether the de.griefed.serverpackcreator.home-property is available.

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) Depending on whether this is the first run of ServerPackCreator on a users machine, the default log4j2 configuration may be present at different locations.
protected java.lang.String[]	getSupportedTypes()

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

authorizationProvider, getAuthorizationProvider, getConfiguration, getConfiguration, getDefaultPrefix, getInputFromString, getInstance, getTestPrefix, getVersion, 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

Constructor Detail

LoggingConfig

public LoggingConfig()

Check possible home-directories for a viable serverpackcreator.properties and ceck whether the de.griefed.serverpackcreator.home-property is available. If it is, then use said directory to create the log4j config if it does not already exist, with the path to the logs-directory being set within the aforementioned home-directory.

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)

Depending on whether this is the first run of ServerPackCreator on a users machine, the default log4j2 configuration may be present at different locations. The default one is the config inside the home-directory of SPC, of which we will try to setup our logging with. If said file fails for whatever reason, we will try to use a config inside the directory from which SPC was executed. Should that fail, too, the config from the classpath is used, to ensure we always have default configs available. Should that fail, too, though, log4j is setup with its own default settings.

Specified by:

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

Parameters:

loggerContext - logger context passed from log4j itself

source - configuration source passed from log4j itself. Attempts to overwrite it are made, but if all else fails it is used to setup logging with log4js default config.

Returns:

Custom configuration with proper logs-directory set.