org.lsst.ccs.utilities.logging

Class Logger

java.lang.Object

org.lsst.ccs.utilities.logging.Logger

public class Logger
extends Object

Just a wrapper class around java.util.Logger to add specific logging methods. The instances are not cached (so better have only one per package)
Most methods allow "multi-dimensional" logging (log the same data to various loggers).
Many of those are intended to replace log4j invocations by just changing the import directives. The mapping from log4J Levels is operated this way

 finest -> finest
 trace -> finer
 debug-> fine
 info -> info
 warn -> warning
 error -> severe
 fatal -> severe
 

Logging methods that return a boolean can be used through assert calls (they always return true).

Do not use this Logger for admin purpose (setting a level, a Filter, a Formatter or a Handler): use the corresponding java.util.logging.Logger instead.

Author:

bamade

Field Summary

Fields

Modifier and Type	Field and Description
protected ScheduledExecutorService	executor scheduler for delayed logs

Method Summary

Modifier and Type	Method and Description
LogRecord	createLogRecord(Level level, String message) creates a simple log record.
boolean	debug(Object message)
boolean	debug(Object message, String... concerns) Deprecated.
void	debug(Object message, Throwable throwable)
void	debug(Object message, Throwable throwable, String... concerns) Deprecated.
boolean	decoupledLog(long delay, Level level, String message, Object argument)
boolean	decoupledLog(long delay, Level level, String message, Object[] arguments)
boolean	decoupledLog(long delay, Level level, String message, Object[] arguments, String... concerns) Deprecated.
boolean	decoupledLog(long delay, Level level, String message, Object argument, String... concerns) Deprecated.
void	decoupledLog(long delay, Level level, String message, Throwable throwable)
void	decoupledLog(long delay, Level level, String message, Throwable throwable, String... concerns) Deprecated.
void	decoupledLog(long delay, LogRecord record)
void	decoupledLog(long delay, LogRecord record, String... concerns) Deprecated.
void	error(Object message)
void	error(Object message, String... concerns) Deprecated.
void	error(Object message, Throwable throwable)
void	error(Object message, Throwable throwable, String... concerns) Deprecated.
void	fatal(Object message)
void	fatal(Object message, String... concerns) Deprecated.
void	fatal(Object message, Throwable throwable)
void	fatal(Object message, Throwable throwable, String... concerns) Deprecated.
boolean	fine(Object message)
boolean	fine(Object message, String... concerns) Deprecated.
boolean	finer(Object message)
boolean	finer(Object message, String... concerns) Deprecated.
boolean	finest(Object message)
boolean	finest(Object message, String... concerns) Deprecated.
Level	getLevel()
static Logger	getLogger(String name) factory method to obtain a Logger proxy.
static Logger	getLogger(String name, String resourceBundleName) factory method to obtain a Logger proxy.
String	getName()
protected Logger	getParent()
boolean	info(Object message)
boolean	info(Object message, String... concerns) Deprecated.
void	info(Object message, Throwable throwable)
void	info(Object message, Throwable throwable, String... concerns) Deprecated.
boolean	isDebugEnabled() tells if the FINE level is activated for the corresponding JUL Logger.
boolean	isInfoEnabled() tells if the INFO level is activated for the corresponding JUL Logger.
boolean	isLoggable(Level level) tells if the corresponding JUL level is activated for the corresponding JUL Logger.
boolean	log(Level level, String message, Object argument)
boolean	log(Level level, String message, Object[] arguments)
boolean	log(Level level, String message, Object[] arguments, String... concerns) Deprecated.
boolean	log(Level level, String message, Object argument, String... concerns) Deprecated.
void	log(Level level, String message, Throwable throwable)
void	log(Level level, String message, Throwable throwable, String... concerns) Deprecated.
void	log(LogRecord record)
void	log(LogRecord record, String... concerns) Deprecated.
protected boolean	logMessage(Level level, Object message)
protected boolean	logMessage(Level level, Object message, String... concerns) Deprecated. use logMessage(Level level, Object message) instead
protected void	logSimpleThrowable(Level level, Object message, Throwable throwable)
protected void	logSimpleThrowable(Level level, Object message, Throwable throwable, String... concerns) Deprecated.
void	setLevel(Level level)
void	severe(Object message)
void	severe(Object message, String... concerns) Deprecated.
void	severe(Object message, Throwable throwable)
void	severe(Object message, Throwable throwable, String... concerns) Deprecated.
void	throwing(String sourceClass, String sourceMethod, Throwable throwable) invokes the throwing method on the corresponding JUL logger.
boolean	trace(Object message)
boolean	trace(Object message, String... concerns) Deprecated.
boolean	warn(Object message)
boolean	warn(Object message, String... concerns) Deprecated.
void	warn(Object message, Throwable throwable)
void	warn(Object message, Throwable throwable, String... concerns) Deprecated.
boolean	warning(Object message)
boolean	warning(Object message, String... concerns) Deprecated.
void	warning(Object message, Throwable throwable)
void	warning(Object message, Throwable throwable, String... concerns) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

executor

protected ScheduledExecutorService executor

scheduler for delayed logs

Method Detail

getLogger

public static Logger getLogger(String name)

factory method to obtain a Logger proxy.

Parameters:

name - usually a package name (top of hierarchy is "" empty String)

Returns:

getLogger

public static Logger getLogger(String name,
                               String resourceBundleName)

factory method to obtain a Logger proxy.

Parameters:

name - usually a package name (top of hierarchy is "" empty String)

resourceBundleName -

Returns:

getName

public String getName()

Returns:

the name of the Logger

getLevel

public Level getLevel()

Returns:

the level of the associated JUL logger

setLevel

public void setLevel(Level level)

getParent

protected Logger getParent()

Returns:

the parent of the associated JUL logger

createLogRecord

public LogRecord createLogRecord(Level level,
                                 String message)

creates a simple log record. This factory manipulates the caller information (className, method Name) by getting rid of any information coming from a package that contains "logging" (or "log4j").
note that the LogRecord is automatically marked with a sequenceNumber that can be used by Handlers that want to detect duplicate publications.

Parameters:

level - JUL Level

message - (avoid null values)

Returns:

a simple LogRecord

logMessage

@Deprecated
protected boolean logMessage(Level level,
                                         Object message,
                                         String... concerns)

Deprecated. use logMessage(Level level, Object message) instead

utility method to log a message with a Level

Parameters:

level - JUL level

message - (avoid null values)

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

Returns:

true

logMessage

protected boolean logMessage(Level level,
                             Object message)

finest

@Deprecated
public boolean finest(Object message,
                                  String... concerns)

Deprecated.

logs a message at FINEST level

Parameters:

message -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

Returns:

true

finest

public boolean finest(Object message)

trace

@Deprecated
public boolean trace(Object message,
                                 String... concerns)

Deprecated.

logs a message at FINER level

Parameters:

message -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

Returns:

true

trace

public boolean trace(Object message)

finer

@Deprecated
public boolean finer(Object message,
                                 String... concerns)

Deprecated.

logs a message at FINER level

Parameters:

message -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

Returns:

true

finer

public boolean finer(Object message)

debug

@Deprecated
public boolean debug(Object message,
                                 String... concerns)

Deprecated.

logs a message at FINE Level

Parameters:

message -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

Returns:

true

debug

public boolean debug(Object message)

fine

@Deprecated
public boolean fine(Object message,
                                String... concerns)

Deprecated.

logs a message at FINE Level

Parameters:

message -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

Returns:

true

fine

public boolean fine(Object message)

info

@Deprecated
public boolean info(Object message,
                                String... concerns)

Deprecated.

logs a message at INFO Level

Parameters:

message -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

Returns:

true

info

public boolean info(Object message)

warn

@Deprecated
public boolean warn(Object message,
                                String... concerns)

Deprecated.

logs a message at WARNING Level

Parameters:

message -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

Returns:

true

warn

public boolean warn(Object message)

warning

@Deprecated
public boolean warning(Object message,
                                   String... concerns)

Deprecated.

logs a message at WARNING Level

Parameters:

message -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

Returns:

true

warning

public boolean warning(Object message)

error

@Deprecated
public void error(Object message,
                              String... concerns)

Deprecated.

logs a message at SEVERE Level (use preferably the error method that uses a Throwable parameter)

Parameters:

message -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

error

public void error(Object message)

fatal

@Deprecated
public void fatal(Object message,
                              String... concerns)

Deprecated.

logs a message at SEVERE Level (use preferably the fatal method that uses a Throwable parameter)

Parameters:

message -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

fatal

public void fatal(Object message)

severe

@Deprecated
public void severe(Object message,
                               String... concerns)

Deprecated.

logs a message at SEVERE Level (use preferably the severe method that uses a Throwable parameter)

Parameters:

message -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

severe

public void severe(Object message)

isDebugEnabled

public boolean isDebugEnabled()

tells if the FINE level is activated for the corresponding JUL Logger. (to be used if a subsequent logging call is costly)

Returns:

isInfoEnabled

public boolean isInfoEnabled()

tells if the INFO level is activated for the corresponding JUL Logger. (to be used if a subsequent logging call is costly)

Returns:

logSimpleThrowable

@Deprecated
protected void logSimpleThrowable(Level level,
                                              Object message,
                                              Throwable throwable,
                                              String... concerns)

Deprecated.

utility method to forward a Throwable and a message to the loggers.

Parameters:

level - JUL level

message -

throwable -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

logSimpleThrowable

protected void logSimpleThrowable(Level level,
                                  Object message,
                                  Throwable throwable)

fatal

@Deprecated
public void fatal(Object message,
                              Throwable throwable,
                              String... concerns)

Deprecated.

logs a message at SEVERE Level

Parameters:

message -

throwable -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

fatal

public void fatal(Object message,
                  Throwable throwable)

severe

@Deprecated
public void severe(Object message,
                               Throwable throwable,
                               String... concerns)

Deprecated.

logs a message at SEVERE Level

Parameters:

message -

throwable -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

severe

public void severe(Object message,
                   Throwable throwable)

error

@Deprecated
public void error(Object message,
                              Throwable throwable,
                              String... concerns)

Deprecated.

logs a message at SEVERE Level

Parameters:

message -

throwable -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

error

public void error(Object message,
                  Throwable throwable)

warn

@Deprecated
public void warn(Object message,
                             Throwable throwable,
                             String... concerns)

Deprecated.

logs a message at WARNING Level

Parameters:

message -

throwable -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

warn

public void warn(Object message,
                 Throwable throwable)

warning

@Deprecated
public void warning(Object message,
                                Throwable throwable,
                                String... concerns)

Deprecated.

logs a message at WARNING Level

Parameters:

message -

throwable -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

warning

public void warning(Object message,
                    Throwable throwable)

throwing

public void throwing(String sourceClass,
                     String sourceMethod,
                     Throwable throwable)

invokes the throwing method on the corresponding JUL logger.

Parameters:

sourceClass -

sourceMethod -

throwable -

info

@Deprecated
public void info(Object message,
                             Throwable throwable,
                             String... concerns)

Deprecated.

logs a message at INFO Level

Parameters:

message -

throwable -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

info

public void info(Object message,
                 Throwable throwable)

debug

@Deprecated
public void debug(Object message,
                              Throwable throwable,
                              String... concerns)

Deprecated.

logs a message at FINE Level

Parameters:

message -

throwable -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

debug

public void debug(Object message,
                  Throwable throwable)

isLoggable

public boolean isLoggable(Level level)

tells if the corresponding JUL level is activated for the corresponding JUL Logger. (to be used if a subsequent logging call is costly)

Returns:

log

@Deprecated
public void log(LogRecord record,
                            String... concerns)

Deprecated.

utility method to send a LogRecord to the corresponding JUL logger and to a list of other loggers.

Parameters:

record - (should be created with the createLogRecord factory :otherwise stack information will be wrong)

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

log

public void log(LogRecord record)

decoupledLog

@Deprecated
public void decoupledLog(long delay,
                                     LogRecord record,
                                     String... concerns)

Deprecated.

same method as log(LogRecord, String... concerns but executed in a different Thread.
this might be interesting when the Thread that logs should be different from the Thread that handles the LogRecord

Parameters:

delay - in millis

record -

concerns -

decoupledLog

public void decoupledLog(long delay,
                         LogRecord record)

log

@Deprecated
public boolean log(Level level,
                               String message,
                               Object argument,
                               String... concerns)

Deprecated.

does the same as the equivalent standard JUL method but forwards also to other Loggers.

Parameters:

level - JUL level

message -

argument -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

Returns:

true

log

public boolean log(Level level,
                   String message,
                   Object argument)

decoupledLog

@Deprecated
public boolean decoupledLog(long delay,
                                        Level level,
                                        String message,
                                        Object argument,
                                        String... concerns)

Deprecated.

same method as public boolean log(Level level, String message, Object argument, String... concerns) but executed in a different Thread.
this might be interesting when the Thread that logs should be different from the Thread that handles the LogRecord

Parameters:

delay - in Milliseconds

level -

message -

argument -

concerns -

Returns:

decoupledLog

public boolean decoupledLog(long delay,
                            Level level,
                            String message,
                            Object argument)

log

@Deprecated
public boolean log(Level level,
                               String message,
                               Object[] arguments,
                               String... concerns)

Deprecated.

does the same as the equivalent standard JUL method but forwards also to other Loggers.

Parameters:

level - JUL level

message -

arguments -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

Returns:

true

log

public boolean log(Level level,
                   String message,
                   Object[] arguments)

decoupledLog

@Deprecated
public boolean decoupledLog(long delay,
                                        Level level,
                                        String message,
                                        Object[] arguments,
                                        String... concerns)

Deprecated.

does the same as the corresponding log method but executed in a different Thread.
this might be interesting when the Thread that logs should be different from the Thread that handles the LogRecord

Parameters:

delay - in millis

level -

message -

arguments -

concerns -

Returns:

decoupledLog

public boolean decoupledLog(long delay,
                            Level level,
                            String message,
                            Object[] arguments)

log

@Deprecated
public void log(Level level,
                            String message,
                            Throwable throwable,
                            String... concerns)

Deprecated.

does the same as the equivalent standard JUL method but forwards also to other Loggers.

Parameters:

level - JUL level

message -

throwable -

concerns - a list of additional JUL loggers name (such as "INIT", "CONFIG" ,...)

log

public void log(Level level,
                String message,
                Throwable throwable)

decoupledLog

@Deprecated
public void decoupledLog(long delay,
                                     Level level,
                                     String message,
                                     Throwable throwable,
                                     String... concerns)

Deprecated.

does the same as the corresponding log method but executed in a different Thread.
this might be interesting when the Thread that logs should be different from the Thread that handles the LogRecord

Parameters:

delay - in millis

level -

message -

throwable -

concerns -

decoupledLog

public void decoupledLog(long delay,
                         Level level,
                         String message,
                         Throwable throwable)