org.productivity.java.syslog4j.impl.net
Class AbstractNetSyslogConfig

java.lang.Object
  org.productivity.java.syslog4j.impl.AbstractSyslogConfig
      org.productivity.java.syslog4j.impl.net.AbstractNetSyslogConfig

All Implemented Interfaces:

java.io.Serializable, AbstractSyslogConfigIF, AbstractNetSyslogConfigIF, SyslogCharSetIF, SyslogConfigIF, SyslogConstants

Direct Known Subclasses:

TCPNetSyslogConfig, UDPNetSyslogConfig

public abstract class AbstractNetSyslogConfig
extends AbstractSyslogConfig
implements AbstractNetSyslogConfigIF

AbstractNetSyslogConfig is an abstract extension of AbstractSyslogConfig that provides configuration support for network-based syslog clients.

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: AbstractNetSyslogConfig.java,v 1.12 2010/10/25 03:50:25 cvs Exp $

Author:

<syslog4j@productivity.org>

See Also:

Serialized Form

Field Summary

protected boolean	cacheHostAddress
protected java.lang.String	host
protected int	maxQueueSize
protected int	port

Fields inherited from class org.productivity.java.syslog4j.impl.AbstractSyslogConfig

backLogHandlers, charSet, defaultBackLogHandlers, facility, ident, includeIdentInMessageModifier, localName, maxMessageLength, maxShutdownWait, messageModifiers, sendLocalName, sendLocalTimestamp, splitMessageBeginText, splitMessageEndText, threaded, threadLoopInterval, threadPriority, throwExceptionOnInitialize, throwExceptionOnWrite, truncateMessage, useDaemonThread, useStructuredData, writeRetries

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

Constructor Summary

AbstractNetSyslogConfig()

AbstractNetSyslogConfig(int facility)

AbstractNetSyslogConfig(int facility, java.lang.String host)

AbstractNetSyslogConfig(int facility, java.lang.String host, int port)

AbstractNetSyslogConfig(java.lang.String host)

AbstractNetSyslogConfig(java.lang.String host, int port)

Method Summary

java.lang.String	getHost()
int	getMaxQueueSize()
int	getPort()
boolean	isCacheHostAddress()
void	setCacheHostAddress(boolean cacheHostAddress)
void	setHost(java.lang.String host)
void	setMaxQueueSize(int maxQueueSize) Use the (default) value of -1 to allow for a queue of indefinite depth (size).
void	setPort(int port)

Methods inherited from class org.productivity.java.syslog4j.impl.AbstractSyslogConfig

_getBackLogHandlers, _getMessageModifiers, addBackLogHandler, addMessageModifier, getBackLogHandlers, getCharSet, getFacility, getIdent, getLocalName, getMaxMessageLength, getMaxShutdownWait, getMessageModifiers, getSplitMessageBeginText, getSplitMessageEndText, getSyslogClass, getSyslogWriterClass, getThreadLoopInterval, getThreadPriority, getWriteRetries, insertBackLogHandler, insertMessageModifier, isIncludeIdentInMessageModifier, isSendLocalName, isSendLocalTimestamp, isThreaded, isThrowExceptionOnInitialize, isThrowExceptionOnWrite, isTruncateMessage, isUseDaemonThread, isUseStructuredData, removeAllBackLogHandlers, removeAllMessageModifiers, removeBackLogHandler, removeMessageModifier, setBackLogHandlers, setCharSet, setFacility, setFacility, setIdent, setIncludeIdentInMessageModifier, setLocalName, setMaxMessageLength, setMaxShutdownWait, setMessageModifiers, setSendLocalName, setSendLocalTimestamp, setSplitMessageBeginText, setSplitMessageBeginText, setSplitMessageEndText, setSplitMessageEndText, setThreaded, setThreadLoopInterval, setThreadPriority, setThrowExceptionOnInitialize, setThrowExceptionOnWrite, setTruncateMessage, setUseDaemonThread, setUseStructuredData, setWriteRetries

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.productivity.java.syslog4j.impl.AbstractSyslogConfigIF

getBackLogHandlers, getMaxShutdownWait, getMessageModifiers, getSplitMessageBeginText, getSplitMessageEndText, getSyslogWriterClass, getThreadLoopInterval, getThreadPriority, getWriteRetries, isThreaded, isUseDaemonThread, setMaxShutdownWait, setSplitMessageBeginText, setSplitMessageEndText, setThreaded, setThreadLoopInterval, setThreadPriority, setUseDaemonThread, setWriteRetries

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

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

Field Detail

host

protected java.lang.String host

port

protected int port

cacheHostAddress

protected boolean cacheHostAddress

maxQueueSize

protected int maxQueueSize

Constructor Detail

AbstractNetSyslogConfig

public AbstractNetSyslogConfig()

AbstractNetSyslogConfig

public AbstractNetSyslogConfig(int facility)

AbstractNetSyslogConfig

public AbstractNetSyslogConfig(int facility,
                               java.lang.String host)

AbstractNetSyslogConfig

public AbstractNetSyslogConfig(java.lang.String host)

AbstractNetSyslogConfig

public AbstractNetSyslogConfig(int facility,
                               java.lang.String host,
                               int port)

AbstractNetSyslogConfig

public AbstractNetSyslogConfig(java.lang.String host,
                               int port)

Method Detail

isCacheHostAddress

public boolean isCacheHostAddress()

Specified by:

isCacheHostAddress in interface AbstractNetSyslogConfigIF

setCacheHostAddress

public void setCacheHostAddress(boolean cacheHostAddress)

Specified by:

setCacheHostAddress in interface AbstractNetSyslogConfigIF

getHost

public java.lang.String getHost()

Specified by:

getHost in interface SyslogConfigIF

setHost

public void setHost(java.lang.String host)

Specified by:

setHost in interface SyslogConfigIF

getPort

public int getPort()

Specified by:

getPort in interface SyslogConfigIF

setPort

public void setPort(int port)

Specified by:

setPort in interface SyslogConfigIF

getMaxQueueSize

public int getMaxQueueSize()

Specified by:

getMaxQueueSize in interface AbstractSyslogConfigIF

setMaxQueueSize

public void setMaxQueueSize(int maxQueueSize)

Description copied from interface: AbstractSyslogConfigIF

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

Specified by:

setMaxQueueSize in interface AbstractSyslogConfigIF