org.productivity.java.syslog4j.impl
Interface AbstractSyslogConfigIF

All Superinterfaces:

java.io.Serializable, SyslogCharSetIF, SyslogConfigIF, SyslogConstants

All Known Subinterfaces:

AbstractNetSyslogConfigIF, SSLTCPNetSyslogConfigIF, TCPNetSyslogConfigIF

All Known Implementing Classes:

AbstractNetSyslogConfig, AbstractSyslogConfig, PooledSSLTCPNetSyslogConfig, PooledTCPNetSyslogConfig, SSLTCPNetSyslogConfig, TCPNetSyslogConfig, UDPNetSyslogConfig, UnixSocketSyslogConfig, UnixSyslogConfig

public interface AbstractSyslogConfigIF
extends SyslogConfigIF

AbstractSyslogConfigIF provides an interface for all Abstract Syslog configuration 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: AbstractSyslogConfigIF.java,v 1.7 2010/10/29 03:14:20 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_EMERGENCY, LEVEL_ERROR, LEVEL_INFO, LEVEL_NOTICE, LEVEL_WARN, LF, MAX_MESSAGE_LENGTH_DEFAULT, MAX_QUEUE_SIZE_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, SHUTDOWN_INTERVAL, SOCK_DGRAM, SOCK_STREAM, SPLIT_MESSAGE_BEGIN_TEXT_DEFAULT, SPLIT_MESSAGE_END_TEXT_DEFAULT, STRUCTURED_DATA_APP_NAME_DEFAULT_VALUE, STRUCTURED_DATA_EMPTY_VALUE, STRUCTURED_DATA_NILVALUE, STRUCTURED_DATA_PROCESS_ID_DEFAULT_VALUE, 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_FAMILY_DEFAULT, SYSLOG_SOCKET_LIBRARY_DEFAULT, SYSLOG_SOCKET_PATH_DEFAULT, SYSLOG_SOCKET_PROTOCOL_DEFAULT, SYSLOG_SOCKET_TYPE_DEFAULT, TCP, TCP_DELIMITER_SEQUENCE_DEFAULT, TCP_FRESH_CONNECTION_INTERVAL_DEFAULT, TCP_KEEP_ALIVE_DEFAULT, TCP_MAX_ACTIVE_SOCKETS_BEHAVIOR_DEFAULT, TCP_MAX_ACTIVE_SOCKETS_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, THREAD_PRIORITY_DEFAULT, THREADED_DEFAULT, THROW_EXCEPTION_ON_INITIALIZE_DEFAULT, THROW_EXCEPTION_ON_WRITE_DEFAULT, TRUNCATE_MESSAGE_DEFAULT, UDP, UNIX_SOCKET, UNIX_SYSLOG, USE_DAEMON_THREAD_DEFAULT, USE_STRUCTURED_DATA_DEFAULT, WRITE_RETRIES_DEFAULT

Method Summary

java.util.List	getBackLogHandlers()
int	getMaxQueueSize()
long	getMaxShutdownWait()
java.util.List	getMessageModifiers()
byte[]	getSplitMessageBeginText()
byte[]	getSplitMessageEndText()
java.lang.Class	getSyslogWriterClass()
long	getThreadLoopInterval()
int	getThreadPriority()
int	getWriteRetries()
boolean	isThreaded()
boolean	isUseDaemonThread()
void	setMaxQueueSize(int maxQueueSize) Use the (default) value of -1 to allow for a queue of indefinite depth (size).
void	setMaxShutdownWait(long maxShutdownWait)
void	setSplitMessageBeginText(byte[] beginText)
void	setSplitMessageEndText(byte[] endText)
void	setThreaded(boolean threaded)
void	setThreadLoopInterval(long threadLoopInterval)
void	setThreadPriority(int threadPriority)
void	setUseDaemonThread(boolean useDaemonThread)
void	setWriteRetries(int writeRetries)

Methods inherited from interface org.productivity.java.syslog4j.SyslogConfigIF

addBackLogHandler, addMessageModifier, getCharSet, getFacility, getHost, getIdent, getLocalName, getMaxMessageLength, getPort, getSyslogClass, insertBackLogHandler, insertMessageModifier, isIncludeIdentInMessageModifier, isSendLocalName, isSendLocalTimestamp, isThrowExceptionOnInitialize, isThrowExceptionOnWrite, isTruncateMessage, isUseStructuredData, removeAllBackLogHandlers, removeAllMessageModifiers, removeBackLogHandler, removeMessageModifier, setCharSet, setFacility, setFacility, setHost, setIdent, setIncludeIdentInMessageModifier, setLocalName, setMaxMessageLength, setPort, setSendLocalName, setSendLocalTimestamp, setThrowExceptionOnInitialize, setThrowExceptionOnWrite, setTruncateMessage, setUseStructuredData

Method Detail

getSyslogWriterClass

java.lang.Class getSyslogWriterClass()

getBackLogHandlers

java.util.List getBackLogHandlers()

getMessageModifiers

java.util.List getMessageModifiers()

getSplitMessageBeginText

byte[] getSplitMessageBeginText()

setSplitMessageBeginText

void setSplitMessageBeginText(byte[] beginText)

getSplitMessageEndText

byte[] getSplitMessageEndText()

setSplitMessageEndText

void setSplitMessageEndText(byte[] endText)

isThreaded

boolean isThreaded()

setThreaded

void setThreaded(boolean threaded)

isUseDaemonThread

boolean isUseDaemonThread()

setUseDaemonThread

void setUseDaemonThread(boolean useDaemonThread)

getThreadPriority

int getThreadPriority()

setThreadPriority

void setThreadPriority(int threadPriority)

getThreadLoopInterval

long getThreadLoopInterval()

setThreadLoopInterval

void setThreadLoopInterval(long threadLoopInterval)

getMaxShutdownWait

long getMaxShutdownWait()

setMaxShutdownWait

void setMaxShutdownWait(long maxShutdownWait)

getWriteRetries

int getWriteRetries()

setWriteRetries

void setWriteRetries(int writeRetries)

getMaxQueueSize

int getMaxQueueSize()

setMaxQueueSize

void setMaxQueueSize(int maxQueueSize)

Use the (default) value of -1 to allow for a queue of indefinite depth (size).

Parameters:

maxQueueSize -