com.ergotech.transsecs.secs

Class Log4JLogger

java.lang.Object

com.ergotech.transsecs.secs.Log4JLogger

All Implemented Interfaces:

LoggerInterface, SecsEventListener, java.util.EventListener

public class Log4JLogger
extends java.lang.Object
implements LoggerInterface

This sends logging information to the log4j logging system. We abuse the log4j levels such that at level WARN messages are logged at level INFO bytes are logged and at level DEBUG we log events. The logger will ignore calls to the methods:

public void setDisplayBytes(boolean newValue);

public void setDisplayMessages(boolean newValue);

public void setDisplayEvents(boolean newValue);

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	appendToolName If true, the tool name will be appended to the log messages.

Fields inherited from interface com.ergotech.secs.SecsEventListener

cvsRev

Constructor Summary

Constructors

Constructor and Description
Log4JLogger() The default constructor.
Log4JLogger(java.lang.String receiveString, java.lang.String sendString) The default constructor.
Log4JLogger(TransSecsController controller) Create with a controller.

Method Summary

Modifier and Type	Method and Description
void	error(java.lang.String msg, java.lang.Throwable t) write an error with stack trace and message to the log
void	fatal(java.lang.String infoString) write a very important message to the log
void	info(java.lang.String infoString) write an information string to the log
boolean	isEnabledFor(Level level) access method for logger, returns this log4jLogger access level (set by log4j.xml)
void	received(byte[] data) Called when a message is received.
void	received(SecsMsg msg) Called when a message is received.
void	secsEvent(SecsEvent theEvent) Passed through to the log4j logger.
void	sent(byte[] data) Called when a message is sent.
void	sent(SecsMsg msg) Called when a message is sent.
void	setAccessLevel(Level level) enables overrride of log4j.xml access level from command line (i.e., for orgi which sets -lb=info, -le=debug, -lm=warn)
void	setDisplayBytes(boolean newValue) Passed through to the log4j logger.
void	setDisplayEvents(boolean newValue) Passed through to the log4j logger.
void	setDisplayMessages(boolean newValue) Passed through to the log4j logger.
java.lang.String	toString() Create a string that lists the loggers were a passing through to.
java.lang.String	toString(SecsMsg msg) Returns a nicely formatted text string.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

appendToolName

public static boolean appendToolName

If true, the tool name will be appended to the log messages.

Constructor Detail

Log4JLogger

public Log4JLogger()

The default constructor.

Log4JLogger

public Log4JLogger(java.lang.String receiveString,
                   java.lang.String sendString)

The default constructor.

Log4JLogger

public Log4JLogger(TransSecsController controller)

Create with a controller. The controller may be null.

Parameters:

controller - TransSecsController used to decode additional information for messages

Method Detail

error

public void error(java.lang.String msg,
                  java.lang.Throwable t)

write an error with stack trace and message to the log

fatal

public void fatal(java.lang.String infoString)

write a very important message to the log

info

public void info(java.lang.String infoString)

write an information string to the log

isEnabledFor

public boolean isEnabledFor(Level level)

access method for logger, returns this log4jLogger access level (set by log4j.xml)

received

public void received(byte[] data)

Called when a message is received. The data is the raw byte data of the message.

Specified by:

received in interface LoggerInterface

received

public void received(SecsMsg msg)

Called when a message is received. Passed through to the log4j logger.

Specified by:

received in interface LoggerInterface

secsEvent

public void secsEvent(SecsEvent theEvent)

Passed through to the log4j logger.

Specified by:

secsEvent in interface SecsEventListener

See Also:

SecsEventListener.secsEvent(com.ergotech.secs.SecsEvent)

sent

public void sent(byte[] data)

Called when a message is sent. The data is the raw byte data of the message.

Specified by:

sent in interface LoggerInterface

sent

public void sent(SecsMsg msg)

Called when a message is sent.

Specified by:

sent in interface LoggerInterface

setAccessLevel

public void setAccessLevel(Level level)

enables overrride of log4j.xml access level from command line (i.e., for orgi which sets -lb=info, -le=debug, -lm=warn)

setDisplayBytes

public void setDisplayBytes(boolean newValue)

Passed through to the log4j logger.

Specified by:

setDisplayBytes in interface LoggerInterface

See Also:

LoggerInterface.setDisplayBytes(boolean)

setDisplayEvents

public void setDisplayEvents(boolean newValue)

Passed through to the log4j logger.

Specified by:

setDisplayEvents in interface LoggerInterface

See Also:

LoggerInterface.setDisplayEvents(boolean)

setDisplayMessages

public void setDisplayMessages(boolean newValue)

Passed through to the log4j logger.

Specified by:

setDisplayMessages in interface LoggerInterface

See Also:

LoggerInterface.setDisplayMessages(boolean)

toString

public java.lang.String toString()

Create a string that lists the loggers were a passing through to.

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(SecsMsg msg)

Returns a nicely formatted text string. Not for ORGi (JRE 1.8 OK, not for JRE 1.5)