Package com.protomatter.syslog

Syslog is a system-wide logging facility.

See:
Description

Interface Summary

DatabaseLogStatementAdapter	An adapter for setting the message detail in the database log.
JMSConstants	Constants for JMS-related Syslog functions.
LogPolicy	The interface for the pluggable log policy system.
RemoteLogReceiver	An interface for loggers that are receiving messages from a remote machine via RMI.
SyslogChannelAware	An interface for objects that are aware of channels in syslog.
Syslogger	An interface for objects that will log things using the Syslog facility.
SyslogMailSubjectFormatter	The interface for the pluggable message subject formatting system.
SyslogTextFormatter	The interface for the pluggable text formatting system.

Class Summary

AsciiStreamDatabaseLogStatementAdapter	A log adapter that uses the setAsciiStream() method to set details.
BasicLogger	A base class for Syslogger implementations.
Channel	A utility class for writing log messages to channels.
CharacterStreamDatabaseLogStatementAdapter	A log adapter that uses the setCharacterStream() method to set details.
DatabaseLog	A logger that writes to a database.
FileLog	A logger that simply writes to a file.
HTMLSyslogTextFormatter	A log entry formatter that produces HTML.
JDK14PerChannelPolicy	A policy that can make decision on a per-channel basis.
JDK14PerChannelPolicy.PolicyGroup	A policy within a policy -- this is exactly like the SimpleLogPolicy except that it also checks to see if the channel issuing the log message is in some set.
JDK14PerClassPolicy	A policy that can make decision on a per-class basis.
JDK14PerClassPolicy.PolicyGroup	A policy within a policy -- this is exactly like the SimpleLogPolicy except that it also checks to see if the class issuing the log message is in some set.
JDK14SyslogTextFormatter	A log entry formatter.
JMSLog	A logger that writes messages to JMS.
LengthRolloverLog	An implementation of an object that will log things using the Syslog facility, and roll it's log files after a certain number of bytes have been written to them.
MailLog	A logger that sends email.
MessageConstants	Constants for messages loaded from resource bundles.
OpenFileLog	A logger that opens the file for each log entry and closes it after it's done writing.
PerChannelPolicy	A policy that can make decision on a per-channel basis.
PerChannelPolicy.PolicyGroup	A policy within a policy -- this is exactly like the SimpleLogPolicy except that it also checks to see if the channel issuing the log message is in some set.
PerClassPolicy	A policy that can make decision on a per-class basis.
PerClassPolicy.PolicyGroup	A policy within a policy -- this is exactly like the SimpleLogPolicy except that it also checks to see if the class issuing the log message is in some set.
PerformanceTest	A performance testing rig for Syslog.
PrintWriterLog	An implementation of an object that will log things using the Syslog facility.
RemoteLog	A logger that sends messages to remote receivers bound in JNDI.
RemoteLogReceiverImpl	A simple implementation of the RemoteLogReceiver interface.
SimpleLogPolicy	The default LogPolicy that knows about log levels and channels.
SimpleSyslogMailSubjectFormatter	A simple mail subject formatter.
SimpleSyslogTextFormatter	A simple log entry formatter.
StringDatabaseLogStatementAdapter	A log adapter that uses the setString() method to set details.
Syslog	This class implements a system-wide logging utility.
SyslogHandler	A JDK 1.4 logging system handler to route messages into Syslog.
SyslogHTMLMailFormatter	A simple HTML log entry formatter for email.
SyslogMessage	A utility class representing all the information needed to make a syslog call.
SyslogServer	A standalone log processing server which either reads messages from a JMS topic, or through RMI.
SyslogT3Startup	Configure syslog to start when WebLogic does.
SyslogWriter	A Writer that is attached to Syslog.
TimeRolloverLog	An implementation of an object that will log things using the Syslog facility, and roll it's log files after a certain amount of time has passed.
Wl6SyslogTextFormatter	A log formatter that mimics the log output from WebLogic Server 6.x.
WlSyslogTextFormatter	A log formatter that mimics the log output from WebLogic.

Exception Summary

SyslogInitException

An exception during the syslog init process.

Package com.protomatter.syslog Description

Syslog is a system-wide logging facility. It's roughly based on the UNIX syslog facility, but has many nice features not found there. It provides a clean, uniform interface for sending log messages and a modular back-end for writing entries to files, databases, etc.

The main class that other programs interact with is the Syslog class. Everything on the class is static, making it easy to interact with as a service.

Messages sent to Syslog are handled by objects implementing the Syslogger interface. Syslog provides the concept of levels (DEBUG, INFO, WARNING, ERROR and FATAL). Individual loggers can have their own log policies for deciding if they should pay attention to given log message. There is a useful default policy that allows loggers to only listen to certain channels or messages at certain levels, etc.

Syslog provides startup classes for both the BEA WebLogic Server Application Server, and for Protomatter's own PAS Application Server. This allows for easy configuration of the Syslog package when each application server starts.

Please refer to the Syslog Whitepaper the JavaDoc for the Syslog class for more information on usage.

For information on configuring Syslog via an XML file, please refer to JavaDoc for the SyslogXML class.

Every error message can displayed in a different language. Simply add a new resource (named com/protomatter/syslog/Syslog) to your classpath for the new language. For instance, to add French error messages, you would copy the existing file com/protomatter/syslog/Syslog.properties and make a new file called com/protomatter/syslog/Syslog_fr.properties and place it in the CLASSPATH. Please see the JavaDoc for the java.util.ResourceBundle class for more information.