org.productivity.java.syslog4j.server
Interface SyslogServerConfigIF

All Superinterfaces:

java.io.Serializable, SyslogCharSetIF, SyslogConstants

All Known Subinterfaces:

SSLTCPNetSyslogServerConfigIF, TCPNetSyslogServerConfigIF

All Known Implementing Classes:

AbstractNetSyslogServerConfig, AbstractSyslogServerConfig, SSLTCPNetSyslogServerConfig, TCPNetSyslogServerConfig, UDPNetSyslogServerConfig

public interface SyslogServerConfigIF
extends SyslogConstants, SyslogCharSetIF

SyslogServerConfigIF provides a common, extensible configuration interface for all implementations of SyslogServerIF.

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: SyslogServerConfigIF.java,v 1.12 2011/01/11 05:11:13 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

void	addEventHandler(SyslogServerEventHandlerIF eventHandler)
java.lang.Object	getDateTimeFormatter()
java.util.List	getEventHandlers()
java.lang.String	getHost()
int	getPort()
long	getShutdownWait()
java.lang.Class	getSyslogServerClass()
int	getThreadPriority()
void	insertEventHandler(int pos, SyslogServerEventHandlerIF eventHandler)
boolean	isUseDaemonThread()
boolean	isUseStructuredData()
void	removeAllEventHandlers()
void	removeEventHandler(SyslogServerEventHandlerIF eventHandler)
void	setDateTimeFormatter(java.lang.Object dateTimeFormatter)
void	setHost(java.lang.String host)
void	setPort(int port)
void	setShutdownWait(long shutdownWait)
void	setThreadPriority(int threadPriority)
void	setUseDaemonThread(boolean useDaemonThread)
void	setUseStructuredData(boolean useStructuredData)

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

getCharSet, setCharSet

Method Detail

getSyslogServerClass

java.lang.Class getSyslogServerClass()

getHost

java.lang.String getHost()

setHost

void setHost(java.lang.String host)
             throws SyslogRuntimeException

Throws:

SyslogRuntimeException

getPort

int getPort()

setPort

void setPort(int port)
             throws SyslogRuntimeException

Throws:

SyslogRuntimeException

isUseDaemonThread

boolean isUseDaemonThread()

setUseDaemonThread

void setUseDaemonThread(boolean useDaemonThread)

getThreadPriority

int getThreadPriority()

setThreadPriority

void setThreadPriority(int threadPriority)

getEventHandlers

java.util.List getEventHandlers()

getShutdownWait

long getShutdownWait()

setShutdownWait

void setShutdownWait(long shutdownWait)

addEventHandler

void addEventHandler(SyslogServerEventHandlerIF eventHandler)

insertEventHandler

void insertEventHandler(int pos,
                        SyslogServerEventHandlerIF eventHandler)

removeEventHandler

void removeEventHandler(SyslogServerEventHandlerIF eventHandler)

removeAllEventHandlers

void removeAllEventHandlers()

isUseStructuredData

boolean isUseStructuredData()

setUseStructuredData

void setUseStructuredData(boolean useStructuredData)

getDateTimeFormatter

java.lang.Object getDateTimeFormatter()

setDateTimeFormatter

void setDateTimeFormatter(java.lang.Object dateTimeFormatter)