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

Class Rfc5424Layout.Rfc5424LayoutBuilder

java.lang.Object

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

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

Field Summary

Fields

Modifier and Type	Field	Description
private String	appName	The value to use as the APP-NAME in the RFC 5424 syslog record.
private String	ein	The enterprise number to include in SD-ID identifiers.
private Integer	enterpriseNumber	The enterprise number to include in SD-ID identifiers.
private String	escapeNL	Same as newLineEscape.
private String	eventPrefix	A prefix to add to event key names when formatting StructuredDataMessage fields.
private String	exceptionPattern	The pattern used to format exceptions appended to the syslog message.
private String	excludes	Same as mdcExcludes.
private Facility	facility	The name of the Facility as described in RFC 5424
private String	id	The default SD-ID as described in RFC 5424.
private boolean	includeMDC	Indicates whether data from the context map will be included as RFC 5424 SD-ELEMENT.
private boolean	includeNL	Same as newLine.
private String	includes	Same as mdcIncludes.
private LoggerFields[]	loggerFields	Optional additional SD-ELEMENTs.
private String	mdcExcludes	A comma separated list of MDC keys that should be excluded from the LogEvent.
private String	mdcId	The id to use for the MDC Structured Data Element.
private String	mdcIncludes	A comma separated list of MDC keys that should be included in the LogEvent.
private String	mdcPrefix	A prefix to add to MDC key names when formatting them as structured data parameters.
private String	mdcRequired	A comma separated list of MDC keys that must be present in the MDC.
private String	messageId	The default value to be used in the MSGID field of RFC 5424 syslog records.
private boolean	newLine	If true, a newline will be appended to the end of the syslog record.
private String	newLineEscape	If set, this string will be used to replace new lines within the message text.
private String	required	Same as mdcRequired.
private boolean	useTlsMessageFormat	If true the message will be formatted according to RFC 5425.
private boolean	useTLSMessageFormat	Same as useTlsMessageFormat.

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

Field Details

facility

@PluginBuilderAttribute
private Facility facility

The name of the Facility as described in RFC 5424

The matching is case-insensitive. Defaults to LOCAL0.

id

@PluginBuilderAttribute
private String id

The default SD-ID as described in RFC 5424.

ein

@PluginBuilderAttribute
private String ein

The enterprise number to include in SD-ID identifiers.

Can contain multiple integers separated by a dot, for example 32473.1

Defaults to 32473.

enterpriseNumber

@PluginBuilderAttribute
private Integer enterpriseNumber

The enterprise number to include in SD-ID identifiers.

Limited to a single integer.

Defaults to 32473.

includeMDC

@PluginBuilderAttribute
private boolean includeMDC

Indicates whether data from the context map will be included as RFC 5424 SD-ELEMENT.

Defaults to true.

newLine

@PluginBuilderAttribute
private boolean newLine

If true, a newline will be appended to the end of the syslog record.

Default is false.

includeNL

@PluginBuilderAttribute
private boolean includeNL

Same as newLine.

Erroneously introduced in version 2.21.0, but kept for compatibility.

newLineEscape

@PluginBuilderAttribute
private String newLineEscape

If set, this string will be used to replace new lines within the message text.

By default, new lines are not escaped.

escapeNL

@PluginBuilderAttribute
private String escapeNL

Same as newLineEscape.

Erroneously introduced in version 2.21.0, but kept for compatibility.

mdcId

@PluginBuilderAttribute
private String mdcId

The id to use for the MDC Structured Data Element.

Defaults to "mdc".

mdcPrefix

@PluginBuilderAttribute
private String mdcPrefix

A prefix to add to MDC key names when formatting them as structured data parameters.

eventPrefix

@PluginBuilderAttribute
private String eventPrefix

A prefix to add to event key names when formatting StructuredDataMessage fields.

appName

@PluginBuilderAttribute
private String appName

The value to use as the APP-NAME in the RFC 5424 syslog record.

messageId

@PluginBuilderAttribute
private String messageId

The default value to be used in the MSGID field of RFC 5424 syslog records.

If the log event contains a StructuredDataMessage, the id from that message will be used instead.

mdcExcludes

@PluginBuilderAttribute
private String mdcExcludes

A comma separated list of MDC keys that should be excluded from the LogEvent.

Mutually exclusive with mdcIncludes.

excludes

@PluginBuilderAttribute
private String excludes

Same as mdcExcludes.

Erroneously introduced in version 2.21.0, but kept for compatibility.

mdcIncludes

@PluginBuilderAttribute
private String mdcIncludes

A comma separated list of MDC keys that should be included in the LogEvent.

Mutually exclusive with mdcExcludes.

includes

@PluginBuilderAttribute
private String includes

Same as mdcIncludes.

Erroneously introduced in version 2.21.0, but kept for compatibility.

mdcRequired

@PluginBuilderAttribute
private String mdcRequired

A comma separated list of MDC keys that must be present in the MDC.

required

@PluginBuilderAttribute
private String required

Same as mdcRequired.

Erroneously introduced in version 2.21.0, but kept for compatibility.

exceptionPattern

@PluginBuilderAttribute
private String exceptionPattern

The pattern used to format exceptions appended to the syslog message.

useTlsMessageFormat

@PluginBuilderAttribute
private boolean useTlsMessageFormat

If true the message will be formatted according to RFC 5425.

Default is false.

useTLSMessageFormat

@PluginBuilderAttribute
private boolean useTLSMessageFormat

Same as useTlsMessageFormat.

Erroneously introduced in version 2.21.0, but kept for compatibility.

loggerFields

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

Optional additional SD-ELEMENTs.

Each LoggerFields entry contains a set of key/value patterns to produce structured data parameters.

Constructor Details

Rfc5424LayoutBuilder

public Rfc5424LayoutBuilder()

Method Details

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.