org.productivity.java.syslog4j
Interface SyslogIF

All Superinterfaces:
java.io.Serializable, SyslogConstants
All Known Implementing Classes:
AbstractSyslog, MultipleSyslog

public interface SyslogIF
extends SyslogConstants

SyslogIF provides a common interface for all Syslog4j client implementations.

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: SyslogIF.java,v 1.7 2009/04/10 00:05:03 cvs Exp $
Author:
<syslog4j@productivity.org>

Field Summary
 
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_ALERT, LEVEL_CRITICAL, LEVEL_DEBUG, LEVEL_ERROR, LEVEL_FATAL, LEVEL_INFO, LEVEL_NOTICE, 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 alert(java.lang.String message)
           
 void alert(SyslogMessageIF message)
           
 void backLog(int level, java.lang.String message, java.lang.String reason)
           
 void backLog(int level, java.lang.String message, java.lang.Throwable reasonThrowable)
           
 void critical(java.lang.String message)
           
 void critical(SyslogMessageIF message)
           
 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)
           
 void flush()
           
 SyslogConfigIF getConfig()
           
 SyslogMessageProcessorIF getMessageProcessor()
           
 java.lang.String getProtocol()
           
 void info(java.lang.String message)
           
 void info(SyslogMessageIF message)
           
 void initialize(java.lang.String protocol, SyslogConfigIF config)
           
 void log(int level, java.lang.String message)
           
 void log(int level, SyslogMessageIF message)
           
 void notice(java.lang.String message)
           
 void notice(SyslogMessageIF message)
           
 void setMessageProcessor(SyslogMessageProcessorIF messageProcessor)
           
 void shutdown()
           
 void warn(java.lang.String message)
           
 void warn(SyslogMessageIF message)
           
 

Method Detail

initialize

public void initialize(java.lang.String protocol,
                       SyslogConfigIF config)
                throws SyslogRuntimeException
Throws:
SyslogRuntimeException

getProtocol

public java.lang.String getProtocol()

getConfig

public SyslogConfigIF getConfig()

backLog

public void backLog(int level,
                    java.lang.String message,
                    java.lang.Throwable reasonThrowable)

backLog

public void backLog(int level,
                    java.lang.String message,
                    java.lang.String reason)

log

public void log(int level,
                java.lang.String message)

debug

public void debug(java.lang.String message)

info

public void info(java.lang.String message)

notice

public void notice(java.lang.String message)

warn

public void warn(java.lang.String message)

error

public void error(java.lang.String message)

critical

public void critical(java.lang.String message)

alert

public void alert(java.lang.String message)

fatal

public void fatal(java.lang.String message)

log

public void log(int level,
                SyslogMessageIF message)

debug

public void debug(SyslogMessageIF message)

info

public void info(SyslogMessageIF message)

notice

public void notice(SyslogMessageIF message)

warn

public void warn(SyslogMessageIF message)

error

public void error(SyslogMessageIF message)

critical

public void critical(SyslogMessageIF message)

alert

public void alert(SyslogMessageIF message)

fatal

public void fatal(SyslogMessageIF message)

flush

public void flush()
           throws SyslogRuntimeException
Throws:
SyslogRuntimeException

shutdown

public void shutdown()
              throws SyslogRuntimeException
Throws:
SyslogRuntimeException

setMessageProcessor

public void setMessageProcessor(SyslogMessageProcessorIF messageProcessor)

getMessageProcessor

public SyslogMessageProcessorIF getMessageProcessor()