org.productivity.java.syslog4j.impl
Class AbstractSyslog
java.lang.Object
org.productivity.java.syslog4j.impl.AbstractSyslog
- All Implemented Interfaces:
- java.io.Serializable, SyslogConstants, SyslogIF
- Direct Known Subclasses:
- AbstractNetSyslog, UnixSocketSyslog, UnixSyslog
- public abstract class AbstractSyslog
- extends java.lang.Object
- implements SyslogIF
AbstractSyslog provides a base abstract implementation of the SyslogIF.
Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy
of the LGPL license is available in the META-INF folder in all
distributions of Syslog4j and in the base directory of the "doc" ZIP.
- Version:
- $Id: AbstractSyslog.java,v 1.18 2009/01/28 15:13:53 cvs Exp $
- Author:
- <syslog4j@productivity.org>
- See Also:
- Serialized Form
Fields inherited from interface org.productivity.java.syslog4j.SyslogConstants |
AF_UNIX, CACHE_HOST_ADDRESS_DEFAULT, CHAR_SET_DEFAULT, CRLF, FACILITY_AUTH, FACILITY_AUTHPRIV, FACILITY_CRON, FACILITY_DAEMON, FACILITY_FTP, FACILITY_KERN, FACILITY_LOCAL0, FACILITY_LOCAL1, FACILITY_LOCAL2, FACILITY_LOCAL3, FACILITY_LOCAL4, FACILITY_LOCAL5, FACILITY_LOCAL6, FACILITY_LOCAL7, FACILITY_LPR, FACILITY_MAIL, FACILITY_NEWS, FACILITY_SYSLOG, FACILITY_USER, FACILITY_UUCP, IDENT_SUFFIX_DEFAULT, INCLUDE_IDENT_IN_MESSAGE_MODIFIER_DEFAULT, JNA_NATIVE_CLASS, LEVEL_DEBUG, LEVEL_ERROR, LEVEL_FATAL, LEVEL_INFO, LEVEL_WARN, LF, MAX_MESSAGE_LENGTH_DEFAULT, MAX_SHUTDOWN_WAIT_DEFAULT, OPTION_LOG_CONS, OPTION_LOG_NDELAY, OPTION_LOG_NOWAIT, OPTION_LOG_ODELAY, OPTION_LOG_PERROR, OPTION_LOG_PID, OPTION_NONE, SEND_LOCAL_NAME_DEFAULT, SEND_LOCAL_NAME_DEFAULT_VALUE, SEND_LOCAL_TIMESTAMP_DEFAULT, SERVER_SHUTDOWN_WAIT_DEFAULT, SERVER_SOCKET_BACKLOG_DEFAULT, SHUT_WR, SHUTDOWN_INTERVAL, SOCK_DGRAM, SOCK_STREAM, SPLIT_MESSAGE_BEGIN_TEXT_DEFAULT, SPLIT_MESSAGE_END_TEXT_DEFAULT, SYSLOG_BUFFER_SIZE, SYSLOG_DATEFORMAT, SYSLOG_FACILITY_DEFAULT, SYSLOG_HOST_DEFAULT, SYSLOG_LIBRARY_DEFAULT, SYSLOG_MESSAGE_MODIFIER_PREFIX_DEFAULT, SYSLOG_MESSAGE_MODIFIER_SUFFIX_DEFAULT, SYSLOG_PATH_DEFAULT, SYSLOG_POOL_CONFIG_MAX_ACTIVE_DEFAULT, SYSLOG_POOL_CONFIG_MAX_IDLE_DEFAULT, SYSLOG_POOL_CONFIG_MAX_WAIT_DEFAULT, SYSLOG_POOL_CONFIG_MIN_EVICTABLE_IDLE_TIME_MILLIS_DEFAULT, SYSLOG_POOL_CONFIG_MIN_IDLE_DEFAULT, SYSLOG_POOL_CONFIG_NUM_TESTS_PER_EVICTION_RUN_DEFAULT, SYSLOG_POOL_CONFIG_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS_DEFAULT, SYSLOG_POOL_CONFIG_TEST_ON_BORROW_DEFAULT, SYSLOG_POOL_CONFIG_TEST_ON_RETURN_DEFAULT, SYSLOG_POOL_CONFIG_TEST_WHILE_IDLE_DEFAULT, SYSLOG_POOL_CONFIG_TIME_BETWEEN_EVICTION_RUNS_MILLIS_DEFAULT, SYSLOG_PORT_DEFAULT, SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_FIRST_NUMBER_DEFAULT, SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_LAST_NUMBER_DEFAULT, SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_PAD_CHAR_DEFAULT, SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_PREFIX_DEFAULT, SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_SUFFIX_DEFAULT, SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_USE_PADDING_DEFAULT, SYSLOG_SOCKET_LIBRARY_DEFAULT, SYSLOG_SOCKET_PATH_DEFAULT, SYSLOG_SOCKET_PROTOCOL_DEFAULT, TCP, TCP_DELIMITER_SEQUENCE_DEFAULT, TCP_KEEP_ALIVE_DEFAULT, TCP_PERSISTENT_CONNECTION_DEFAULT, TCP_REUSE_ADDRESS_DEFAULT, TCP_SET_BUFFER_SIZE_DEFAULT, TCP_SO_LINGER_DEFAULT, TCP_SO_LINGER_SECONDS_DEFAULT, THREAD_LOOP_INTERVAL_DEFAULT, THREADED_DEFAULT, THROW_EXCEPTION_ON_INITIALIZE_DEFAULT, THROW_EXCEPTION_ON_WRITE_DEFAULT, UDP, UNIX_SOCKET, UNIX_SYSLOG, WRITE_RETRIES_DEFAULT |
Method Summary |
void |
backLog(int level,
java.lang.String message,
java.lang.String reason)
|
void |
backLog(int level,
java.lang.String message,
java.lang.Throwable reasonThrowable)
|
AbstractSyslogWriter |
createWriter()
|
java.lang.Thread |
createWriterThread(AbstractSyslogWriter syslogWriter)
|
void |
debug(java.lang.String message)
|
void |
debug(SyslogMessageIF message)
|
void |
error(java.lang.String message)
|
void |
error(SyslogMessageIF message)
|
void |
fatal(java.lang.String message)
|
void |
fatal(SyslogMessageIF message)
|
protected boolean |
getBackLogStatus()
|
SyslogConfigIF |
getConfig()
|
SyslogMessageProcessorIF |
getMessageProcessor()
|
java.lang.String |
getProtocol()
|
abstract AbstractSyslogWriter |
getWriter()
|
void |
info(java.lang.String message)
|
void |
info(SyslogMessageIF message)
|
protected abstract void |
initialize()
|
void |
initialize(java.lang.String protocol,
SyslogConfigIF config)
|
void |
log(int level,
java.lang.String message)
|
void |
log(int level,
SyslogMessageIF message)
|
protected java.lang.String |
modifyMessage(int level,
java.lang.String message)
|
protected java.lang.String |
prefixMessage(java.lang.String message,
java.lang.String suffix)
|
abstract void |
returnWriter(AbstractSyslogWriter syslogWriter)
|
void |
setBackLogStatus(boolean backLogStatus)
|
void |
setMessageProcessor(SyslogMessageProcessorIF messageProcessor)
|
void |
warn(java.lang.String message)
|
void |
warn(SyslogMessageIF message)
|
protected abstract void |
write(byte[] message)
|
protected void |
write(int level,
java.lang.String message)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
syslogProtocol
protected java.lang.String syslogProtocol
syslogConfig
protected AbstractSyslogConfigIF syslogConfig
syslogMessageProcessor
protected SyslogMessageProcessorIF syslogMessageProcessor
backLogStatusSyncObject
protected java.lang.Object backLogStatusSyncObject
backLogStatus
protected boolean backLogStatus
notifiedBackLogHandlers
protected java.util.List notifiedBackLogHandlers
AbstractSyslog
public AbstractSyslog()
getBackLogStatus
protected boolean getBackLogStatus()
setBackLogStatus
public void setBackLogStatus(boolean backLogStatus)
- Parameters:
backLogStatus
- - true if in a "down" backLog state, false if in an "up" (operational) non-backLog state
initialize
public void initialize(java.lang.String protocol,
SyslogConfigIF config)
throws SyslogRuntimeException
- Specified by:
initialize
in interface SyslogIF
- Throws:
SyslogRuntimeException
getMessageProcessor
public SyslogMessageProcessorIF getMessageProcessor()
- Specified by:
getMessageProcessor
in interface SyslogIF
setMessageProcessor
public void setMessageProcessor(SyslogMessageProcessorIF messageProcessor)
- Specified by:
setMessageProcessor
in interface SyslogIF
getProtocol
public java.lang.String getProtocol()
- Specified by:
getProtocol
in interface SyslogIF
getConfig
public SyslogConfigIF getConfig()
- Specified by:
getConfig
in interface SyslogIF
debug
public void debug(java.lang.String message)
- Specified by:
debug
in interface SyslogIF
info
public void info(java.lang.String message)
- Specified by:
info
in interface SyslogIF
warn
public void warn(java.lang.String message)
- Specified by:
warn
in interface SyslogIF
error
public void error(java.lang.String message)
- Specified by:
error
in interface SyslogIF
fatal
public void fatal(java.lang.String message)
- Specified by:
fatal
in interface SyslogIF
log
public void log(int level,
SyslogMessageIF message)
- Specified by:
log
in interface SyslogIF
debug
public void debug(SyslogMessageIF message)
- Specified by:
debug
in interface SyslogIF
info
public void info(SyslogMessageIF message)
- Specified by:
info
in interface SyslogIF
warn
public void warn(SyslogMessageIF message)
- Specified by:
warn
in interface SyslogIF
error
public void error(SyslogMessageIF message)
- Specified by:
error
in interface SyslogIF
fatal
public void fatal(SyslogMessageIF message)
- Specified by:
fatal
in interface SyslogIF
prefixMessage
protected java.lang.String prefixMessage(java.lang.String message,
java.lang.String suffix)
log
public void log(int level,
java.lang.String message)
- Specified by:
log
in interface SyslogIF
write
protected void write(int level,
java.lang.String message)
throws SyslogRuntimeException
- Throws:
SyslogRuntimeException
initialize
protected abstract void initialize()
throws SyslogRuntimeException
- Throws:
SyslogRuntimeException
write
protected abstract void write(byte[] message)
throws SyslogRuntimeException
- Throws:
SyslogRuntimeException
modifyMessage
protected java.lang.String modifyMessage(int level,
java.lang.String message)
backLog
public void backLog(int level,
java.lang.String message,
java.lang.Throwable reasonThrowable)
- Specified by:
backLog
in interface SyslogIF
backLog
public void backLog(int level,
java.lang.String message,
java.lang.String reason)
- Specified by:
backLog
in interface SyslogIF
getWriter
public abstract AbstractSyslogWriter getWriter()
returnWriter
public abstract void returnWriter(AbstractSyslogWriter syslogWriter)
createWriterThread
public java.lang.Thread createWriterThread(AbstractSyslogWriter syslogWriter)
createWriter
public AbstractSyslogWriter createWriter()