Package org.apache.logging.log4j.core.layout

Class Rfc5424Layout.Rfc5424LayoutBuilder

java.lang.Object

org.apache.logging.log4j.core.layout.AbstractLayout.Builder<B>

org.apache.logging.log4j.core.layout.AbstractStringLayout.Builder<Rfc5424Layout.Rfc5424LayoutBuilder>

org.apache.logging.log4j.core.layout.Rfc5424Layout.Rfc5424LayoutBuilder

All Implemented Interfaces:

Builder<Rfc5424Layout>

Enclosing class:

Rfc5424Layout

public static class Rfc5424Layout.Rfc5424LayoutBuilder
extends AbstractStringLayout.Builder<Rfc5424Layout.Rfc5424LayoutBuilder>
implements Builder<Rfc5424Layout>

Since:

2.21.0

Constructor Summary

Constructors

Constructor	Description
Rfc5424LayoutBuilder()

Method Summary

Modifier and Type	Method	Description
Rfc5424Layout	build()	Builds the object after all configuration has been set.
Rfc5424Layout.Rfc5424LayoutBuilder	setAppName(String appName)
Rfc5424Layout.Rfc5424LayoutBuilder	setCharset(Charset charset)
Rfc5424Layout.Rfc5424LayoutBuilder	setConfig(Configuration config)	Deprecated. Since 2.24.0 use AbstractLayout.Builder.setConfiguration(org.apache.logging.log4j.core.config.Configuration) instead.
Rfc5424Layout.Rfc5424LayoutBuilder	setEin(String ein)
Rfc5424Layout.Rfc5424LayoutBuilder	setEnterpriseNumber(Integer enterpriseNumber)
Rfc5424Layout.Rfc5424LayoutBuilder	setEscapeNL(String escapeNL)	Deprecated. Since 2.26.0 use setNewLineEscape(java.lang.String) instead.
Rfc5424Layout.Rfc5424LayoutBuilder	setEventPrefix(String eventPrefix)
Rfc5424Layout.Rfc5424LayoutBuilder	setExceptionPattern(String exceptionPattern)
Rfc5424Layout.Rfc5424LayoutBuilder	setExcludes(String excludes)	Deprecated. since 2.26.0 use setMdcExcludes(java.lang.String) instead
Rfc5424Layout.Rfc5424LayoutBuilder	setFacility(Facility facility)
Rfc5424Layout.Rfc5424LayoutBuilder	setId(String id)
Rfc5424Layout.Rfc5424LayoutBuilder	setIncludeMDC(boolean includeMDC)
Rfc5424Layout.Rfc5424LayoutBuilder	setIncludeNL(boolean includeNL)	Deprecated. Since 2.26.0 use setNewLine(boolean) instead.
Rfc5424Layout.Rfc5424LayoutBuilder	setIncludes(String includes)	Deprecated. since 2.26.0 use setMdcIncludes(java.lang.String) instead
Rfc5424Layout.Rfc5424LayoutBuilder	setLoggerFields(LoggerFields[] loggerFields)
Rfc5424Layout.Rfc5424LayoutBuilder	setMdcExcludes(String mdcExcludes)
Rfc5424Layout.Rfc5424LayoutBuilder	setMdcId(String mdcId)
Rfc5424Layout.Rfc5424LayoutBuilder	setMdcIncludes(String mdcIncludes)
Rfc5424Layout.Rfc5424LayoutBuilder	setMdcPrefix(String mdcPrefix)
Rfc5424Layout.Rfc5424LayoutBuilder	setMdcRequired(String mdcRequired)
Rfc5424Layout.Rfc5424LayoutBuilder	setMessageId(String messageId)
Rfc5424Layout.Rfc5424LayoutBuilder	setNewLine(boolean newLine)
Rfc5424Layout.Rfc5424LayoutBuilder	setNewLineEscape(String newLineEscape)
Rfc5424Layout.Rfc5424LayoutBuilder	setRequired(String required)	Deprecated. since 2.26.0 use setMdcRequired(java.lang.String) instead
Rfc5424Layout.Rfc5424LayoutBuilder	setUseTlsMessageFormat(boolean useTlsMessageFormat)
Rfc5424Layout.Rfc5424LayoutBuilder	setUseTLSMessageFormat(boolean useTLSMessageFormat)	Deprecated. since 2.26.0 use setUseTlsMessageFormat(boolean) instead

Methods inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout.Builder

getCharset, getFooterSerializer, getHeaderSerializer, setFooterSerializer, setHeaderSerializer

Methods inherited from class org.apache.logging.log4j.core.layout.AbstractLayout.Builder

asBuilder, getConfiguration, getFooter, getHeader, setConfiguration, setFooter, setHeader

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

Constructor Detail

Rfc5424LayoutBuilder

public Rfc5424LayoutBuilder()

Method Detail

setConfig

@Deprecated
public Rfc5424Layout.Rfc5424LayoutBuilder setConfig(Configuration config)

Deprecated.

Since 2.24.0 use AbstractLayout.Builder.setConfiguration(org.apache.logging.log4j.core.config.Configuration) instead.

setFacility

public Rfc5424Layout.Rfc5424LayoutBuilder setFacility(Facility facility)

setId

public Rfc5424Layout.Rfc5424LayoutBuilder setId(String id)

setEin

public Rfc5424Layout.Rfc5424LayoutBuilder setEin(String ein)

setIncludeMDC

public Rfc5424Layout.Rfc5424LayoutBuilder setIncludeMDC(boolean includeMDC)

setIncludeNL

@Deprecated
public Rfc5424Layout.Rfc5424LayoutBuilder setIncludeNL(boolean includeNL)

Deprecated.

Since 2.26.0 use setNewLine(boolean) instead.

setNewLine

public Rfc5424Layout.Rfc5424LayoutBuilder setNewLine(boolean newLine)

Since:

2.26.0

setEscapeNL

@Deprecated
public Rfc5424Layout.Rfc5424LayoutBuilder setEscapeNL(String escapeNL)

Deprecated.

Since 2.26.0 use setNewLineEscape(java.lang.String) instead.

setNewLineEscape

public Rfc5424Layout.Rfc5424LayoutBuilder setNewLineEscape(String newLineEscape)

Since:

2.26.0

setMdcId

public Rfc5424Layout.Rfc5424LayoutBuilder setMdcId(String mdcId)

setMdcPrefix

public Rfc5424Layout.Rfc5424LayoutBuilder setMdcPrefix(String mdcPrefix)

setEventPrefix

public Rfc5424Layout.Rfc5424LayoutBuilder setEventPrefix(String eventPrefix)

setAppName

public Rfc5424Layout.Rfc5424LayoutBuilder setAppName(String appName)

setMessageId

public Rfc5424Layout.Rfc5424LayoutBuilder setMessageId(String messageId)

setExcludes

@Deprecated
public Rfc5424Layout.Rfc5424LayoutBuilder setExcludes(String excludes)

Deprecated.

since 2.26.0 use setMdcExcludes(java.lang.String) instead

setMdcExcludes

public Rfc5424Layout.Rfc5424LayoutBuilder setMdcExcludes(String mdcExcludes)

Since:

2.26.0

setIncludes

@Deprecated
public Rfc5424Layout.Rfc5424LayoutBuilder setIncludes(String includes)

Deprecated.

since 2.26.0 use setMdcIncludes(java.lang.String) instead

setMdcIncludes

public Rfc5424Layout.Rfc5424LayoutBuilder setMdcIncludes(String mdcIncludes)

Since:

2.26.0

setRequired

@Deprecated
public Rfc5424Layout.Rfc5424LayoutBuilder setRequired(String required)

Deprecated.

since 2.26.0 use setMdcRequired(java.lang.String) instead

setMdcRequired

public Rfc5424Layout.Rfc5424LayoutBuilder setMdcRequired(String mdcRequired)

Since:

2.26.0

setCharset

public Rfc5424Layout.Rfc5424LayoutBuilder setCharset(Charset charset)

Overrides:

setCharset in class AbstractStringLayout.Builder<Rfc5424Layout.Rfc5424LayoutBuilder>

setExceptionPattern

public Rfc5424Layout.Rfc5424LayoutBuilder setExceptionPattern(String exceptionPattern)

setUseTLSMessageFormat

@Deprecated
public Rfc5424Layout.Rfc5424LayoutBuilder setUseTLSMessageFormat(boolean useTLSMessageFormat)

Deprecated.

since 2.26.0 use setUseTlsMessageFormat(boolean) instead

setUseTlsMessageFormat

public Rfc5424Layout.Rfc5424LayoutBuilder setUseTlsMessageFormat(boolean useTlsMessageFormat)

Since:

2.26.0

setLoggerFields

public Rfc5424Layout.Rfc5424LayoutBuilder setLoggerFields(LoggerFields[] loggerFields)

setEnterpriseNumber

public Rfc5424Layout.Rfc5424LayoutBuilder setEnterpriseNumber(Integer enterpriseNumber)

Since:

2.25.0

build

public Rfc5424Layout 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<Rfc5424Layout>

Returns:

the configured instance.