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

instance of this class should be built only during load time. That is: when java.util.logging.manager property is set to the name of this class, or by call of LogManagement load time in a ClassLoader.

• When the class is instanciated as the default LogManager the properties that are read from "logging.properties" should be modified and passed to the super-class, but the Handlers must not be created at this stage (otherwise NullPointerException will ensue)
If the class is not the defaultLogManager then the default log Manager should be reinitialized with the modified Properties.

The Big Problem is the lazy initialization of Handlers (HandlersN are subsistued to the standard "handler" property)

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOG_CONF_FILE
static String	LOG_PROPS
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 local configuration.
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)
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()
protected void	handlersLazyLoad()
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)
static void	loaderLazyLoadHandler()
protected void	loadLoggerHandlers(String loggerName, Logger logger)
protected String	replace(String str, Properties props) System property replacement in the given string.
void	setUseShutdownHook(boolean useShutdownHook)
void	shutdown() Shuts down the logging system.

Methods inherited from class java.util.logging.LogManager

addPropertyChangeListener, checkAccess, getLogger, getLoggingMXBean, getLogManager, readConfiguration, readConfiguration, removePropertyChangeListener, reset

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

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()

loaderLazyLoadHandler

public static void loaderLazyLoadHandler()

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)

isUseShutdownHook

public boolean isUseShutdownHook()

setUseShutdownHook

public void setUseShutdownHook(boolean useShutdownHook)

addLogger

public boolean addLogger(Logger logger)

Add the specified logger to the local configuration.

Overrides:

addLogger in class LogManager

Parameters:

logger - The logger to be added

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

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)

shutdown

public void shutdown()

Shuts down the logging system.

handlersLazyLoad

protected void handlersLazyLoad()
                         throws IOException

Throws:

IOException

loadLoggerHandlers

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

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