Package com.logicaldoc.util.config

Class LoggingConfigurator

java.lang.Object

com.logicaldoc.util.config.LoggingConfigurator

public class LoggingConfigurator
extends Object

Utility class for manipulating log4j.xml file

Author:

Michael Scholz, Marco Meschieri

Constructor Summary

Constructors

Constructor	Description
LoggingConfigurator()

Method Summary

Modifier and Type	Method	Description
void	addCategory(Class clazz, String[] appenders)
void	addCategory(String name, String[] appenders)
void	addHtmlAppender(String name)
void	addTextAppender(String name)
String	getFile(String appender)	Same as getFile(String, boolean)
String	getFile(String appender, boolean replaceVariables)	This method selects a filepath of an appender.
Collection<String>	getLoggingFiles()	This method selects all the log files
Collection<String>	getWebLoggingFiles()	Deprecated, for removal: This API element is subject to removal in a future version.
void	setFile(String appender, String file)	This method sets a file of an appender.
void	setLogsRoot(String rootPath)	Sets a common path for all file appenders.
boolean	write()

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingConfigurator

public LoggingConfigurator()

Method Detail

getLoggingFiles

public Collection<String> getLoggingFiles()

This method selects all the log files

Returns:

collection of the log file paths

getWebLoggingFiles

@Deprecated(forRemoval=true,
            since="8.7.2")
public Collection<String> getWebLoggingFiles()

Deprecated, for removal: This API element is subject to removal in a future version.

This method selects all file appenders suitable for web visualization

Returns:

collection of the appender names

getFile

public String getFile(String appender)

Same as getFile(String, boolean)

Parameters:

appender - name of the appender

Returns:

the path of the log file

getFile

public String getFile(String appender,
                      boolean replaceVariables)

This method selects a filepath of an appender.

Parameters:

appender - The appender name

replaceVariables - If true all variables(${var}) in the file path will be substituted

Returns:

The log file path

setFile

public void setFile(String appender,
                    String file)

This method sets a file of an appender.

Parameters:

appender - name of the appender

file - path of the log file

addTextAppender

public void addTextAppender(String name)

addHtmlAppender

public void addHtmlAppender(String name)

addCategory

public void addCategory(Class clazz,
                        String[] appenders)

addCategory

public void addCategory(String name,
                        String[] appenders)

setLogsRoot

public void setLogsRoot(String rootPath)

Sets a common path for all file appenders.

Parameters:

rootPath - The path to be used

write

public boolean write()