de.opsdesign.yax.log
Class CommonsAdapter

java.lang.Object
  de.opsdesign.yax.log.LogBuilder
      de.opsdesign.yax.log.CommonsAdapter

All Implemented Interfaces:

Loggable, java.io.Serializable, org.apache.commons.logging.Log

public class CommonsAdapter
extends LogBuilder
implements org.apache.commons.logging.Log, java.io.Serializable

See Also:

Serialized Form

Field Summary

protected int	currentLogLevel The current log level
protected static java.text.DateFormat	dateFormatter Used to format times
protected static java.lang.String	dateTimeFormat The date and time format to use in the log message
protected static java.lang.String	DEFAULT_DATE_TIME_FORMAT The default format to use when formating dates
static int	LOG_LEVEL_ALL Enable all logging levels
static int	LOG_LEVEL_DEBUG "Debug" level logging.
static int	LOG_LEVEL_ERROR "Error" level logging.
static int	LOG_LEVEL_FATAL "Fatal" level logging.
static int	LOG_LEVEL_INFO "Info" level logging.
static int	LOG_LEVEL_OFF Enable no logging levels
static int	LOG_LEVEL_TRACE "Trace" level logging.
static int	LOG_LEVEL_WARN "Warn" level logging.
protected java.lang.String	logName The name of this simple log instance
protected static boolean	showDateTime Include the current time in the log message
protected static boolean	showLogName Include the instance name in the log message?
protected static boolean	showShortName Include the short name ( last component ) of the logger in the log message.
protected static java.util.Properties	simpleLogProps Properties loaded from simplelog.properties
protected static java.lang.String	systemPrefix All system properties used by SimpleLog start with this

Constructor Summary

CommonsAdapter(java.lang.String name)
Construct a simple log with given name.

Method Summary

void	debug(java.lang.Object message) Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_DEBUG.
void	debug(java.lang.Object message, java.lang.Throwable t) Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_DEBUG.
void	error(java.lang.Object message) Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_ERROR.
void	error(java.lang.Object message, java.lang.Throwable t) Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_ERROR.
void	fatal(java.lang.Object message) Log a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_FATAL.
void	fatal(java.lang.Object message, java.lang.Throwable t) Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_FATAL.
int	getLevel() Get logging level.
java.lang.String	getLogMessage(java.lang.Object message)
java.lang.String	getLogName()
void	info(java.lang.Object message) Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_INFO.
void	info(java.lang.Object message, java.lang.Throwable t) Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_INFO.
boolean	isDebugEnabled() Are debug messages currently enabled?
boolean	isErrorEnabled() Are error messages currently enabled?
boolean	isFatalEnabled() Are fatal messages currently enabled?
boolean	isInfoEnabled() Are info messages currently enabled?
protected boolean	isLevelEnabled(int logLevel) Is the given log level currently enabled?
boolean	isTraceEnabled() Are trace messages currently enabled?
boolean	isWarnEnabled() Are warn messages currently enabled?
int	mapLevelCommonsToLog4j(int source)
int	mapLevelLog4jToCommons(int source)
void	setLevel(int currentLogLevel) Set logging level.
void	setLogName(java.lang.String logName)
void	trace(java.lang.Object message) Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_TRACE.
void	trace(java.lang.Object message, java.lang.Throwable t) Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_TRACE.
void	warn(java.lang.Object message) Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_WARN.
void	warn(java.lang.Object message, java.lang.Throwable t) Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_WARN.

Methods inherited from class de.opsdesign.yax.log.LogBuilder

log, log, log, log

Methods inherited from class java.lang.Object

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

Field Detail

systemPrefix

protected static final java.lang.String systemPrefix

All system properties used by SimpleLog start with this

See Also:

Constant Field Values

simpleLogProps

protected static final java.util.Properties simpleLogProps

Properties loaded from simplelog.properties

DEFAULT_DATE_TIME_FORMAT

protected static final java.lang.String DEFAULT_DATE_TIME_FORMAT

The default format to use when formating dates

See Also:

Constant Field Values

showLogName

protected static boolean showLogName

Include the instance name in the log message?

showShortName

protected static boolean showShortName

Include the short name ( last component ) of the logger in the log message. Defaults to true - otherwise we'll be lost in a flood of messages without knowing who sends them.

showDateTime

protected static boolean showDateTime

Include the current time in the log message

dateTimeFormat

protected static java.lang.String dateTimeFormat

The date and time format to use in the log message

dateFormatter

protected static java.text.DateFormat dateFormatter

Used to format times

LOG_LEVEL_TRACE

public static final int LOG_LEVEL_TRACE

"Trace" level logging.

See Also:

Constant Field Values

LOG_LEVEL_DEBUG

public static final int LOG_LEVEL_DEBUG

"Debug" level logging.

See Also:

Constant Field Values

LOG_LEVEL_INFO

public static final int LOG_LEVEL_INFO

"Info" level logging.

See Also:

Constant Field Values

LOG_LEVEL_WARN

public static final int LOG_LEVEL_WARN

"Warn" level logging.

See Also:

Constant Field Values

LOG_LEVEL_ERROR

public static final int LOG_LEVEL_ERROR

"Error" level logging.

See Also:

Constant Field Values

LOG_LEVEL_FATAL

public static final int LOG_LEVEL_FATAL

"Fatal" level logging.

See Also:

Constant Field Values

LOG_LEVEL_ALL

public static final int LOG_LEVEL_ALL

Enable all logging levels

See Also:

Constant Field Values

LOG_LEVEL_OFF

public static final int LOG_LEVEL_OFF

Enable no logging levels

See Also:

Constant Field Values

logName

protected java.lang.String logName

The name of this simple log instance

currentLogLevel

protected int currentLogLevel

The current log level

Constructor Detail

CommonsAdapter

public CommonsAdapter(java.lang.String name)

Construct a simple log with given name.

Parameters:

name - log name

Method Detail

setLevel

public void setLevel(int currentLogLevel)

Set logging level.

Parameters:

currentLogLevel - new logging level

getLevel

public int getLevel()

Get logging level.

getLogMessage

public java.lang.String getLogMessage(java.lang.Object message)

isLevelEnabled

protected boolean isLevelEnabled(int logLevel)

Is the given log level currently enabled?

Parameters:

logLevel - is this level enabled?

mapLevelCommonsToLog4j

public int mapLevelCommonsToLog4j(int source)

mapLevelLog4jToCommons

public int mapLevelLog4jToCommons(int source)

debug

public final void debug(java.lang.Object message)

Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_DEBUG.

Specified by:

debug in interface org.apache.commons.logging.Log

Parameters:

message - to log

See Also:

Log.debug(Object)

debug

public final void debug(java.lang.Object message,
                        java.lang.Throwable t)

Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_DEBUG.

Specified by:

debug in interface org.apache.commons.logging.Log

Parameters:

message - to log

t - log this cause

See Also:

Log.debug(Object, Throwable)

trace

public final void trace(java.lang.Object message)

Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_TRACE.

Specified by:

trace in interface org.apache.commons.logging.Log

Parameters:

message - to log

See Also:

Log.trace(Object)

trace

public final void trace(java.lang.Object message,
                        java.lang.Throwable t)

Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_TRACE.

Specified by:

trace in interface org.apache.commons.logging.Log

Parameters:

message - to log

t - log this cause

See Also:

Log.trace(Object, Throwable)

info

public final void info(java.lang.Object message)

Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_INFO.

Specified by:

info in interface org.apache.commons.logging.Log

Parameters:

message - to log

See Also:

Log.info(Object)

info

public final void info(java.lang.Object message,
                       java.lang.Throwable t)

Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_INFO.

Specified by:

info in interface org.apache.commons.logging.Log

Parameters:

message - to log

t - log this cause

See Also:

Log.info(Object, Throwable)

warn

public final void warn(java.lang.Object message)

Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_WARN.

Specified by:

warn in interface org.apache.commons.logging.Log

Parameters:

message - to log

See Also:

Log.warn(Object)

warn

public final void warn(java.lang.Object message,
                       java.lang.Throwable t)

Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_WARN.

Specified by:

warn in interface org.apache.commons.logging.Log

Parameters:

message - to log

t - log this cause

See Also:

Log.warn(Object, Throwable)

error

public final void error(java.lang.Object message)

Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_ERROR.

Specified by:

error in interface org.apache.commons.logging.Log

Parameters:

message - to log

See Also:

Log.error(Object)

error

public final void error(java.lang.Object message,
                        java.lang.Throwable t)

Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_ERROR.

Specified by:

error in interface org.apache.commons.logging.Log

Parameters:

message - to log

t - log this cause

See Also:

Log.error(Object, Throwable)

fatal

public final void fatal(java.lang.Object message)

Log a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_FATAL.

Specified by:

fatal in interface org.apache.commons.logging.Log

Parameters:

message - to log

See Also:

Log.fatal(Object)

fatal

public final void fatal(java.lang.Object message,
                        java.lang.Throwable t)

Logs a message with org.apache.commons.logging.impl.SimpleLog.LOG_LEVEL_FATAL.

Specified by:

fatal in interface org.apache.commons.logging.Log

Parameters:

message - to log

t - log this cause

See Also:

Log.fatal(Object, Throwable)

isDebugEnabled

public final boolean isDebugEnabled()

Are debug messages currently enabled?

This allows expensive operations such as String concatenation to be avoided when the message will be ignored by the logger.

Specified by:

isDebugEnabled in interface org.apache.commons.logging.Log

isErrorEnabled

public final boolean isErrorEnabled()

Are error messages currently enabled?

This allows expensive operations such as String concatenation to be avoided when the message will be ignored by the logger.

Specified by:

isErrorEnabled in interface org.apache.commons.logging.Log

isFatalEnabled

public final boolean isFatalEnabled()

Are fatal messages currently enabled?

This allows expensive operations such as String concatenation to be avoided when the message will be ignored by the logger.

Specified by:

isFatalEnabled in interface org.apache.commons.logging.Log

isInfoEnabled

public final boolean isInfoEnabled()

Are info messages currently enabled?

This allows expensive operations such as String concatenation to be avoided when the message will be ignored by the logger.

Specified by:

isInfoEnabled in interface org.apache.commons.logging.Log

isTraceEnabled

public final boolean isTraceEnabled()

Are trace messages currently enabled?

This allows expensive operations such as String concatenation to be avoided when the message will be ignored by the logger.

Specified by:

isTraceEnabled in interface org.apache.commons.logging.Log

isWarnEnabled

public final boolean isWarnEnabled()

Are warn messages currently enabled?

This allows expensive operations such as String concatenation to be avoided when the message will be ignored by the logger.

Specified by:

isWarnEnabled in interface org.apache.commons.logging.Log

getLogName

public java.lang.String getLogName()

setLogName

public void setLogName(java.lang.String logName)