Syslog4jAppenderSkeleton (syslog4j-graylog2 0.9.60 API)

java.lang.Object
- org.apache.log4j.AppenderSkeleton
- - org.graylog2.syslog4j.impl.log4j.Syslog4jAppenderSkeleton

All Implemented Interfaces:

Serializable, org.apache.log4j.Appender, org.apache.log4j.spi.OptionHandler, SyslogConstants

Direct Known Subclasses:

Syslog4jAppender
```
public abstract class Syslog4jAppenderSkeleton
extends org.apache.log4j.AppenderSkeleton
implements SyslogConstants
```
Syslog4jAppenderSkeleton provides an extensible Log4j Appender wrapper for Syslog4j.

Classes which inherit Syslog4jAppenderSkeleton must implement the "initialize()" method, which sets up Syslog4j for use by the Log4j Appender.

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: Syslog4jAppenderSkeleton.java,v 1.8 2011/01/23 20:49:12 cvs Exp $

Author:

<syslog4j@productivity.org>

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`charSet`
`protected String`	`facility`
`protected String`	`host`
`protected String`	`ident`
`protected boolean`	`initialized`
`protected String`	`localName`
`protected String`	`maxMessageLength`
`protected String`	`maxShutdownWait`
`protected String`	`port`
`protected String`	`protocol`
`protected String`	`splitMessageBeginText`
`protected String`	`splitMessageEndText`
`protected SyslogIF`	`syslog`
`protected String`	`threaded`
`protected String`	`threadLoopInterval`
`protected String`	`truncateMessage`
`protected String`	`useStructuredData`
`protected String`	`writeRetries`

Fields inherited from class org.apache.log4j.AppenderSkeleton
closed, errorHandler, headFilter, layout, name, tailFilter, threshold

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

Syslog4jAppenderSkeleton()

Constructors
Constructor and Description
`Syslog4jAppenderSkeleton()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`_initialize()`
`protected void`	`append(org.apache.log4j.spi.LoggingEvent event)`
`void`	`close()`
`String`	`getCharSet()`
`String`	`getFacility()`
`String`	`getHost()`
`String`	`getIdent()`
`String`	`getLocalName()`
`String`	`getMaxMessageLength()`
`String`	`getMaxShutdownWait()`
`String`	`getPort()`
`String`	`getProtocol()`
`String`	`getSplitMessageBeginText()`
`String`	`getSplitMessageEndText()`
`String`	`getThreaded()`
`String`	`getThreadLoopInterval()`
`String`	`getTruncateMessage()`
`String`	`getUseStructuredData()`
`String`	`getWriteRetries()`
`abstract String`	`initialize()`
`protected static boolean`	`isTrueOrOn(String value)`
`boolean`	`requiresLayout()`
`void`	`setCharSet(String charSet)`
`void`	`setFacility(String facility)`
`void`	`setHost(String host)`
`void`	`setIdent(String ident)`
`void`	`setLocalName(String localName)`
`void`	`setMaxMessageLength(String maxMessageLength)`
`void`	`setMaxShutdownWait(String maxShutdownWait)`
`void`	`setPort(String port)`
`void`	`setProtocol(String protocol)`
`void`	`setSplitMessageBeginText(String splitMessageBeginText)`
`void`	`setSplitMessageEndText(String splitMessageEndText)`
`void`	`setThreaded(String threaded)`
`void`	`setThreadLoopInterval(String threadLoopInterval)`
`void`	`setTruncateMessage(String truncateMessage)`
`void`	`setUseStructuredData(String useStructuredData)`
`void`	`setWriteRetries(String writeRetries)`

Methods inherited from class org.apache.log4j.AppenderSkeleton
activateOptions, addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

syslog
```
protected SyslogIF syslog
```

ident
```
protected String ident
```

localName
```
protected String localName
```

protocol
```
protected String protocol
```

facility
```
protected String facility
```

host
```
protected String host
```

port
```
protected String port
```

charSet
```
protected String charSet
```

threaded
```
protected String threaded
```

threadLoopInterval
```
protected String threadLoopInterval
```

splitMessageBeginText
```
protected String splitMessageBeginText
```

splitMessageEndText
```
protected String splitMessageEndText
```

maxMessageLength
```
protected String maxMessageLength
```

maxShutdownWait
```
protected String maxShutdownWait
```

writeRetries
```
protected String writeRetries
```

truncateMessage
```
protected String truncateMessage
```

useStructuredData
```
protected String useStructuredData
```

initialized
```
protected boolean initialized
```

Constructor Detail
- Syslog4jAppenderSkeleton
```
public Syslog4jAppenderSkeleton()
```

Method Detail

initialize

public abstract String initialize()
                           throws SyslogRuntimeException

Throws:: SyslogRuntimeException

isTrueOrOn

protected static boolean isTrueOrOn(String value)

_initialize
```
protected void _initialize()
```

getProtocol
```
public String getProtocol()
```

setProtocol

public void setProtocol(String protocol)

append
```
protected void append(org.apache.log4j.spi.LoggingEvent event)
```
Specified by:

append in class org.apache.log4j.AppenderSkeleton

close
```
public void close()
```
Specified by:

close in interface org.apache.log4j.Appender

getFacility
```
public String getFacility()
```

setFacility

public void setFacility(String facility)

getHost
```
public String getHost()
```

setHost
```
public void setHost(String host)
```

getLocalName
```
public String getLocalName()
```

setLocalName

public void setLocalName(String localName)

getPort
```
public String getPort()
```

setPort
```
public void setPort(String port)
```

getCharSet
```
public String getCharSet()
```

setCharSet

public void setCharSet(String charSet)

getIdent
```
public String getIdent()
```

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

getThreaded
```
public String getThreaded()
```

setThreaded

public void setThreaded(String threaded)

requiresLayout
```
public boolean requiresLayout()
```
Specified by:

requiresLayout in interface org.apache.log4j.Appender

getThreadLoopInterval
```
public String getThreadLoopInterval()
```

setThreadLoopInterval

public void setThreadLoopInterval(String threadLoopInterval)

getSplitMessageBeginText

public String getSplitMessageBeginText()

setSplitMessageBeginText

public void setSplitMessageBeginText(String splitMessageBeginText)

getSplitMessageEndText

public String getSplitMessageEndText()

setSplitMessageEndText

public void setSplitMessageEndText(String splitMessageEndText)

getMaxMessageLength
```
public String getMaxMessageLength()
```

setMaxMessageLength

public void setMaxMessageLength(String maxMessageLength)

getMaxShutdownWait
```
public String getMaxShutdownWait()
```

setMaxShutdownWait

public void setMaxShutdownWait(String maxShutdownWait)

getWriteRetries
```
public String getWriteRetries()
```

setWriteRetries

public void setWriteRetries(String writeRetries)

getTruncateMessage
```
public String getTruncateMessage()
```

setTruncateMessage

public void setTruncateMessage(String truncateMessage)

getUseStructuredData
```
public String getUseStructuredData()
```

setUseStructuredData

public void setUseStructuredData(String useStructuredData)

Class Syslog4jAppenderSkeleton

Field Summary

Fields inherited from class org.apache.log4j.AppenderSkeleton

Fields inherited from interface org.graylog2.syslog4j.SyslogConstants

Constructor Summary

Method Summary

Methods inherited from class org.apache.log4j.AppenderSkeleton

Methods inherited from class java.lang.Object

Field Detail

syslog

ident

localName

protocol

facility

host

port

charSet

threaded

threadLoopInterval

splitMessageBeginText

splitMessageEndText

maxMessageLength

maxShutdownWait

writeRetries

truncateMessage

useStructuredData

initialized

Constructor Detail

Syslog4jAppenderSkeleton

Method Detail

initialize

isTrueOrOn

_initialize

getProtocol

setProtocol

append

close

getFacility

setFacility

getHost

setHost

getLocalName

setLocalName

getPort

setPort

getCharSet

setCharSet

getIdent

setIdent

getThreaded

setThreaded

requiresLayout

getThreadLoopInterval

setThreadLoopInterval

getSplitMessageBeginText

setSplitMessageBeginText

getSplitMessageEndText

setSplitMessageEndText

getMaxMessageLength

setMaxMessageLength

getMaxShutdownWait

setMaxShutdownWait

getWriteRetries

setWriteRetries

getTruncateMessage

setTruncateMessage

getUseStructuredData

setUseStructuredData