Logback Core Module 1.5.1 · ch.qos.logback.core.net.SyslogAppenderBase

Field Summary

Modifier and Type	Field and Description
pack-priv Charset	charset
pack-priv String	facilityStr
pack-priv Layout<E>	layout
pack-priv static final int	MAX_MESSAGE_SIZE_LIMIT
pack-priv int	maxMessageSize
pack-priv int	port
pack-priv SyslogOutputStream	sos
protected String	suffixPattern
pack-priv static final String	SYSLOG_LAYOUT_URL
pack-priv String	syslogHost

Inherited from ch.qos.logback.core.AppenderBase:: name started

Constructor Summary

Access	Constructor and Description
public	SyslogAppenderBase()

Method Summary

Modifier and Type	Method and Description
protected void	append(E eventObject) Implements abstract ch.qos.logback.core.AppenderBase.append.
public abstract Layout<E>	buildLayout()
public abstract SyslogOutputStream	createOutputStream()
public static int	facilityStringToint(String facilityStr) Returns the integer value corresponding to the named syslog facility.
public Charset	getCharset() Returns the Charset used to encode String messages into byte sequences when writing to syslog.
public String	getFacility() Returns the string value of the Facility option.
public Layout<E>	getLayout()
public int	getMaxMessageSize()
public int	getPort()
public abstract int	getSeverityForEvent(Object eventObject)
public String	getSuffixPattern() See `setSuffixPattern(String)`.
public String	getSyslogHost() Returns the value of the SyslogHost option.
protected void	postProcess(Object event, OutputStream sw)
public void	setCharset(Charset charset) The Charset to use when encoding messages into byte sequences.
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.
public void	setLayout(Layout<E> layout)
public void	setMaxMessageSize(int maxMessageSize) Maximum size for the syslog message (in characters); messages longer than this are truncated.
public void	setPort(int port) The port number on the syslog server to connect to.
public void	setSuffixPattern(String suffixPattern) The suffixPattern option specifies the format of the non-standardized part of the message sent to the syslog server.
public void	setSyslogHost(String syslogHost) The SyslogHost option is the name of the syslog host where log output should go Warning If the SyslogHost is not set, then this appender will fail.
public void	start() Overrides ch.qos.logback.core.AppenderBase.start. Implements ch.qos.logback.core.spi.LifeCycle.start.
public void	stop() Overrides ch.qos.logback.core.AppenderBase.stop. Implements ch.qos.logback.core.spi.LifeCycle.stop.

Inherited from ch.qos.logback.core.AppenderBase:: addFilter clearAllFilters doAppend getCopyOfAttachedFiltersList getFilterChainDecision getName isStarted setName toString

Field Detail

charset	back to summary
pack-priv Charset charset

facilityStr	back to summary
pack-priv String facilityStr

layout	back to summary
pack-priv Layout<E> layout

layout

back to summary

pack-priv Layout<E> layout

MAX_MESSAGE_SIZE_LIMIT	back to summary
pack-priv static final int MAX_MESSAGE_SIZE_LIMIT

maxMessageSize	back to summary
pack-priv int maxMessageSize

port	back to summary
pack-priv int port

sos	back to summary
pack-priv SyslogOutputStream sos

suffixPattern	back to summary
protected String suffixPattern

SYSLOG_LAYOUT_URL	back to summary
pack-priv static final String SYSLOG_LAYOUT_URL

syslogHost	back to summary
pack-priv String syslogHost

Constructor Detail

SyslogAppenderBase	back to summary
public SyslogAppenderBase()

Method Detail

append	back to summary
protected void append(E eventObject) Implements abstract ch.qos.logback.core.AppenderBase.append. Annotations @Override

append

back to summary

protected void append(E eventObject)

Implements abstract ch.qos.logback.core.AppenderBase.append.

Annotations

@Override

buildLayout	back to summary
public abstract Layout<E> buildLayout()

createOutputStream	back to summary
public abstract SyslogOutputStream createOutputStream() throws UnknownHostException, SocketException

facilityStringToint	back to summary
public static int facilityStringToint(String facilityStr) Returns the integer value corresponding to the named syslog facility. Exceptions IllegalArgumentException: if the facility string is not recognized

facilityStringToint

back to summary

public static int facilityStringToint(String facilityStr)

Returns the integer value corresponding to the named syslog facility.

Exceptions

IllegalArgumentException:: if the facility string is not recognized

getCharset	back to summary
public Charset getCharset() Returns the Charset used to encode String messages into byte sequences when writing to syslog.

getFacility	back to summary
public String getFacility() Returns the string value of the Facility option. See `setFacility` for the set of allowed values.

getLayout	back to summary
public Layout<E> getLayout()

getMaxMessageSize	back to summary
public int getMaxMessageSize()

getPort	back to summary
public int getPort()

getSeverityForEvent	back to summary
public abstract int getSeverityForEvent(Object eventObject)

getSuffixPattern	back to summary
public String getSuffixPattern() See `setSuffixPattern(String)`.

getSyslogHost	back to summary
public String getSyslogHost() Returns the value of the SyslogHost option.

postProcess	back to summary
protected void postProcess(Object event, OutputStream sw)

setCharset	back to summary
public void setCharset(Charset charset) The Charset to use when encoding messages into byte sequences.

setFacility back to summary

setFacility	back to summary
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.

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.

setLayout	back to summary
public void setLayout(Layout<E> layout)

setMaxMessageSize	back to summary
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.

setPort	back to summary
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.

setSuffixPattern	back to summary
public void setSuffixPattern(String suffixPattern) The suffixPattern option specifies the format of the non-standardized part of the message sent to the syslog server.

setSyslogHost	back to summary
public void setSyslogHost(String syslogHost) The SyslogHost option is the name of the syslog host where log output should go Warning If the SyslogHost is not set, then this appender will fail.