de.xima.fc.setup.model.log

Class LogConfigHelper

java.lang.Object

de.xima.fc.setup.model.log.LogConfigHelper

public class LogConfigHelper
extends Object

Helper-Class for the configuration of loggers and appenders

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_PREFIX
static String	KEY_PREFIX_APPENDER
static String	KEY_ROOTLOGGER

Constructor Summary

Constructors

Constructor and Description
LogConfigHelper()

Method Summary

Modifier and Type	Method and Description
static boolean	activateLogger(XLogger logger) Deprecated. will be removed without replacement
static boolean	deactivateLogger(XLogger logger) Deactivates the given logger-instance
static List<XLogAppender>	determineLogAppender() Method which reads the appenders of the log-configuration-file
static List<XLogger>	determineLogger(List<XLogAppender> appenderList) Method to determine all loggers from the log-configuration-file.
static boolean	isAppenderNameUnique(String appenderName) Checks if there is already an appender with the given name stored in the log-properties-file
static boolean	isLogAppenderInUse(XLogAppender appender) Method to check if an appender is in use
static boolean	isLoggerNameUnique(String loggerName) Checks if there is already an logger with the given name stored in the log-properties-file

Methods inherited from class java.lang.Object

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

Field Detail

KEY_PREFIX

public static final String KEY_PREFIX

See Also:

Constant Field Values

KEY_PREFIX_APPENDER

public static final String KEY_PREFIX_APPENDER

See Also:

Constant Field Values

KEY_ROOTLOGGER

public static final String KEY_ROOTLOGGER

See Also:

Constant Field Values

Constructor Detail

LogConfigHelper

public LogConfigHelper()

Method Detail

isLoggerNameUnique

public static boolean isLoggerNameUnique(String loggerName)

Checks if there is already an logger with the given name stored in the log-properties-file

Parameters:

loggerName - String the name to check

Returns:

true if an logger with this name already exists, false otherwise

isAppenderNameUnique

public static boolean isAppenderNameUnique(String appenderName)

Checks if there is already an appender with the given name stored in the log-properties-file

Parameters:

appenderName - String the name to check

Returns:

true if an appender with this name already exists, false otherwise

isLogAppenderInUse

public static boolean isLogAppenderInUse(XLogAppender appender)

Method to check if an appender is in use

Parameters:

appender - XLogAppender

Returns:

true the appender is in use, false otherwise

determineLogger

public static List<XLogger> determineLogger(List<XLogAppender> appenderList)

Method to determine all loggers from the log-configuration-file. Logger without an appender are ignored.

Parameters:

appenderList - List of allender

Returns:

List of XLogger

determineLogAppender

public static List<XLogAppender> determineLogAppender()

Method which reads the appenders of the log-configuration-file

Returns:

List of XLogAppender

activateLogger

@Deprecated
public static boolean activateLogger(XLogger logger)

Deprecated. will be removed without replacement

Parameters:

logger - XLogger

Returns:

false

deactivateLogger

public static boolean deactivateLogger(XLogger logger)

Deactivates the given logger-instance

Parameters:

logger - the XLogger to deactivate

Returns:

true if successful, false otherwise