de.taimos.daemon.log4j

Class DvalinLog4jConfigurationFactory

java.lang.Object

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

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

de.taimos.daemon.log4j.DvalinLog4jConfigurationFactory

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

Copyright 2022 Cinovo AG

Author:

mweise

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
DvalinLog4jConfigurationFactory()

Method Summary

Modifier and Type	Method and Description
static org.apache.logging.log4j.core.config.Configuration	configure(org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder<?> builder) Create minimal default configuration
static org.apache.logging.log4j.core.config.Configuration	configure(org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder<?> builder, org.apache.logging.log4j.core.config.builder.api.LayoutComponentBuilder layout, boolean consoleEnabled, String fileName, String filePattern) Create config with custom log file
static org.apache.logging.log4j.core.config.Configuration	configure(org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder<?> builder, org.apache.logging.log4j.core.config.builder.api.LayoutComponentBuilder layout, boolean consoleEnabled, String fileName, String filePattern, String syslogHost, String syslogFacility, org.apache.logging.log4j.core.config.builder.api.LayoutComponentBuilder syslogLayout, org.apache.logging.log4j.Level syslogLevel) programmatic log4j2 configuration, see https://www.baeldung.com/log4j2-programmatic-config
static org.apache.logging.log4j.core.config.builder.api.AppenderComponentBuilder	createConsoleAppender(org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder<?> builder)
static org.apache.logging.log4j.core.config.builder.api.LayoutComponentBuilder	createDefaultLayout(org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder<?> builder)
static org.apache.logging.log4j.core.config.builder.api.LayoutComponentBuilder	createLayout(org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder<?> builder, String pattern)
static org.apache.logging.log4j.core.config.builder.api.AppenderComponentBuilder	createRollingFileAppender(org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder<?> builder, String fileName, String filePattern)
static org.apache.logging.log4j.core.config.builder.api.AppenderComponentBuilder	createSyslogAppender(org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder<?> builder, String host, String facility)
static org.apache.logging.log4j.core.config.builder.api.LayoutComponentBuilder	createSyslogLayout(org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder<?> builder, String daemonName)
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, String name, URI configLocation)
static String	getLogFilePath(String daemonName)
static String	getLogFilePattern(String filePath)
String[]	getSupportedTypes()

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

authorizationProvider, getAuthorizationProvider, 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

DvalinLog4jConfigurationFactory

public DvalinLog4jConfigurationFactory()

Method Detail

configure

public static org.apache.logging.log4j.core.config.Configuration configure(org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder<?> builder)

Create minimal default configuration

Parameters:

builder - config builder

Returns:

default configuration

configure

public static org.apache.logging.log4j.core.config.Configuration configure(org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder<?> builder,
                                                                           org.apache.logging.log4j.core.config.builder.api.LayoutComponentBuilder layout,
                                                                           boolean consoleEnabled,
                                                                           String fileName,
                                                                           String filePattern)

Create config with custom log file

Parameters:

builder - config builder

layout - layout builder

consoleEnabled - log to console

fileName - log file name

filePattern - log file pattern

Returns:

built configuration

configure

public static org.apache.logging.log4j.core.config.Configuration configure(org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder<?> builder,
                                                                           org.apache.logging.log4j.core.config.builder.api.LayoutComponentBuilder layout,
                                                                           boolean consoleEnabled,
                                                                           String fileName,
                                                                           String filePattern,
                                                                           String syslogHost,
                                                                           String syslogFacility,
                                                                           org.apache.logging.log4j.core.config.builder.api.LayoutComponentBuilder syslogLayout,
                                                                           org.apache.logging.log4j.Level syslogLevel)

programmatic log4j2 configuration, see https://www.baeldung.com/log4j2-programmatic-config

Parameters:

builder - config builder

layout - layout builder

consoleEnabled - log to console

syslogHost - syslog host

syslogFacility - syslog facility

syslogLayout - syslog layout

Returns:

built configuration

createConsoleAppender

public static org.apache.logging.log4j.core.config.builder.api.AppenderComponentBuilder createConsoleAppender(org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder<?> builder)

Parameters:

builder - config builder

Returns:

builder for ConsoleAppender

createRollingFileAppender

public static org.apache.logging.log4j.core.config.builder.api.AppenderComponentBuilder createRollingFileAppender(org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder<?> builder,
                                                                                                                  String fileName,
                                                                                                                  String filePattern)

Parameters:

builder - config builder

fileName - log file name

filePattern - log file pattern

Returns:

builder for RollingFileAppender

getLogFilePath

public static String getLogFilePath(String daemonName)

Parameters:

daemonName - the daemon name

Returns:

log file path as String

getLogFilePattern

public static String getLogFilePattern(String filePath)

createSyslogAppender

public static org.apache.logging.log4j.core.config.builder.api.AppenderComponentBuilder createSyslogAppender(org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder<?> builder,
                                                                                                             String host,
                                                                                                             String facility)

Parameters:

builder - config builder

host - syslog host

facility - syslog facility

Returns:

builder for SyslogAppender

createDefaultLayout

public static org.apache.logging.log4j.core.config.builder.api.LayoutComponentBuilder createDefaultLayout(org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder<?> builder)

Parameters:

builder - config builder

Returns:

builder for default PatternLayout

createSyslogLayout

public static org.apache.logging.log4j.core.config.builder.api.LayoutComponentBuilder createSyslogLayout(org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder<?> builder,
                                                                                                         String daemonName)

Parameters:

builder - config builder

Returns:

builder for default PatternLayout

createLayout

public static org.apache.logging.log4j.core.config.builder.api.LayoutComponentBuilder createLayout(org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder<?> builder,
                                                                                                   String pattern)

Parameters:

builder - config builder

pattern - string pattern to use

Returns:

builder for PatternLayout

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,
                                                                           String name,
                                                                           URI configLocation)

Overrides:

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

getSupportedTypes

public String[] getSupportedTypes()

Specified by:

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