org.apache.log

Class Logger


public class Logger
extends java.lang.Object

The object interacted with by client objects to perform logging.

Authors:
Avalon Development Team
Peter Donald

Field Summary

static char
CATEGORY_SEPARATOR
Separator character use to separate different categories

Method Summary

void
debug(String message)
Log a debug priority event.
void
debug(String message, Throwable throwable)
Log a debug priority event.
void
error(String message)
Log a error priority event.
void
error(String message, Throwable throwable)
Log a error priority event.
void
fatalError(String message)
Log a fatalError priority event.
void
fatalError(String message, Throwable throwable)
Log a fatalError priority event.
String
getCategory()
Deprecated. This method violates Inversion of Control principle.
Logger
getChildLogger(String subCategory)
Create a new child logger.
Logger[]
getChildren()
Get all the child Loggers of current logger.
LogTarget[]
getLogTargets()
Deprecated. This method is deprecated and will be removed in Future version.
Priority
getPriority()
Deprecated. This method violates Inversion of Control principle.
void
info(String message)
Log a info priority event.
void
info(String message, Throwable throwable)
Log a info priority event.
boolean
isDebugEnabled()
Determine if messages of priority DEBUG will be logged.
boolean
isErrorEnabled()
Determine if messages of priority ERROR will be logged.
boolean
isFatalErrorEnabled()
Determine if messages of priority FATAL_ERROR will be logged.
boolean
isInfoEnabled()
Determine if messages of priority INFO will be logged.
boolean
isPriorityEnabled(Priority priority)
Determine if messages of priority ?will be logged.
boolean
isWarnEnabled()
Determine if messages of priority WARN will be logged.
void
log(Priority priority, String message)
Log a event at specific priority with a certain message.
void
log(Priority priority, String message, Throwable throwable)
Log a event at specific priority with a certain message and throwable.
void
setAdditivity(boolean additivity)
Make this logger additive.
void
setLogTargets(LogTarget[] logTargets)
Set the log targets for this logger.
void
setPriority(Priority priority)
Set the priority for this logger.
void
unsetLogTargets()
Unset the logtargets for this logger.
void
unsetLogTargets(boolean recursive)
Unset the logtargets for this logger and all child loggers if recursive is set.
void
unsetPriority()
Unset the priority of Logger.
void
unsetPriority(boolean recursive)
Unset the priority of Logger.
void
warn(String message)
Log a warn priority event.
void
warn(String message, Throwable throwable)
Log a warn priority event.

Field Details

CATEGORY_SEPARATOR

public static final char CATEGORY_SEPARATOR
Separator character use to separate different categories

Method Details

debug

public final void debug(String message)
Log a debug priority event.

Parameters:
message - the message


debug

public final void debug(String message,
                        Throwable throwable)
Log a debug priority event.

Parameters:
message - the message
throwable - the throwable


error

public final void error(String message)
Log a error priority event.

Parameters:
message - the message


error

public final void error(String message,
                        Throwable throwable)
Log a error priority event.

Parameters:
message - the message
throwable - the throwable


fatalError

public final void fatalError(String message)
Log a fatalError priority event.

Parameters:
message - the message


fatalError

public final void fatalError(String message,
                             Throwable throwable)
Log a fatalError priority event.

Parameters:
message - the message
throwable - the throwable


getCategory

public final String getCategory()

Deprecated. This method violates Inversion of Control principle. If you are relying on its presence then there may be something wrong with the design of your system

Retrieve category associated with logger.

Returns:
the Category


getChildLogger

public Logger getChildLogger(String subCategory)
            throws IllegalArgumentException
Create a new child logger. The category of child logger is [current-category].subcategory

Parameters:
subCategory - the subcategory of this logger

Returns:
the new logger


getChildren

public Logger[] getChildren()
Get all the child Loggers of current logger.

Returns:
the child loggers


getLogTargets

public LogTarget[] getLogTargets()

Deprecated. This method is deprecated and will be removed in Future version. Previously it allowed unsafe access to logtargets which permitted masqurade attacks. It currently returns a zero sized array.

Get a copy of log targets for this logger.

Returns:
the child loggers


getPriority

public final Priority getPriority()

Deprecated. This method violates Inversion of Control principle. It will downgraded to protected access in a future release. When user needs to check priority it is advised that they use the is[Priority]Enabled() functions.

Retrieve priority associated with Logger.

Returns:
the loggers priority


info

public final void info(String message)
Log a info priority event.

Parameters:
message - the message


info

public final void info(String message,
                       Throwable throwable)
Log a info priority event.

Parameters:
message - the message
throwable - the throwable


isDebugEnabled

public final boolean isDebugEnabled()
Determine if messages of priority DEBUG will be logged.

Returns:
true if DEBUG messages will be logged


isErrorEnabled

public final boolean isErrorEnabled()
Determine if messages of priority ERROR will be logged.

Returns:
true if ERROR messages will be logged


isFatalErrorEnabled

public final boolean isFatalErrorEnabled()
Determine if messages of priority FATAL_ERROR will be logged.

Returns:
true if FATAL_ERROR messages will be logged


isInfoEnabled

public final boolean isInfoEnabled()
Determine if messages of priority INFO will be logged.

Returns:
true if INFO messages will be logged


isPriorityEnabled

public final boolean isPriorityEnabled(Priority priority)
Determine if messages of priority ?will be logged.

Parameters:
priority - the priority

Returns:
true if messages will be logged


isWarnEnabled

public final boolean isWarnEnabled()
Determine if messages of priority WARN will be logged.

Returns:
true if WARN messages will be logged


log

public final void log(Priority priority,
                      String message)
Log a event at specific priority with a certain message.

Parameters:
priority - the priority
message - the message


log

public final void log(Priority priority,
                      String message,
                      Throwable throwable)
Log a event at specific priority with a certain message and throwable.

Parameters:
priority - the priority
message - the message
throwable - the throwable


setAdditivity

public final void setAdditivity(boolean additivity)
Make this logger additive. I.e. Send all log events to parent loggers LogTargets regardless of whether or not the LogTargets have been overidden. This is derived from Log4js notion of Additivity.

Parameters:
additivity - true to make logger additive, false otherwise


setLogTargets

public void setLogTargets(LogTarget[] logTargets)
Set the log targets for this logger.

Parameters:
logTargets - the Log Targets


setPriority

public void setPriority(Priority priority)
Set the priority for this logger.

Parameters:
priority - the priority


unsetLogTargets

public void unsetLogTargets()
Unset the logtargets for this logger. This logger (and thus all child loggers who don't specify logtargets) will inherit from the parents LogTargets.


unsetLogTargets

public void unsetLogTargets(boolean recursive)
Unset the logtargets for this logger and all child loggers if recursive is set. The loggers unset (and all child loggers who don't specify logtargets) will inherit from the parents LogTargets.

Parameters:
recursive - the recursion policy


unsetPriority

public void unsetPriority()
Unset the priority of Logger. (Thus it will use it's parent's priority or DEBUG if no parent.


unsetPriority

public void unsetPriority(boolean recursive)
Unset the priority of Logger. (Thus it will use it's parent's priority or DEBUG if no parent. If recursive is true unset priorities of all child loggers.

Parameters:
recursive - true to unset priority of all child loggers


warn

public final void warn(String message)
Log a warn priority event.

Parameters:
message - the message


warn

public final void warn(String message,
                       Throwable throwable)
Log a warn priority event.

Parameters:
message - the message
throwable - the throwable