org.lsst.ccs.utilities.logging

Class LogPropertiesLoader

java.lang.Object

org.lsst.ccs.utilities.logging.LogPropertiesLoader

public class LogPropertiesLoader
extends Object

The role of this class is:

• to read the logging.properties and offer other codes (namely handlers) access to the properties described (a thing not permitted by the standard logManager)
• to be sure that the Handlers are lazily loaded (the standard LogManager may not be able to load the Handlers class due to ClassLoading problems)
• to delegate informations to the LogManager so it can behave properly (e.g. transmit logging properties, register Loggers) /UL>

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOG_CONF_FILE if the property to define a config file is set then the corresponding file is used for properties otherwise it is "LOG_PROPS"
static String	LOG_PROPS

Constructor Summary

Constructors

Constructor and Description
LogPropertiesLoader()

Method Summary

Modifier and Type	Method and Description
protected void	configureHandler(String handlerName, Handler handler) should set level, formatter, filter
boolean	getBooleanProperty(String name, boolean defaultValue)
Filter	getFilterProperty(String name, Filter defaultValue)
Formatter	getFormatterProperty(String name, Formatter defaultValue)
int	getIntProperty(String name, int defaultValue)
Level	getLevelProperty(String name, Level defaultValue)
String	getProperty(String property)
String	getStringProperty(String name, String defaultValue)
static Optional<LogManager>	getSystemLoaderLogManager() this method guarantees that the LogProperties Loader has been initialized (in the context of the current ClassLoader)
protected void	handlersLazyLoad() initialize the Handlers that are in the current ClassLoader the "top" manager may not have access to the Handlers classes.
static Formatter	loaderGetFormatterProperty(String name, Formatter defaultValue)
static int	loaderGetIntProperty(String name, int defaultValue)
static Level	loaderGetLevelProperty(String name, Level defaultValue)
static String	loaderGetProperty(String name)
static String	loaderGetStringProperty(String name, String defaultValue)
protected void	loadLoggerHandlers(String loggerName, Logger logger) add Handlers to a Logger known to the LogManager.
protected String	replace(String str, Properties props) System property replacement in the given string.

Methods inherited from class java.lang.Object

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

Field Detail

LOG_PROPS

public static final String LOG_PROPS

See Also:

Constant Field Values

LOG_CONF_FILE

public static final String LOG_CONF_FILE

if the property to define a config file is set then the corresponding file is used for properties otherwise it is "LOG_PROPS"

Constructor Detail

LogPropertiesLoader

public LogPropertiesLoader()

Method Detail

getSystemLoaderLogManager

public static Optional<LogManager> getSystemLoaderLogManager()

this method guarantees that the LogProperties Loader has been initialized (in the context of the current ClassLoader)

Returns:

//TODO: returning an Optional object is pointless : change!

handlersLazyLoad

protected void handlersLazyLoad()
                         throws IOException

initialize the Handlers that are in the current ClassLoader the "top" manager may not have access to the Handlers classes. this method should be called only once.

Throws:

IOException

loadLoggerHandlers

protected void loadLoggerHandlers(String loggerName,
                                  Logger logger)
                           throws IOException

add Handlers to a Logger known to the LogManager.

Parameters:

loggerName -

logger -

Throws:

IOException

configureHandler

protected void configureHandler(String handlerName,
                                Handler handler)

should set level, formatter, filter

Parameters:

handlerName -

handler -

replace

protected String replace(String str,
                         Properties props)

System property replacement in the given string.

Parameters:

str - The original string

Returns:

the modified string

loaderGetProperty

public static String loaderGetProperty(String name)

loaderGetStringProperty

public static String loaderGetStringProperty(String name,
                                             String defaultValue)

loaderGetIntProperty

public static int loaderGetIntProperty(String name,
                                       int defaultValue)

loaderGetLevelProperty

public static Level loaderGetLevelProperty(String name,
                                           Level defaultValue)

loaderGetFormatterProperty

public static Formatter loaderGetFormatterProperty(String name,
                                                   Formatter defaultValue)

getProperty

public String getProperty(String property)

getStringProperty

public String getStringProperty(String name,
                                String defaultValue)

getIntProperty

public int getIntProperty(String name,
                          int defaultValue)

getBooleanProperty

public boolean getBooleanProperty(String name,
                                  boolean defaultValue)

getLevelProperty

public Level getLevelProperty(String name,
                              Level defaultValue)

getFilterProperty

public Filter getFilterProperty(String name,
                                Filter defaultValue)

getFormatterProperty

public Formatter getFormatterProperty(String name,
                                      Formatter defaultValue)