TCPNetSyslogConfig (syslog4j-graylog2 0.9.60 API)

java.lang.Object
- org.graylog2.syslog4j.impl.AbstractSyslogConfig
- - org.graylog2.syslog4j.impl.net.AbstractNetSyslogConfig
  - - org.graylog2.syslog4j.impl.net.tcp.TCPNetSyslogConfig

All Implemented Interfaces:

Serializable, AbstractSyslogConfigIF, AbstractNetSyslogConfigIF, TCPNetSyslogConfigIF, SyslogCharSetIF, SyslogConfigIF, SyslogConstants

Direct Known Subclasses:

PooledTCPNetSyslogConfig, SSLTCPNetSyslogConfig
```
public class TCPNetSyslogConfig
extends AbstractNetSyslogConfig
implements TCPNetSyslogConfigIF
```
TCPNetSyslogConfig is an extension of AbstractNetSyslogConfig that provides configuration support for TCP/IP-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: TCPNetSyslogConfig.java,v 1.18 2010/10/29 03:14:12 cvs Exp $

Author:

<syslog4j@productivity.org>

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected byte[]`	`delimiterSequence`
`protected int`	`freshConnectionInterval`
`protected boolean`	`keepAlive`
`protected boolean`	`persistentConnection`
`protected boolean`	`reuseAddress`
`protected boolean`	`setBufferSize`
`protected boolean`	`soLinger`
`protected int`	`soLingerSeconds`
`static byte[]`	`SYSTEM_DELIMITER_SEQUENCE`

Fields inherited from class org.graylog2.syslog4j.impl.net.AbstractNetSyslogConfig
cacheHostAddress, host, maxQueueSize, port

Fields inherited from class org.graylog2.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.graylog2.syslog4j.SyslogConstants
AF_UNIX, CACHE_HOST_ADDRESS_DEFAULT, CHAR_SET_DEFAULT, CRLF, FACILITY_ALERT, FACILITY_AUDIT, FACILITY_AUTH, FACILITY_AUTHPRIV, FACILITY_CLOCK2, 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_NTP, 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_MESSAGE_LENGTH_RFC5424, 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_DATEFORMAT_RFC5424, 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

Constructors
Constructor and Description
`TCPNetSyslogConfig()`
`TCPNetSyslogConfig(int facility)`
`TCPNetSyslogConfig(int facility, String host)`
`TCPNetSyslogConfig(int facility, String host, int port)`
`TCPNetSyslogConfig(String host)`
`TCPNetSyslogConfig(String host, int port)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`getDelimiterSequence()`
`int`	`getFreshConnectionInterval()`
`int`	`getSoLingerSeconds()`
`Class`	`getSyslogClass()`
`Class`	`getSyslogWriterClass()`
`protected void`	`initialize()`
`boolean`	`isKeepAlive()`
`boolean`	`isPersistentConnection()`
`boolean`	`isReuseAddress()`
`boolean`	`isSetBufferSize()`
`boolean`	`isSoLinger()`
`boolean`	`isUseOctetCounting()`
`void`	`setDelimiterSequence(byte[] delimiterSequence)`
`void`	`setDelimiterSequence(String delimiterSequence)`
`void`	`setFreshConnectionInterval(int freshConnectionInterval)`
`void`	`setKeepAlive(boolean keepAlive)`
`void`	`setPersistentConnection(boolean persistentConnection)`
`void`	`setReuseAddress(boolean reuseAddress)`
`void`	`setSetBufferSize(boolean setBufferSize)`
`void`	`setSoLinger(boolean soLinger)`
`void`	`setSoLingerSeconds(int soLingerSeconds)`
`void`	`setUseOctetCounting(boolean useOctetCounting)`

Methods inherited from class org.graylog2.syslog4j.impl.net.AbstractNetSyslogConfig
getHost, getMaxQueueSize, getPort, isCacheHostAddress, setCacheHostAddress, setHost, setMaxQueueSize, setPort

Methods inherited from class org.graylog2.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.graylog2.syslog4j.impl.net.AbstractNetSyslogConfigIF
isCacheHostAddress, setCacheHostAddress

Methods inherited from interface org.graylog2.syslog4j.impl.AbstractSyslogConfigIF
getBackLogHandlers, getMaxQueueSize, getMaxShutdownWait, getMessageModifiers, getSplitMessageBeginText, getSplitMessageEndText, getThreadLoopInterval, getThreadPriority, getWriteRetries, isThreaded, isUseDaemonThread, setMaxQueueSize, setMaxShutdownWait, setSplitMessageBeginText, setSplitMessageEndText, setThreaded, setThreadLoopInterval, setThreadPriority, setUseDaemonThread, setWriteRetries

- Field Detail
  - SYSTEM_DELIMITER_SEQUENCE
```
public static byte[] SYSTEM_DELIMITER_SEQUENCE
```
  - delimiterSequence
```
protected byte[] delimiterSequence
```
  - persistentConnection
```
protected boolean persistentConnection
```
  - soLinger
```
protected boolean soLinger
```
  - soLingerSeconds
```
protected int soLingerSeconds
```
  - keepAlive
```
protected boolean keepAlive
```
  - reuseAddress
```
protected boolean reuseAddress
```
  - setBufferSize
```
protected boolean setBufferSize
```
  - freshConnectionInterval
```
protected int freshConnectionInterval
```
- Constructor Detail
  - TCPNetSyslogConfig
```
public TCPNetSyslogConfig()
```
  - TCPNetSyslogConfig
```
public TCPNetSyslogConfig(int facility,
                          String host,
                          int port)
```
  - TCPNetSyslogConfig
```
public TCPNetSyslogConfig(int facility,
                          String host)
```
  - TCPNetSyslogConfig
```
public TCPNetSyslogConfig(int facility)
```
  - TCPNetSyslogConfig
```
public TCPNetSyslogConfig(String host,
                          int port)
```
  - TCPNetSyslogConfig
```
public TCPNetSyslogConfig(String host)
```
- Method Detail
  - initialize
```
protected void initialize()
```
  - getSyslogClass
```
public Class getSyslogClass()
```
    Specified by:
    
    getSyslogClass in interface SyslogConfigIF
    
    Specified by:
    
    getSyslogClass in class AbstractSyslogConfig
  - getDelimiterSequence
```
public byte[] getDelimiterSequence()
```
    Specified by:
    
    getDelimiterSequence in interface TCPNetSyslogConfigIF
  - setDelimiterSequence
```
public void setDelimiterSequence(byte[] delimiterSequence)
```
    Specified by:
    
    setDelimiterSequence in interface TCPNetSyslogConfigIF
  - setDelimiterSequence
```
public void setDelimiterSequence(String delimiterSequence)
```
  - isPersistentConnection
```
public boolean isPersistentConnection()
```
    Specified by:
    
    isPersistentConnection in interface TCPNetSyslogConfigIF
  - setPersistentConnection
```
public void setPersistentConnection(boolean persistentConnection)
```
    Specified by:
    
    setPersistentConnection in interface TCPNetSyslogConfigIF
  - isSoLinger
```
public boolean isSoLinger()
```
    Specified by:
    
    isSoLinger in interface TCPNetSyslogConfigIF
  - setSoLinger
```
public void setSoLinger(boolean soLinger)
```
    Specified by:
    
    setSoLinger in interface TCPNetSyslogConfigIF
  - getSoLingerSeconds
```
public int getSoLingerSeconds()
```
    Specified by:
    
    getSoLingerSeconds in interface TCPNetSyslogConfigIF
  - setSoLingerSeconds
```
public void setSoLingerSeconds(int soLingerSeconds)
```
    Specified by:
    
    setSoLingerSeconds in interface TCPNetSyslogConfigIF
  - isKeepAlive
```
public boolean isKeepAlive()
```
    Specified by:
    
    isKeepAlive in interface TCPNetSyslogConfigIF
  - setKeepAlive
```
public void setKeepAlive(boolean keepAlive)
```
    Specified by:
    
    setKeepAlive in interface TCPNetSyslogConfigIF
  - isReuseAddress
```
public boolean isReuseAddress()
```
    Specified by:
    
    isReuseAddress in interface TCPNetSyslogConfigIF
  - setReuseAddress
```
public void setReuseAddress(boolean reuseAddress)
```
    Specified by:
    
    setReuseAddress in interface TCPNetSyslogConfigIF
  - isSetBufferSize
```
public boolean isSetBufferSize()
```
    Specified by:
    
    isSetBufferSize in interface TCPNetSyslogConfigIF
  - setSetBufferSize
```
public void setSetBufferSize(boolean setBufferSize)
```
    Specified by:
    
    setSetBufferSize in interface TCPNetSyslogConfigIF
  - getFreshConnectionInterval
```
public int getFreshConnectionInterval()
```
    Specified by:
    
    getFreshConnectionInterval in interface TCPNetSyslogConfigIF
  - setFreshConnectionInterval
```
public void setFreshConnectionInterval(int freshConnectionInterval)
```
    Specified by:
    
    setFreshConnectionInterval in interface TCPNetSyslogConfigIF
  - setUseOctetCounting
```
public void setUseOctetCounting(boolean useOctetCounting)
```
    Specified by:
    
    setUseOctetCounting in interface TCPNetSyslogConfigIF
  - isUseOctetCounting
```
public boolean isUseOctetCounting()
```
    Specified by:
    
    isUseOctetCounting in interface TCPNetSyslogConfigIF
  - getSyslogWriterClass
```
public Class getSyslogWriterClass()
```
    Specified by:
    
    getSyslogWriterClass in interface AbstractSyslogConfigIF
    
    Overrides:
    
    getSyslogWriterClass in class AbstractSyslogConfig

Class TCPNetSyslogConfig

Field Summary

Fields inherited from class org.graylog2.syslog4j.impl.net.AbstractNetSyslogConfig

Fields inherited from class org.graylog2.syslog4j.impl.AbstractSyslogConfig

Fields inherited from interface org.graylog2.syslog4j.SyslogConstants

Constructor Summary

Method Summary

Methods inherited from class org.graylog2.syslog4j.impl.net.AbstractNetSyslogConfig

Methods inherited from class org.graylog2.syslog4j.impl.AbstractSyslogConfig

Methods inherited from class java.lang.Object

Methods inherited from interface org.graylog2.syslog4j.impl.net.AbstractNetSyslogConfigIF

Methods inherited from interface org.graylog2.syslog4j.impl.AbstractSyslogConfigIF

Methods inherited from interface org.graylog2.syslog4j.SyslogConfigIF

Field Detail

SYSTEM_DELIMITER_SEQUENCE

delimiterSequence

persistentConnection

soLinger

soLingerSeconds

keepAlive

reuseAddress

setBufferSize

freshConnectionInterval

Constructor Detail

TCPNetSyslogConfig

TCPNetSyslogConfig

TCPNetSyslogConfig

TCPNetSyslogConfig

TCPNetSyslogConfig

TCPNetSyslogConfig

Method Detail

initialize

getSyslogClass

getDelimiterSequence

setDelimiterSequence

setDelimiterSequence

isPersistentConnection

setPersistentConnection

isSoLinger

setSoLinger

getSoLingerSeconds

setSoLingerSeconds

isKeepAlive

setKeepAlive

isReuseAddress

setReuseAddress

isSetBufferSize

setSetBufferSize

getFreshConnectionInterval

setFreshConnectionInterval

setUseOctetCounting

isUseOctetCounting

getSyslogWriterClass