Package de.xima.fc.logging

Class XLogConfig

java.lang.Object

de.xima.fc.logging.XLogConfig

All Implemented Interfaces:

ILogConfig, Serializable

public class XLogConfig
extends Object
implements ILogConfig

Wrapper model for accessing/modifying logger components of Logger PropertiesConfiguration

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static Pattern	DEFAULT_ERROR_APPENDER_FILE_NAME_PATTERN	Pattern for checking whether a file name is a backup log file of the formcycle error log.
static String	DEFAULT_ERROR_APPENDER_FILE_NAME_PREFIX	Prefix for the special log file that contains all errors from the formcycle application.
static String	DEFAULT_ERROR_APPENDER_NAME	Appender name for the special log file that contains all errors from the formcycle application.

Method Summary

Modifier and Type	Method	Description
void	addAppender(IAppender appender)
void	addLogger(ILogger logger)
IAppender	createNewAppender(EAppenderType type, String nameCandidate)
ILogger	createNewLogger()
static XLogConfig	forFileConfiguration(de.xima.cmn.props.FileBasedPropertiesConfiguration fileConfig)	Beware! In order to read the configuration details it is necessary to initialize the configuration.
List<IAppender>	getAppenders()
IRollingFileAppender	getDefaultErrorLogger()
ILogger	getFacesLogger()
List<ILogger>	getLoggers()
String	getNextAppenderIdentifier()
String	getNextLoggerIdentifier()
ILogger	getRootLogger()
boolean	removeAppender(String identifier)
boolean	removeLogger(String identifier)
void	save()
void	saveAppender(String identifier)
void	saveAppenders()
void	saveLogger(String identifier)
void	saveLoggers()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ERROR_APPENDER_NAME

public static final String DEFAULT_ERROR_APPENDER_NAME

Appender name for the special log file that contains all errors from the formcycle application.

See Also:

Constant Field Values

DEFAULT_ERROR_APPENDER_FILE_NAME_PATTERN

public static final Pattern DEFAULT_ERROR_APPENDER_FILE_NAME_PATTERN

Pattern for checking whether a file name is a backup log file of the formcycle error log.

DEFAULT_ERROR_APPENDER_FILE_NAME_PREFIX

public static final String DEFAULT_ERROR_APPENDER_FILE_NAME_PREFIX

Prefix for the special log file that contains all errors from the formcycle application.

See Also:

Constant Field Values

Method Detail

forFileConfiguration

public static final XLogConfig forFileConfiguration(de.xima.cmn.props.FileBasedPropertiesConfiguration fileConfig)

Beware! In order to read the configuration details it is necessary to initialize the configuration. This means files of file appenders will be created. Should only be used for XfcConfig.LOGGING!

Parameters:

fileConfig - configuration file

Returns:

logging configuration

getAppenders

public List<IAppender> getAppenders()

Specified by:

getAppenders in interface ILogConfig

getLoggers

public List<ILogger> getLoggers()

Specified by:

getLoggers in interface ILogConfig

getFacesLogger

public ILogger getFacesLogger()

getRootLogger

public ILogger getRootLogger()

getDefaultErrorLogger

public IRollingFileAppender getDefaultErrorLogger()

getNextAppenderIdentifier

public String getNextAppenderIdentifier()

getNextLoggerIdentifier

public String getNextLoggerIdentifier()

save

public void save()
          throws org.apache.commons.configuration2.ex.ConfigurationException

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

saveAppenders

public void saveAppenders()
                   throws org.apache.commons.configuration2.ex.ConfigurationException

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

saveLoggers

public void saveLoggers()
                 throws org.apache.commons.configuration2.ex.ConfigurationException

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

saveAppender

public void saveAppender(String identifier)
                  throws org.apache.commons.configuration2.ex.ConfigurationException

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

saveLogger

public void saveLogger(String identifier)
                throws org.apache.commons.configuration2.ex.ConfigurationException

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

removeAppender

public boolean removeAppender(String identifier)
                       throws org.apache.commons.configuration2.ex.ConfigurationException

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

removeLogger

public boolean removeLogger(String identifier)
                     throws org.apache.commons.configuration2.ex.ConfigurationException

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

createNewAppender

public IAppender createNewAppender(EAppenderType type,
                                   String nameCandidate)

createNewLogger

public ILogger createNewLogger()

addAppender

public void addAppender(IAppender appender)

addLogger

public void addLogger(ILogger logger)