ch.qos.logback.core.net

Class SyslogAppenderBase<E>

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.AppenderBase<E>

ch.qos.logback.core.net.SyslogAppenderBase<E>

Type Parameters:

E - type of log event object

All Implemented Interfaces:

Appender<E>, ContextAware, FilterAttachable<E>, LifeCycle

Direct Known Subclasses:

SyslogAppender

public abstract class SyslogAppenderBase<E>
extends AppenderBase<E>

Base class for SyslogAppender.

Field Summary

Fields

Modifier and Type	Field and Description
protected SyslogOutputStream	sos
protected String	suffixPattern

Fields inherited from class ch.qos.logback.core.AppenderBase

name, started

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor and Description
SyslogAppenderBase()

Method Summary

Modifier and Type	Method and Description
protected void	append(E eventObject)
abstract Layout<E>	buildLayout()
static int	facilityStringToint(String facilityStr) Returns the integer value corresponding to the named syslog facility.
String	getFacility() Returns the string value of the Facility option.
Layout<E>	getLayout()
boolean	getLazy() Gets the enable status of lazy initialization of the Syslog output stream
int	getMaxMessageSize() Gets the maximum size of a syslog message
int	getPort() Gets the syslog port to connect to
abstract int	getSeverityForEvent(Object eventObject)
String	getSuffixPattern() See setSuffixPattern(String).
String	getSyslogHost() Returns the value of the SyslogHost option.
protected void	postProcess(Object event, OutputStream sw)
void	setFacility(String facilityStr) The Facility option must be set one of the strings KERN, USER, MAIL, DAEMON, AUTH, SYSLOG, LPR, NEWS, UUCP, CRON, AUTHPRIV, FTP, NTP, AUDIT, ALERT, CLOCK, LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
void	setLayout(Layout<E> layout)
void	setLazy(boolean enable) Enables/disables lazy initialization of the Syslog output stream.
void	setMaxMessageSize(int maxMessageSize) Maximum size for the syslog message (in characters); messages longer than this are truncated.
void	setPort(int port) The port number on the syslog server to connect to.
void	setSuffixPattern(String suffixPattern) The suffixPattern option specifies the format of the non-standardized part of the message sent to the syslog server.
void	setSyslogHost(String syslogHost) The SyslogHost option is the name of the the syslog host where log output should go.
void	start()
void	stop()

Methods inherited from class ch.qos.logback.core.AppenderBase

addFilter, clearAllFilters, doAppend, getCopyOfAttachedFiltersList, getFilterChainDecision, getName, isStarted, setName, toString

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

Field Detail

suffixPattern

protected String suffixPattern

sos

protected SyslogOutputStream sos

Constructor Detail

SyslogAppenderBase

public SyslogAppenderBase()

Method Detail

start

public void start()

Specified by:

start in interface LifeCycle

Overrides:

start in class AppenderBase<E>

buildLayout

public abstract Layout<E> buildLayout()

getSeverityForEvent

public abstract int getSeverityForEvent(Object eventObject)

append

protected void append(E eventObject)

Specified by:

append in class AppenderBase<E>

postProcess

protected void postProcess(Object event,
                           OutputStream sw)

facilityStringToint

public static int facilityStringToint(String facilityStr)

Returns the integer value corresponding to the named syslog facility.

Parameters:

facilityStr - the syslog facility name

Returns:

the syslog facility code

Throws:

IllegalArgumentException - if the facility string is not recognized

getSyslogHost

public String getSyslogHost()

Returns the value of the SyslogHost option.

Returns:

the syslog hostname

setSyslogHost

public void setSyslogHost(String syslogHost)

The SyslogHost option is the name of the the syslog host where log output should go. WARNING If the SyslogHost is not set, then this appender will fail.

Parameters:

syslogHost - the syslog hostname

getFacility

public String getFacility()

Returns the string value of the Facility option. See setFacility(java.lang.String) for the set of allowed values.

Returns:

the current facility name

setFacility

public void setFacility(String facilityStr)

The Facility option must be set one of the strings KERN, USER, MAIL, DAEMON, AUTH, SYSLOG, LPR, NEWS, UUCP, CRON, AUTHPRIV, FTP, NTP, AUDIT, ALERT, CLOCK, LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7. Case is not important.

See SyslogConstants and RFC 3164 for more information about the Facility option.

Parameters:

facilityStr - the name of the desired facility

getPort

public int getPort()

Gets the syslog port to connect to

Returns:

the syslog port

setPort

public void setPort(int port)

The port number on the syslog server to connect to. Normally, you would not want to change the default value, that is 514.

Parameters:

port - the desired syslog port

getMaxMessageSize

public int getMaxMessageSize()

Gets the maximum size of a syslog message

Returns:

the max message size (in characters)

setMaxMessageSize

public void setMaxMessageSize(int maxMessageSize)

Maximum size for the syslog message (in characters); messages longer than this are truncated. The default value is 65400 (which is near the maximum for syslog-over-UDP). Note that the value is characters; the number of bytes may vary if non-ASCII characters are present.

Parameters:

maxMessageSize - the max message size (in characters)

getLayout

public Layout<E> getLayout()

setLayout

public void setLayout(Layout<E> layout)

getLazy

public boolean getLazy()

Gets the enable status of lazy initialization of the Syslog output stream

Returns:

true if enabled; false otherwise

setLazy

public void setLazy(boolean enable)

Enables/disables lazy initialization of the Syslog output stream. This defers the connection process until the first outgoing message.

Parameters:

enable - true to enable lazy initialization; false otherwise

stop

public void stop()

Specified by:

stop in interface LifeCycle

Overrides:

stop in class AppenderBase<E>

getSuffixPattern

public String getSuffixPattern()

See setSuffixPattern(String).

Returns:

the suffix pattern

setSuffixPattern

public void setSuffixPattern(String suffixPattern)

The suffixPattern option specifies the format of the non-standardized part of the message sent to the syslog server.

Parameters:

suffixPattern - the desired suffix pattern