Class Logger

java.lang.Object

org.jpos.util.Logger

All Implemented Interfaces:

Configurable, LogProducer

public class Logger
extends Object
implements LogProducer, Configurable

Peer class Logger forwards LogEvents generated by LogSources to LogListeners.
This little tutorial give you additional information on how to extend the jPOS's Logger subsystem.

See Also:

• LogEvent
• LogSource
• LogListener
• Loggeable
• SimpleLogListener
• RotateLogListener

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NRPREFIX	Prefix used to register loggers in NameRegistrar.

Constructor Summary

Constructors

Constructor	Description
Logger()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addListener(LogListener l)	Adds a log listener to this logger.
void	destroy()	destroy logger
Configuration	getConfiguration()	Returns the current configuration.
static Logger	getLogger(String name)	Returns the logger instance registered under the given name, creating one if necessary.
String	getName()	Returns this logger's registered name.
boolean	hasListeners()	Used by heavy used methods to avoid LogEvent creation
static void	log(LogEvent evt)	Dispatches a log event to the appropriate logger and its listeners.
void	removeAllListeners()	Removes all registered log listeners.
void	removeListener(LogListener l)	Removes a specific log listener.
void	setConfiguration(Configuration cfg)	Configures this object with the supplied Configuration.
void	setName(String name)	associates this Logger with a name using NameRegistrar

Methods inherited from class Object

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

Field Details

NRPREFIX

public static final String NRPREFIX

Prefix used to register loggers in NameRegistrar.

See Also:

• Constant Field Values

Constructor Details

Logger

public Logger()

Default constructor.

Method Details

getConfiguration

public Configuration getConfiguration()

Returns the current configuration.

Returns:

configuration object

setConfiguration

public void setConfiguration(Configuration cfg)
                      throws ConfigurationException

Description copied from interface: Configurable

Configures this object with the supplied Configuration.

Specified by:

setConfiguration in interface Configurable

Parameters:

cfg - Configuration object

Throws:

ConfigurationException - if the configuration is invalid

addListener

public void addListener(LogListener l)

Adds a log listener to this logger.

Specified by:

addListener in interface LogProducer

Parameters:

l - the listener to add

removeListener

public void removeListener(LogListener l)

Description copied from interface: LogProducer

Removes a specific log listener.

Specified by:

removeListener in interface LogProducer

Parameters:

l - the listener to remove

removeAllListeners

public void removeAllListeners()

Description copied from interface: LogProducer

Removes all registered log listeners.

Specified by:

removeAllListeners in interface LogProducer

log

public static void log(LogEvent evt)

Dispatches a log event to the appropriate logger and its listeners.

Parameters:

evt - the log event to dispatch

setName

public void setName(String name)

associates this Logger with a name using NameRegistrar

Parameters:

name - name to register

See Also:

• NameRegistrar

destroy

public void destroy()

destroy logger

getLogger

public static Logger getLogger(String name)

Returns the logger instance registered under the given name, creating one if necessary.

Parameters:

name - the logger name

Returns:

logger instance with given name. Creates one if necessary

See Also:

• NameRegistrar

getName

public String getName()

Returns this logger's registered name.

Returns:

this logger's name ("" if no name was set)

hasListeners

public boolean hasListeners()

Used by heavy used methods to avoid LogEvent creation

Returns:

true if Logger has associated LogListsners