SyslogConfigIF (syslog4j-graylog2 0.9.60 API)

All Superinterfaces:

Serializable, SyslogCharSetIF, SyslogConstants

All Known Subinterfaces:

AbstractNetSyslogConfigIF, AbstractSyslogConfigIF, SSLTCPNetSyslogConfigIF, TCPNetSyslogConfigIF

All Known Implementing Classes:

AbstractNetSyslogConfig, AbstractSyslogConfig, MultipleSyslogConfig, PooledSSLTCPNetSyslogConfig, PooledTCPNetSyslogConfig, SSLTCPNetSyslogConfig, TCPNetSyslogConfig, UDPNetSyslogConfig, UnixSocketSyslogConfig, UnixSyslogConfig
```
public interface SyslogConfigIF
extends SyslogConstants, SyslogCharSetIF
```
SyslogConfigIF provides a common, extensible configuration interface for all implementations of SyslogIF.

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: SyslogConfigIF.java,v 1.19 2010/11/28 04:15:18 cvs Exp $

Author:

<syslog4j@productivity.org>

Field Summary
- 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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addBackLogHandler(SyslogBackLogHandlerIF backLogHandler)`
`void`	`addMessageModifier(SyslogMessageModifierIF messageModifier)`
`String`	`getCharSet()`
`int`	`getFacility()`
`String`	`getHost()`
`String`	`getIdent()`
`String`	`getLocalName()`
`int`	`getMaxMessageLength()`
`int`	`getPort()`
`Class`	`getSyslogClass()`
`void`	`insertBackLogHandler(int index, SyslogBackLogHandlerIF backLogHandler)`
`void`	`insertMessageModifier(int index, SyslogMessageModifierIF messageModifier)`
`boolean`	`isIncludeIdentInMessageModifier()`
`boolean`	`isSendLocalName()`
`boolean`	`isSendLocalTimestamp()`
`boolean`	`isThrowExceptionOnInitialize()`
`boolean`	`isThrowExceptionOnWrite()`
`boolean`	`isTruncateMessage()`
`boolean`	`isUseStructuredData()`
`void`	`removeAllBackLogHandlers()`
`void`	`removeAllMessageModifiers()`
`void`	`removeBackLogHandler(SyslogBackLogHandlerIF backLogHandler)`
`void`	`removeMessageModifier(SyslogMessageModifierIF messageModifier)`
`void`	`setCharSet(String charSet)`
`void`	`setFacility(int facility)`
`void`	`setFacility(String facilityName)`
`void`	`setHost(String host)`
`void`	`setIdent(String ident)`
`void`	`setIncludeIdentInMessageModifier(boolean throwExceptionOnInitialize)`
`void`	`setLocalName(String localName)`
`void`	`setMaxMessageLength(int maxMessageLength)`
`void`	`setPort(int port)`
`void`	`setSendLocalName(boolean sendLocalName)`
`void`	`setSendLocalTimestamp(boolean sendLocalTimestamp)`
`void`	`setThrowExceptionOnInitialize(boolean throwExceptionOnInitialize)`
`void`	`setThrowExceptionOnWrite(boolean throwExceptionOnWrite)`
`void`	`setTruncateMessage(boolean truncateMessage)`
`void`	`setUseStructuredData(boolean useStructuredData)`

Method Detail

getSyslogClass
```
Class getSyslogClass()
```

getFacility
```
int getFacility()
```

setFacility
```
void setFacility(int facility)
```

setFacility
```
void setFacility(String facilityName)
```

getPort
```
int getPort()
```

setPort

void setPort(int port)
      throws SyslogRuntimeException

Throws:: SyslogRuntimeException

getLocalName
```
String getLocalName()
```

setLocalName

void setLocalName(String localName)
           throws SyslogRuntimeException

Throws:: SyslogRuntimeException

getHost
```
String getHost()
```

setHost

void setHost(String host)
      throws SyslogRuntimeException

Throws:: SyslogRuntimeException

getIdent
```
String getIdent()
```

setIdent
```
void setIdent(String ident)
```

getCharSet
```
String getCharSet()
```
Specified by:

getCharSet in interface SyslogCharSetIF

setCharSet
```
void setCharSet(String charSet)
```
Specified by:

setCharSet in interface SyslogCharSetIF

isIncludeIdentInMessageModifier

boolean isIncludeIdentInMessageModifier()

setIncludeIdentInMessageModifier

void setIncludeIdentInMessageModifier(boolean throwExceptionOnInitialize)

isThrowExceptionOnInitialize
```
boolean isThrowExceptionOnInitialize()
```

setThrowExceptionOnInitialize

void setThrowExceptionOnInitialize(boolean throwExceptionOnInitialize)

isThrowExceptionOnWrite
```
boolean isThrowExceptionOnWrite()
```

setThrowExceptionOnWrite

void setThrowExceptionOnWrite(boolean throwExceptionOnWrite)

isSendLocalTimestamp
```
boolean isSendLocalTimestamp()
```

setSendLocalTimestamp

void setSendLocalTimestamp(boolean sendLocalTimestamp)

isSendLocalName
```
boolean isSendLocalName()
```

setSendLocalName

void setSendLocalName(boolean sendLocalName)

isTruncateMessage
```
boolean isTruncateMessage()
```

setTruncateMessage

void setTruncateMessage(boolean truncateMessage)

isUseStructuredData
```
boolean isUseStructuredData()
```

setUseStructuredData

void setUseStructuredData(boolean useStructuredData)

getMaxMessageLength
```
int getMaxMessageLength()
```

setMaxMessageLength

void setMaxMessageLength(int maxMessageLength)

addMessageModifier

void addMessageModifier(SyslogMessageModifierIF messageModifier)

insertMessageModifier

void insertMessageModifier(int index,
                           SyslogMessageModifierIF messageModifier)

removeMessageModifier

void removeMessageModifier(SyslogMessageModifierIF messageModifier)

removeAllMessageModifiers
```
void removeAllMessageModifiers()
```

addBackLogHandler

void addBackLogHandler(SyslogBackLogHandlerIF backLogHandler)

insertBackLogHandler

void insertBackLogHandler(int index,
                          SyslogBackLogHandlerIF backLogHandler)

removeBackLogHandler

void removeBackLogHandler(SyslogBackLogHandlerIF backLogHandler)

removeAllBackLogHandlers
```
void removeAllBackLogHandlers()
```

Interface SyslogConfigIF

Field Summary

Fields inherited from interface org.graylog2.syslog4j.SyslogConstants

Method Summary

Method Detail

getSyslogClass

getFacility

setFacility

setFacility

getPort

setPort

getLocalName

setLocalName

getHost

setHost

getIdent

setIdent

getCharSet

setCharSet

isIncludeIdentInMessageModifier

setIncludeIdentInMessageModifier

isThrowExceptionOnInitialize

setThrowExceptionOnInitialize

isThrowExceptionOnWrite

setThrowExceptionOnWrite

isSendLocalTimestamp

setSendLocalTimestamp

isSendLocalName

setSendLocalName

isTruncateMessage

setTruncateMessage

isUseStructuredData

setUseStructuredData

getMaxMessageLength

setMaxMessageLength

addMessageModifier

insertMessageModifier

removeMessageModifier

removeAllMessageModifiers

addBackLogHandler

insertBackLogHandler

removeBackLogHandler

removeAllBackLogHandlers