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 String	appName
private Charset	charsetName
private String	enterpriseNumber
private String	escapeNL
private String	eventPrefix
private String	exceptionPattern
private String	excludes
private Facility	facility
private String	format
private String	id
private boolean	includeMdc
private String	includes
private LoggerFields[]	loggerFields
private String	mdcId
private String	mdcPrefix
private String	msgId
private boolean	newLine
private 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.
String	getAppName()
Charset	getCharsetName()
String	getEnterpriseNumber()
String	getEscapeNL()
String	getEventPrefix()
String	getExceptionPattern()
String	getExcludes()
Facility	getFacility()
String	getFormat()
String	getId()
String	getIncludes()
LoggerFields[]	getLoggerFields()
String	getMdcId()
String	getMdcPrefix()
String	getMsgId()
String	getRequired()
boolean	isIncludeMdc()
boolean	isNewLine()
B	setAppName(String appName)
B	setCharsetName(Charset charset)
B	setEnterpriseNumber(int enterpriseNumber)	Deprecated. Use setEnterpriseNumber(String) instead
B	setEnterpriseNumber(String enterpriseNumber)
B	setEscapeNL(String escapeNL)
B	setEventPrefix(String eventPrefix)
B	setExceptionPattern(String exceptionPattern)
B	setExcludes(String excludes)
B	setFacility(Facility facility)
B	setFormat(String format)
B	setId(String id)
B	setIncludeMdc(boolean includeMdc)
B	setIncludes(String includes)
B	setLoggerFields(LoggerFields[] loggerFields)
B	setMdcId(String mdcId)
B	setMdcPrefix(String mdcPrefix)
B	setMsgId(String msgId)
B	setNewLine(boolean newLine)
B	setRequired(String required)

Methods inherited from class 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 AbstractOutputStreamAppender.Builder

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

Methods inherited from class AbstractAppender.Builder

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

Methods inherited from class AbstractFilterable.Builder

asBuilder, getFilter, getPropertyArray, setFilter, setPropertyArray, withFilter

Methods inherited from class Object

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

Methods inherited from interface Builder

getErrorPrefix, isValid

Field Details

facility

@PluginBuilderAttribute("facility")
private Facility facility

id

@PluginBuilderAttribute("id")
private String id

enterpriseNumber

@PluginBuilderAttribute("enterpriseNumber")
private String enterpriseNumber

includeMdc

@PluginBuilderAttribute("includeMdc")
private boolean includeMdc

mdcId

@PluginBuilderAttribute("mdcId")
private String mdcId

mdcPrefix

@PluginBuilderAttribute("mdcPrefix")
private String mdcPrefix

eventPrefix

@PluginBuilderAttribute("eventPrefix")
private String eventPrefix

newLine

@PluginBuilderAttribute("newLine")
private boolean newLine

escapeNL

@PluginBuilderAttribute("newLineEscape")
private String escapeNL

appName

@PluginBuilderAttribute("appName")
private String appName

msgId

@PluginBuilderAttribute("messageId")
private String msgId

excludes

@PluginBuilderAttribute("mdcExcludes")
private String excludes

includes

@PluginBuilderAttribute("mdcIncludes")
private String includes

required

@PluginBuilderAttribute("mdcRequired")
private String required

format

@PluginBuilderAttribute("format")
private String format

charsetName

@PluginBuilderAttribute("charset")
private Charset charsetName

exceptionPattern

@PluginBuilderAttribute("exceptionPattern")
private String exceptionPattern

loggerFields

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

Constructor Details

Builder

public Builder()

Method Details

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 String getId()

getEnterpriseNumber

public String getEnterpriseNumber()

isIncludeMdc

public boolean isIncludeMdc()

getMdcId

public String getMdcId()

getMdcPrefix

public String getMdcPrefix()

getEventPrefix

public String getEventPrefix()

isNewLine

public boolean isNewLine()

getEscapeNL

public String getEscapeNL()

getAppName

public String getAppName()

getMsgId

public String getMsgId()

getExcludes

public String getExcludes()

getIncludes

public String getIncludes()

getRequired

public String getRequired()

getFormat

public String getFormat()

getCharsetName

public Charset getCharsetName()

getExceptionPattern

public String getExceptionPattern()

getLoggerFields

public LoggerFields[] getLoggerFields()

setFacility

public B setFacility(Facility facility)

setId

public B setId(String id)

setEnterpriseNumber

public B setEnterpriseNumber(String enterpriseNumber)

setEnterpriseNumber

public B setEnterpriseNumber(int enterpriseNumber)

Deprecated.

Use setEnterpriseNumber(String) instead

setIncludeMdc

public B setIncludeMdc(boolean includeMdc)

setMdcId

public B setMdcId(String mdcId)

setMdcPrefix

public B setMdcPrefix(String mdcPrefix)

setEventPrefix

public B setEventPrefix(String eventPrefix)

setNewLine

public B setNewLine(boolean newLine)

setEscapeNL

public B setEscapeNL(String escapeNL)

setAppName

public B setAppName(String appName)

setMsgId

public B setMsgId(String msgId)

setExcludes

public B setExcludes(String excludes)

setIncludes

public B setIncludes(String includes)

setRequired

public B setRequired(String required)

setFormat

public B setFormat(String format)

setCharsetName

public B setCharsetName(Charset charset)

setExceptionPattern

public B setExceptionPattern(String exceptionPattern)

setLoggerFields

public B setLoggerFields(LoggerFields[] loggerFields)