Package org.apache.logging.log4j.core.appender

Class SyslogAppender.Builder<B extends SyslogAppender.Builder<B>>

java.lang.Object

org.apache.logging.log4j.core.filter.AbstractFilterable.Builder<B>

org.apache.logging.log4j.core.appender.AbstractAppender.Builder<B>

org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender.Builder<B>

org.apache.logging.log4j.core.appender.SocketAppender.AbstractBuilder<B>

org.apache.logging.log4j.core.appender.SyslogAppender.Builder<B>

All Implemented Interfaces:

Builder<SocketAppender>

Enclosing class:

SyslogAppender

public static class SyslogAppender.Builder<B extends SyslogAppender.Builder<B>>
extends SocketAppender.AbstractBuilder<B>
implements Builder<SocketAppender>

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	appName
private java.nio.charset.Charset	charsetName
private java.lang.String	enterpriseNumber
private java.lang.String	escapeNL
private java.lang.String	eventPrefix
private java.lang.String	exceptionPattern
private java.lang.String	excludes
private Facility	facility
private java.lang.String	format
private java.lang.String	id
private boolean	includeMdc
private java.lang.String	includes
private LoggerFields[]	loggerFields
private java.lang.String	mdcId
private java.lang.String	mdcPrefix
private java.lang.String	msgId
private boolean	newLine
private java.lang.String	required

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SyslogAppender	build()	Builds the object after all configuration has been set.
java.lang.String	getAppName()
java.nio.charset.Charset	getCharsetName()
java.lang.String	getEnterpriseNumber()
java.lang.String	getEscapeNL()
java.lang.String	getEventPrefix()
java.lang.String	getExceptionPattern()
java.lang.String	getExcludes()
Facility	getFacility()
java.lang.String	getFormat()
java.lang.String	getId()
java.lang.String	getIncludes()
LoggerFields[]	getLoggerFields()
java.lang.String	getMdcId()
java.lang.String	getMdcPrefix()
java.lang.String	getMsgId()
java.lang.String	getRequired()
boolean	isIncludeMdc()
boolean	isNewLine()
B	setAppName(java.lang.String appName)
B	setCharsetName(java.nio.charset.Charset charset)
B	setEnterpriseNumber(int enterpriseNumber)	Deprecated. Use setEnterpriseNumber(String) instead
B	setEnterpriseNumber(java.lang.String enterpriseNumber)
B	setEscapeNL(java.lang.String escapeNL)
B	setEventPrefix(java.lang.String eventPrefix)
B	setExceptionPattern(java.lang.String exceptionPattern)
B	setExcludes(java.lang.String excludes)
B	setFacility(Facility facility)
B	setFormat(java.lang.String format)
B	setId(java.lang.String id)
B	setIncludeMdc(boolean includeMdc)
B	setIncludes(java.lang.String includes)
B	setLoggerFields(LoggerFields[] loggerFields)
B	setMdcId(java.lang.String mdcId)
B	setMdcPrefix(java.lang.String mdcPrefix)
B	setMsgId(java.lang.String msgId)
B	setNewLine(boolean newLine)
B	setRequired(java.lang.String required)

Methods inherited from class org.apache.logging.log4j.core.appender.SocketAppender.AbstractBuilder

getAdvertise, getConnectTimeoutMillis, getHost, getImmediateFail, getPort, getProtocol, getReconnectDelayMillis, getSocketOptions, getSslConfiguration, setAdvertise, setConnectTimeoutMillis, setHost, setImmediateFail, setPort, setProtocol, setReconnectDelayMillis, setSocketOptions, setSslConfiguration, withAdvertise, withConnectTimeoutMillis, withHost, withImmediateFail, withPort, withProtocol, withReconnectDelayMillis, withSocketOptions, withSslConfiguration

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender.Builder

getBufferSize, isBufferedIo, isImmediateFlush, setBufferedIo, setBufferSize, setImmediateFlush, withBufferedIo, withBufferSize, withImmediateFlush

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender.Builder

getConfiguration, getErrorPrefix, getLayout, getName, getOrCreateLayout, getOrCreateLayout, isIgnoreExceptions, setConfiguration, setIgnoreExceptions, setLayout, setName, withConfiguration, withIgnoreExceptions, withLayout, withName

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable.Builder

asBuilder, getFilter, getPropertyArray, setFilter, setPropertyArray, withFilter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.util.Builder

getErrorPrefix, isValid

Field Detail

facility

@PluginBuilderAttribute("facility")
private Facility facility

id

@PluginBuilderAttribute("id")
private java.lang.String id

enterpriseNumber

@PluginBuilderAttribute("enterpriseNumber")
private java.lang.String enterpriseNumber

includeMdc

@PluginBuilderAttribute("includeMdc")
private boolean includeMdc

mdcId

@PluginBuilderAttribute("mdcId")
private java.lang.String mdcId

mdcPrefix

@PluginBuilderAttribute("mdcPrefix")
private java.lang.String mdcPrefix

eventPrefix

@PluginBuilderAttribute("eventPrefix")
private java.lang.String eventPrefix

newLine

@PluginBuilderAttribute("newLine")
private boolean newLine

escapeNL

@PluginBuilderAttribute("newLineEscape")
private java.lang.String escapeNL

appName

@PluginBuilderAttribute("appName")
private java.lang.String appName

msgId

@PluginBuilderAttribute("messageId")
private java.lang.String msgId

excludes

@PluginBuilderAttribute("mdcExcludes")
private java.lang.String excludes

includes

@PluginBuilderAttribute("mdcIncludes")
private java.lang.String includes

required

@PluginBuilderAttribute("mdcRequired")
private java.lang.String required

format

@PluginBuilderAttribute("format")
private java.lang.String format

charsetName

@PluginBuilderAttribute("charset")
private java.nio.charset.Charset charsetName

exceptionPattern

@PluginBuilderAttribute("exceptionPattern")
private java.lang.String exceptionPattern

loggerFields

@PluginElement("LoggerFields")
private LoggerFields[] loggerFields

Constructor Detail

Builder

public Builder()

Method Detail

build

public SyslogAppender build()

Description copied from interface: Builder

Builds the object after all configuration has been set. This will use default values for any unspecified attributes for the object.

Specified by:

build in interface Builder<B extends SyslogAppender.Builder<B>>

Returns:

the configured instance.

getFacility

public Facility getFacility()

getId

public java.lang.String getId()

getEnterpriseNumber

public java.lang.String getEnterpriseNumber()

isIncludeMdc

public boolean isIncludeMdc()

getMdcId

public java.lang.String getMdcId()

getMdcPrefix

public java.lang.String getMdcPrefix()

getEventPrefix

public java.lang.String getEventPrefix()

isNewLine

public boolean isNewLine()

getEscapeNL

public java.lang.String getEscapeNL()

getAppName

public java.lang.String getAppName()

getMsgId

public java.lang.String getMsgId()

getExcludes

public java.lang.String getExcludes()

getIncludes

public java.lang.String getIncludes()

getRequired

public java.lang.String getRequired()

getFormat

public java.lang.String getFormat()

getCharsetName

public java.nio.charset.Charset getCharsetName()

getExceptionPattern

public java.lang.String getExceptionPattern()

getLoggerFields

public LoggerFields[] getLoggerFields()

setFacility

public B setFacility(Facility facility)

setId

public B setId(java.lang.String id)

setEnterpriseNumber

public B setEnterpriseNumber(java.lang.String enterpriseNumber)

setEnterpriseNumber

public B setEnterpriseNumber(int enterpriseNumber)

Deprecated.

Use setEnterpriseNumber(String) instead

setIncludeMdc

public B setIncludeMdc(boolean includeMdc)

setMdcId

public B setMdcId(java.lang.String mdcId)

setMdcPrefix

public B setMdcPrefix(java.lang.String mdcPrefix)

setEventPrefix

public B setEventPrefix(java.lang.String eventPrefix)

setNewLine

public B setNewLine(boolean newLine)

setEscapeNL

public B setEscapeNL(java.lang.String escapeNL)

setAppName

public B setAppName(java.lang.String appName)

setMsgId

public B setMsgId(java.lang.String msgId)

setExcludes

public B setExcludes(java.lang.String excludes)

setIncludes

public B setIncludes(java.lang.String includes)

setRequired

public B setRequired(java.lang.String required)

setFormat

public B setFormat(java.lang.String format)

setCharsetName

public B setCharsetName(java.nio.charset.Charset charset)

setExceptionPattern

public B setExceptionPattern(java.lang.String exceptionPattern)

setLoggerFields

public B setLoggerFields(LoggerFields[] loggerFields)