org.productivity.java.syslog4j.impl.net.tcp.pool
Class PooledTCPNetSyslogConfig

java.lang.Object
  extended by org.productivity.java.syslog4j.impl.AbstractSyslogConfig
      extended by org.productivity.java.syslog4j.impl.net.AbstractNetSyslogConfig
          extended by org.productivity.java.syslog4j.impl.net.tcp.TCPNetSyslogConfig
              extended by org.productivity.java.syslog4j.impl.net.tcp.pool.PooledTCPNetSyslogConfig
All Implemented Interfaces:
java.io.Serializable, AbstractSyslogConfigIF, AbstractNetSyslogConfigIF, TCPNetSyslogConfigIF, SyslogCharSetIF, SyslogConfigIF, SyslogConstants, SyslogPoolConfigIF
Direct Known Subclasses:
PooledSSLTCPNetSyslogConfig

public class PooledTCPNetSyslogConfig
extends TCPNetSyslogConfig
implements SyslogPoolConfigIF

NetSyslogPoolFactory is an implementation of SyslogPoolConfigIF which provides configuration support for the Apache Commons Pool.

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: PooledTCPNetSyslogConfig.java,v 1.3 2008/11/26 15:01:47 cvs Exp $
Author:
<syslog4j@productivity.org>
See Also:
Serialized Form

Field Summary
protected  int maxActive
           
protected  int maxIdle
           
protected  long maxWait
           
protected  long minEvictableIdleTimeMillis
           
protected  int minIdle
           
protected  int numTestsPerEvictionRun
           
protected  long softMinEvictableIdleTimeMillis
           
protected  boolean testOnBorrow
           
protected  boolean testOnReturn
           
protected  boolean testWhileIdle
           
protected  long timeBetweenEvictionRunsMillis
           
protected  byte whenExhaustedAction
           
 
Fields inherited from class org.productivity.java.syslog4j.impl.net.tcp.TCPNetSyslogConfig
delimiterSequence, freshConnectionInterval, keepAlive, persistentConnection, reuseAddress, setBufferSize, soLinger, soLingerSeconds, SYSTEM_DELIMITER_SEQUENCE
 
Fields inherited from class org.productivity.java.syslog4j.impl.net.AbstractNetSyslogConfig
cacheHostAddress, host, maxQueueSize, 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
PooledTCPNetSyslogConfig()
           
PooledTCPNetSyslogConfig(int facility)
           
PooledTCPNetSyslogConfig(int facility, java.lang.String host)
           
PooledTCPNetSyslogConfig(int facility, java.lang.String host, int port)
           
PooledTCPNetSyslogConfig(java.lang.String host)
           
PooledTCPNetSyslogConfig(java.lang.String host, int port)
           
 
Method Summary
protected  void configureThreadedValues(int value)
           
 int getMaxActive()
           
 int getMaxIdle()
           
 long getMaxWait()
           
 long getMinEvictableIdleTimeMillis()
           
 int getMinIdle()
           
 int getNumTestsPerEvictionRun()
           
 long getSoftMinEvictableIdleTimeMillis()
           
 java.lang.Class getSyslogClass()
           
 long getTimeBetweenEvictionRunsMillis()
           
 byte getWhenExhaustedAction()
           
 boolean isTestOnBorrow()
           
 boolean isTestOnReturn()
           
 boolean isTestWhileIdle()
           
 void setMaxActive(int maxActive)
           
 void setMaxIdle(int maxIdle)
           
 void setMaxWait(long maxWait)
           
 void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)
           
 void setMinIdle(int minIdle)
           
 void setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
           
 void setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)
           
 void setTestOnBorrow(boolean testOnBorrow)
           
 void setTestOnReturn(boolean testOnReturn)
           
 void setTestWhileIdle(boolean testWhileIdle)
           
 void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)
           
 void setWhenExhaustedAction(byte whenExhaustedAction)
           
 
Methods inherited from class org.productivity.java.syslog4j.impl.net.tcp.TCPNetSyslogConfig
getDelimiterSequence, getFreshConnectionInterval, getSoLingerSeconds, getSyslogWriterClass, initialize, isKeepAlive, isPersistentConnection, isReuseAddress, isSetBufferSize, isSoLinger, setDelimiterSequence, setDelimiterSequence, setFreshConnectionInterval, setKeepAlive, setPersistentConnection, setReuseAddress, setSetBufferSize, setSoLinger, setSoLingerSeconds
 
Methods inherited from class org.productivity.java.syslog4j.impl.net.AbstractNetSyslogConfig
getHost, getMaxQueueSize, getPort, isCacheHostAddress, setCacheHostAddress, setHost, setMaxQueueSize, setPort
 
Methods inherited from class org.productivity.java.syslog4j.impl.AbstractSyslogConfig
_getBackLogHandlers, _getMessageModifiers, addBackLogHandler, addMessageModifier, getBackLogHandlers, getCharSet, getFacility, getIdent, getLocalName, getMaxMessageLength, getMaxShutdownWait, getMessageModifiers, getSplitMessageBeginText, getSplitMessageEndText, 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.net.AbstractNetSyslogConfigIF
isCacheHostAddress, setCacheHostAddress
 
Methods inherited from interface org.productivity.java.syslog4j.impl.AbstractSyslogConfigIF
getBackLogHandlers, getMaxQueueSize, getMaxShutdownWait, getMessageModifiers, getSplitMessageBeginText, getSplitMessageEndText, getThreadLoopInterval, getThreadPriority, getWriteRetries, isThreaded, isUseDaemonThread, setMaxQueueSize, setMaxShutdownWait, setSplitMessageBeginText, setSplitMessageEndText, setThreaded, setThreadLoopInterval, setThreadPriority, setUseDaemonThread, setWriteRetries
 
Methods inherited from interface org.productivity.java.syslog4j.SyslogConfigIF
addBackLogHandler, addMessageModifier, getCharSet, getFacility, getHost, getIdent, getLocalName, getMaxMessageLength, getPort, 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
 

Field Detail

maxActive

protected int maxActive

maxIdle

protected int maxIdle

maxWait

protected long maxWait

minEvictableIdleTimeMillis

protected long minEvictableIdleTimeMillis

minIdle

protected int minIdle

numTestsPerEvictionRun

protected int numTestsPerEvictionRun

softMinEvictableIdleTimeMillis

protected long softMinEvictableIdleTimeMillis

timeBetweenEvictionRunsMillis

protected long timeBetweenEvictionRunsMillis

whenExhaustedAction

protected byte whenExhaustedAction

testOnBorrow

protected boolean testOnBorrow

testOnReturn

protected boolean testOnReturn

testWhileIdle

protected boolean testWhileIdle
Constructor Detail

PooledTCPNetSyslogConfig

public PooledTCPNetSyslogConfig()

PooledTCPNetSyslogConfig

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

PooledTCPNetSyslogConfig

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

PooledTCPNetSyslogConfig

public PooledTCPNetSyslogConfig(int facility)

PooledTCPNetSyslogConfig

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

PooledTCPNetSyslogConfig

public PooledTCPNetSyslogConfig(java.lang.String host)
Method Detail

configureThreadedValues

protected void configureThreadedValues(int value)

getMaxActive

public int getMaxActive()
Specified by:
getMaxActive in interface SyslogPoolConfigIF

setMaxActive

public void setMaxActive(int maxActive)
Specified by:
setMaxActive in interface SyslogPoolConfigIF

getMaxIdle

public int getMaxIdle()
Specified by:
getMaxIdle in interface SyslogPoolConfigIF

setMaxIdle

public void setMaxIdle(int maxIdle)
Specified by:
setMaxIdle in interface SyslogPoolConfigIF

getMaxWait

public long getMaxWait()
Specified by:
getMaxWait in interface SyslogPoolConfigIF

setMaxWait

public void setMaxWait(long maxWait)
Specified by:
setMaxWait in interface SyslogPoolConfigIF

getMinEvictableIdleTimeMillis

public long getMinEvictableIdleTimeMillis()
Specified by:
getMinEvictableIdleTimeMillis in interface SyslogPoolConfigIF

setMinEvictableIdleTimeMillis

public void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)
Specified by:
setMinEvictableIdleTimeMillis in interface SyslogPoolConfigIF

getMinIdle

public int getMinIdle()
Specified by:
getMinIdle in interface SyslogPoolConfigIF

setMinIdle

public void setMinIdle(int minIdle)
Specified by:
setMinIdle in interface SyslogPoolConfigIF

getNumTestsPerEvictionRun

public int getNumTestsPerEvictionRun()
Specified by:
getNumTestsPerEvictionRun in interface SyslogPoolConfigIF

setNumTestsPerEvictionRun

public void setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
Specified by:
setNumTestsPerEvictionRun in interface SyslogPoolConfigIF

getSoftMinEvictableIdleTimeMillis

public long getSoftMinEvictableIdleTimeMillis()
Specified by:
getSoftMinEvictableIdleTimeMillis in interface SyslogPoolConfigIF

setSoftMinEvictableIdleTimeMillis

public void setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)
Specified by:
setSoftMinEvictableIdleTimeMillis in interface SyslogPoolConfigIF

getTimeBetweenEvictionRunsMillis

public long getTimeBetweenEvictionRunsMillis()
Specified by:
getTimeBetweenEvictionRunsMillis in interface SyslogPoolConfigIF

setTimeBetweenEvictionRunsMillis

public void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)
Specified by:
setTimeBetweenEvictionRunsMillis in interface SyslogPoolConfigIF

getWhenExhaustedAction

public byte getWhenExhaustedAction()
Specified by:
getWhenExhaustedAction in interface SyslogPoolConfigIF

setWhenExhaustedAction

public void setWhenExhaustedAction(byte whenExhaustedAction)
Specified by:
setWhenExhaustedAction in interface SyslogPoolConfigIF

isTestOnBorrow

public boolean isTestOnBorrow()
Specified by:
isTestOnBorrow in interface SyslogPoolConfigIF

setTestOnBorrow

public void setTestOnBorrow(boolean testOnBorrow)
Specified by:
setTestOnBorrow in interface SyslogPoolConfigIF

isTestOnReturn

public boolean isTestOnReturn()
Specified by:
isTestOnReturn in interface SyslogPoolConfigIF

setTestOnReturn

public void setTestOnReturn(boolean testOnReturn)
Specified by:
setTestOnReturn in interface SyslogPoolConfigIF

isTestWhileIdle

public boolean isTestWhileIdle()
Specified by:
isTestWhileIdle in interface SyslogPoolConfigIF

setTestWhileIdle

public void setTestWhileIdle(boolean testWhileIdle)
Specified by:
setTestWhileIdle in interface SyslogPoolConfigIF

getSyslogClass

public java.lang.Class getSyslogClass()
Specified by:
getSyslogClass in interface SyslogConfigIF
Overrides:
getSyslogClass in class TCPNetSyslogConfig