com.ergotech.secs

Class SyslogLogger

java.lang.Object

com.ergotech.secs.SyslogLogger

All Implemented Interfaces:

LoggerInterface, SecsEventListener, java.util.EventListener

public class SyslogLogger
extends java.lang.Object
implements LoggerInterface, SecsEventListener

A logger object that logs to the syslog.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	cvsRev
static int	SYSLOG_FACILITY
static java.lang.String	SYSLOG_HOST
static int	SYSLOG_LOG_LEVEL
static int	SYSLOG_PORT

Constructor Summary

Constructors

Constructor and Description
SyslogLogger(java.lang.String receiveString, java.lang.String sendString)

Method Summary

Modifier and Type	Method and Description
java.lang.String	displayBytes(byte[] data)
boolean	getDisplayBytes()
boolean	getDisplayMessages()
static void	log(java.lang.String logDirection, java.lang.String msg) Send the give string to the syslog.
static void	main(java.lang.String[] args)
void	received(byte[] data) This will be called wheneever raw bytes of data are read from the port.
void	received(SecsMsg msg) Called whenever a message is received.
void	register()
void	register(SecsEventHandler theHandler)
void	registerForId(int id)
void	registerForId(SecsEventHandler theHandler, int id)
void	secsEvent(SecsEvent theEvent) This method will be called when a SecsEvent accurs.
void	sent(byte[] data) Called whenever data is sent through the port.
void	sent(SecsMsg msg) Called whenever a message is sent.
void	setDisplayBytes(boolean newValue) This allows the logger to control the display of byte data.
void	setDisplayEvents(boolean newValue) This method will turn on the display of all events.
void	setDisplayMessages(boolean newValue) This allows the logger to control the display of message data.

Methods inherited from class java.lang.Object

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

Field Detail

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

SYSLOG_FACILITY

public static final int SYSLOG_FACILITY

See Also:

Constant Field Values

SYSLOG_HOST

public static final java.lang.String SYSLOG_HOST

See Also:

Constant Field Values

SYSLOG_LOG_LEVEL

public static final int SYSLOG_LOG_LEVEL

See Also:

Constant Field Values

SYSLOG_PORT

public static final int SYSLOG_PORT

See Also:

Constant Field Values

Constructor Detail

SyslogLogger

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

Method Detail

displayBytes

public java.lang.String displayBytes(byte[] data)

getDisplayBytes

public boolean getDisplayBytes()

getDisplayMessages

public boolean getDisplayMessages()

log

public static void log(java.lang.String logDirection,
                       java.lang.String msg)

Send the give string to the syslog.

main

public static void main(java.lang.String[] args)

received

public void received(byte[] data)

Description copied from interface: LoggerInterface

This will be called wheneever raw bytes of data are read from the port. There is no guarentee the the array will contain a complete message.

Specified by:

received in interface LoggerInterface

received

public void received(SecsMsg msg)

Description copied from interface: LoggerInterface

Called whenever a message is received. This will be called whenever a message is received after the raw byte stream has been converted to a message.

Specified by:

received in interface LoggerInterface

register

public void register()

register

public void register(SecsEventHandler theHandler)

registerForId

public void registerForId(int id)

registerForId

public void registerForId(SecsEventHandler theHandler,
                          int id)

secsEvent

public void secsEvent(SecsEvent theEvent)

Description copied from interface: SecsEventListener

This method will be called when a SecsEvent accurs.

Specified by:

secsEvent in interface SecsEventListener

sent

public void sent(byte[] data)

Description copied from interface: LoggerInterface

Called whenever data is sent through the port. There is no guarentee that the array will contain a complete message, or even a complete block.

Specified by:

sent in interface LoggerInterface

sent

public void sent(SecsMsg msg)

Description copied from interface: LoggerInterface

Called whenever a message is sent.

Specified by:

sent in interface LoggerInterface

setDisplayBytes

public void setDisplayBytes(boolean newValue)

Description copied from interface: LoggerInterface

This allows the logger to control the display of byte data. This will be called whenever the user wishes to enable or disable the display of byte data. Note that this has no impact on whether the methods are called. The SECS system will always call the logger methods, it is the task of the logger to decide what to do with the information, this method is here just to help with that task.

Specified by:

setDisplayBytes in interface LoggerInterface

setDisplayEvents

public void setDisplayEvents(boolean newValue)

This method will turn on the display of all events. It will do this regardless of the value of the boolean.

Specified by:

setDisplayEvents in interface LoggerInterface

setDisplayMessages

public void setDisplayMessages(boolean newValue)

Description copied from interface: LoggerInterface

This allows the logger to control the display of message data. This will be called whenever the user wishes to enable or disable the display of message data. Note that this has no impact on whether the methods are called. The SECS system will always call the logger methods, it is the task of the logger to decide what to do with the information, this method is here just to help with that task.

Specified by:

setDisplayMessages in interface LoggerInterface