org.productivity.java.syslog4j
Interface SyslogConfigIF

All Superinterfaces:
java.io.Serializable, SyslogCharSetIF, SyslogConstants
All Known Subinterfaces:
AbstractNetSyslogConfigIF, AbstractSyslogConfigIF, SSLTCPNetSyslogConfigIF, TCPNetSyslogConfigIF
All Known Implementing Classes:
AbstractNetSyslogConfig, AbstractSyslogConfig, MultipleSyslogConfig, PooledSSLTCPNetSyslogConfig, SSLTCPNetSyslogConfig, TCPNetSyslogConfig

public interface SyslogConfigIF
extends SyslogConstants, SyslogCharSetIF

SyslogConfigIF provides a common, extensible configuration interface for all implementations of 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: SyslogConfigIF.java,v 1.17 2009/06/06 19:09:06 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, TRUNCATE_MESSAGE_DEFAULT, UDP, UNIX_SOCKET, UNIX_SYSLOG, WRITE_RETRIES_DEFAULT
 
Method Summary
 void addBackLogHandler(SyslogBackLogHandlerIF backLogHandler)
           
 void addMessageModifier(SyslogMessageModifierIF messageModifier)
           
 java.lang.String getCharSet()
           
 int getFacility()
           
 java.lang.String getHost()
           
 java.lang.String getIdent()
           
 int getMaxMessageLength()
           
 int getPort()
           
 java.lang.Class getSyslogClass()
           
 void insertBackLogHandler(int index, SyslogBackLogHandlerIF backLogHandler)
           
 void insertMessageModifier(int index, SyslogMessageModifierIF messageModifier)
           
 boolean isIncludeIdentInMessageModifier()
           
 boolean isSendLocalName()
           
 boolean isSendLocalTimestamp()
           
 boolean isThrowExceptionOnInitialize()
           
 boolean isThrowExceptionOnWrite()
           
 boolean isTruncateMessage()
           
 void removeAllBackLogHandlers()
           
 void removeAllMessageModifiers()
           
 void removeBackLogHandler(SyslogBackLogHandlerIF backLogHandler)
           
 void removeMessageModifier(SyslogMessageModifierIF messageModifier)
           
 void setCharSet(java.lang.String charSet)
           
 void setFacility(int facility)
           
 void setFacility(java.lang.String facilityName)
           
 void setHost(java.lang.String host)
           
 void setIdent(java.lang.String ident)
           
 void setIncludeIdentInMessageModifier(boolean throwExceptionOnInitialize)
           
 void setMaxMessageLength(int maxMessageLength)
           
 void setPort(int port)
           
 void setSendLocalName(boolean sendLocalName)
           
 void setSendLocalTimestamp(boolean sendLocalTimestamp)
           
 void setThrowExceptionOnInitialize(boolean throwExceptionOnInitialize)
           
 void setThrowExceptionOnWrite(boolean throwExceptionOnWrite)
           
 void setTruncateMessage(boolean truncateMessage)
           
 

Method Detail

getSyslogClass

public java.lang.Class getSyslogClass()

getFacility

public int getFacility()

setFacility

public void setFacility(int facility)

setFacility

public void setFacility(java.lang.String facilityName)

getPort

public int getPort()

setPort

public void setPort(int port)
             throws SyslogRuntimeException
Throws:
SyslogRuntimeException

getHost

public java.lang.String getHost()

setHost

public void setHost(java.lang.String host)
             throws SyslogRuntimeException
Throws:
SyslogRuntimeException

getIdent

public java.lang.String getIdent()

setIdent

public void setIdent(java.lang.String ident)

getCharSet

public java.lang.String getCharSet()
Specified by:
getCharSet in interface SyslogCharSetIF

setCharSet

public void setCharSet(java.lang.String charSet)
Specified by:
setCharSet in interface SyslogCharSetIF

isIncludeIdentInMessageModifier

public boolean isIncludeIdentInMessageModifier()

setIncludeIdentInMessageModifier

public void setIncludeIdentInMessageModifier(boolean throwExceptionOnInitialize)

isThrowExceptionOnInitialize

public boolean isThrowExceptionOnInitialize()

setThrowExceptionOnInitialize

public void setThrowExceptionOnInitialize(boolean throwExceptionOnInitialize)

isThrowExceptionOnWrite

public boolean isThrowExceptionOnWrite()

setThrowExceptionOnWrite

public void setThrowExceptionOnWrite(boolean throwExceptionOnWrite)

isSendLocalTimestamp

public boolean isSendLocalTimestamp()

setSendLocalTimestamp

public void setSendLocalTimestamp(boolean sendLocalTimestamp)

isSendLocalName

public boolean isSendLocalName()

setSendLocalName

public void setSendLocalName(boolean sendLocalName)

isTruncateMessage

public boolean isTruncateMessage()

setTruncateMessage

public void setTruncateMessage(boolean truncateMessage)

getMaxMessageLength

public int getMaxMessageLength()

setMaxMessageLength

public void setMaxMessageLength(int maxMessageLength)

addMessageModifier

public void addMessageModifier(SyslogMessageModifierIF messageModifier)

insertMessageModifier

public void insertMessageModifier(int index,
                                  SyslogMessageModifierIF messageModifier)

removeMessageModifier

public void removeMessageModifier(SyslogMessageModifierIF messageModifier)

removeAllMessageModifiers

public void removeAllMessageModifiers()

addBackLogHandler

public void addBackLogHandler(SyslogBackLogHandlerIF backLogHandler)

insertBackLogHandler

public void insertBackLogHandler(int index,
                                 SyslogBackLogHandlerIF backLogHandler)

removeBackLogHandler

public void removeBackLogHandler(SyslogBackLogHandlerIF backLogHandler)

removeAllBackLogHandlers

public void removeAllBackLogHandlers()