SyslogAppender.Builder (log4j-core 2.12.0)

java.lang.Object
- org.apache.logging.log4j.core.filter.AbstractFilterable.Builder
- - org.apache.logging.log4j.core.appender.AbstractAppender.Builder
 - - org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender.Builder
 - - org.apache.logging.log4j.core.appender.SocketAppender.AbstractBuilder
 - org.apache.logging.log4j.core.appender.SyslogAppender.Builder

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>

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SyslogAppender`	`build()` Builds the object after all configuration has been set.
`String`	`getAppName()`
`Charset`	`getCharsetName()`
`int`	`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)`
`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 org.apache.logging.log4j.core.appender.SocketAppender.AbstractBuilder
getAdvertise, getConnectTimeoutMillis, getHost, getImmediateFail, getPort, getProtocol, getReconnectDelayMillis, getSocketOptions, getSslConfiguration, withAdvertise, withConnectTimeoutMillis, withHost, withImmediateFail, withPort, withProtocol, withReconnectDelayMillis, withSocketOptions, withSslConfiguration

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender.Builder
getBufferSize, isBufferedIo, isImmediateFlush, withBufferedIo, withBufferSize, withImmediateFlush

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender.Builder
getConfiguration, 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

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<SocketAppender>

Returns:

the configured instance.

getFacility
```
public Facility getFacility()
```

getId
```
public String getId()
```

getEnterpriseNumber
```
public int 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(int enterpriseNumber)

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)

Copyright © 1999-2019 The Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

getFacility

getId

getEnterpriseNumber

isIncludeMdc

getMdcId

getMdcPrefix

getEventPrefix

isNewLine

getEscapeNL

getAppName

getMsgId

getExcludes

getIncludes

getRequired

getFormat

getCharsetName

getExceptionPattern

getLoggerFields

setFacility

setId

setEnterpriseNumber

setIncludeMdc

setMdcId

setMdcPrefix

setEventPrefix

setNewLine