org.lsst.ccs.utilities.logging

Class ContextLogManager

java.lang.Object

java.util.logging.LogManager

org.lsst.ccs.utilities.logging.ContextLogManager

public class ContextLogManager
extends LogManager

Per classloader LogManager implementation. (experiment copied from Apache Juli ... with modifications) TODO: bug :handlers are lost! FIX!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ContextLogManager.ClassLoaderLogInfo
protected static class	ContextLogManager.LogNode
protected class	ContextLogManager.RootLogger This class is needed to instantiate the root of each per classloader hierarchy.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<ClassLoader,ContextLogManager.ClassLoaderLogInfo>	classLoaderLoggers Map containing the classloader information, keyed per classloader.
static String	LOG_CONF_FILE
static String	LOG_PROPS
protected ThreadLocal<String>	prefix This prefix is used to allow using prefixes for the properties names of handlers and their subcomponents.
protected boolean	useShutdownHook Determines if the shutdown hook is used to perform any necessary clean-up such as flushing buffered handlers on JVM shutdown.

Fields inherited from class java.util.logging.LogManager

LOGGING_MXBEAN_NAME

Constructor Summary

Constructors

Constructor and Description
ContextLogManager()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addLogger(Logger logger) Add the specified logger to the classloader local configuration.
protected void	configureHandler(String handlerName, Handler handler) should set level, formatter, filter
protected static void	doSetParentLogger(Logger logger, Logger parent) Set parent child relationship between the two specified loggers.
boolean	getBooleanProperty(String name, boolean defaultValue)
protected ContextLogManager.ClassLoaderLogInfo	getClassLoaderInfo(ClassLoader classLoader) Retrieve the configuration associated with the specified classloader.
Filter	getFilterProperty(String name, Filter defaultValue)
Formatter	getFormatterProperty(String name, Formatter defaultValue)
int	getIntProperty(String name, int defaultValue)
Level	getLevelProperty(String name, Level defaultValue)
Logger	getLogger(String name) Get the logger associated with the specified name inside the classloader local configuration.
Enumeration<String>	getLoggerNames() Get an enumeration of the logger names currently defined in the classloader local configuration.
String	getProperty(String name) Get the value of the specified property in the classloader local configuration.
String	getStringProperty(String name, String defaultValue)
static Optional<LogManager>	getSystemLoaderLogManager()
boolean	isUseShutdownHook()
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)
void	readConfiguration()
protected void	readConfiguration(ClassLoader classLoader) Read configuration for the specified classloader.
void	readConfiguration(Properties properties)
protected void	readConfiguration(Properties properties, ClassLoader classLoader) Load specified configuration.
protected String	replace(String str, Properties props) System property replacement in the given string.
void	reset()
void	setUseShutdownHook(boolean useShutdownHook)
void	shutdown() Shuts down the logging system.

Methods inherited from class java.util.logging.LogManager

addPropertyChangeListener, checkAccess, getLoggingMXBean, getLogManager, readConfiguration, removePropertyChangeListener

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

classLoaderLoggers

protected final Map<ClassLoader,ContextLogManager.ClassLoaderLogInfo> classLoaderLoggers

Map containing the classloader information, keyed per classloader. A weak hashmap is used to ensure no classloader reference is leaked from application redeployment.

prefix

protected ThreadLocal<String> prefix

This prefix is used to allow using prefixes for the properties names of handlers and their subcomponents.

useShutdownHook

protected volatile boolean useShutdownHook

Determines if the shutdown hook is used to perform any necessary clean-up such as flushing buffered handlers on JVM shutdown. Defaults to true but may be set to false if another component ensures that shutdown() is called.

Constructor Detail

ContextLogManager

public ContextLogManager()

Method Detail

getSystemLoaderLogManager

public static Optional<LogManager> getSystemLoaderLogManager()

isUseShutdownHook

public boolean isUseShutdownHook()

setUseShutdownHook

public void setUseShutdownHook(boolean useShutdownHook)

addLogger

public boolean addLogger(Logger logger)

Add the specified logger to the classloader local configuration.

Overrides:

addLogger in class LogManager

Parameters:

logger - The logger to be added

getLogger

public Logger getLogger(String name)

Get the logger associated with the specified name inside the classloader local configuration. If this returns null, and the call originated for Logger.getLogger, a new logger with the specified name will be instantiated and added using addLogger.

Overrides:

getLogger in class LogManager

Parameters:

name - The name of the logger to retrieve

getLoggerNames

public Enumeration<String> getLoggerNames()

Get an enumeration of the logger names currently defined in the classloader local configuration.

Overrides:

getLoggerNames in class LogManager

getProperty

public String getProperty(String name)

Get the value of the specified property in the classloader local configuration.

Overrides:

getProperty in class LogManager

Parameters:

name - The property name

loaderGetProperty

public static String loaderGetProperty(String name)

getStringProperty

public String getStringProperty(String name,
                       String defaultValue)

loaderGetStringProperty

public static String loaderGetStringProperty(String name,
                             String defaultValue)

getIntProperty

public int getIntProperty(String name,
                 int defaultValue)

loaderGetIntProperty

public static int loaderGetIntProperty(String name,
                       int defaultValue)

getBooleanProperty

public boolean getBooleanProperty(String name,
                         boolean defaultValue)

getLevelProperty

public Level getLevelProperty(String name,
                     Level defaultValue)

loaderGetLevelProperty

public static Level loaderGetLevelProperty(String name,
                           Level defaultValue)

getFilterProperty

public Filter getFilterProperty(String name,
                       Filter defaultValue)

getFormatterProperty

public Formatter getFormatterProperty(String name,
                             Formatter defaultValue)

loaderGetFormatterProperty

public static Formatter loaderGetFormatterProperty(String name,
                                   Formatter defaultValue)

readConfiguration

public void readConfiguration()
                       throws IOException,
                              SecurityException

Overrides:

readConfiguration in class LogManager

Throws:

IOException

SecurityException

readConfiguration

public void readConfiguration(Properties properties)
                       throws IOException,
                              SecurityException

Throws:

IOException

SecurityException

reset

public void reset()
           throws SecurityException

Overrides:

reset in class LogManager

Throws:

SecurityException

shutdown

public void shutdown()

Shuts down the logging system.

getClassLoaderInfo

protected ContextLogManager.ClassLoaderLogInfo getClassLoaderInfo(ClassLoader classLoader)

Retrieve the configuration associated with the specified classloader. If it does not exist, it will be created.

Parameters:

classLoader - The classloader for which we will retrieve or build the configuration

readConfiguration

protected void readConfiguration(ClassLoader classLoader)
                          throws IOException

Read configuration for the specified classloader.

Parameters:

classLoader -

Throws:

IOException - Errot

readConfiguration

protected void readConfiguration(Properties properties,
                     ClassLoader classLoader)
                          throws IOException

Load specified configuration.

Parameters:

is - InputStream to the properties file

classLoader - for which the configuration will be loaded

Throws:

IOException - If something wrong happens during loading

configureHandler

protected void configureHandler(String handlerName,
                    Handler handler)

should set level, formatter, filter

Parameters:

handlerName -

handler -

doSetParentLogger

protected static void doSetParentLogger(Logger logger,
                     Logger parent)

Set parent child relationship between the two specified loggers.

Parameters:

logger -

parent -

replace

protected String replace(String str,
             Properties props)

System property replacement in the given string.

Parameters:

str - The original string

Returns:

the modified string