Class AbstractJacksonLayout

java.lang.Object

org.apache.logging.log4j.core.layout.AbstractLayout<String>

org.apache.logging.log4j.core.layout.AbstractStringLayout

org.apache.logging.log4j.core.layout.AbstractJacksonLayout

All Implemented Interfaces:

LocationAware, Layout<String>, Encoder<LogEvent>, StringLayout

Direct Known Subclasses:

JsonLayout, XmlLayout, YamlLayout

abstract class AbstractJacksonLayout
extends AbstractStringLayout

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractJacksonLayout.Builder<B extends AbstractJacksonLayout.Builder<B>>
static class	AbstractJacksonLayout.LogEventWithAdditionalFields
private static class	AbstractJacksonLayout.ReadOnlyLogEventWrapper
protected static class	AbstractJacksonLayout.ResolvableKeyValuePair

Nested classes/interfaces inherited from class AbstractStringLayout

AbstractStringLayout.Serializer, AbstractStringLayout.Serializer2

Field Summary

Fields

Modifier and Type	Field	Description
protected final AbstractJacksonLayout.ResolvableKeyValuePair[]	additionalFields
protected final boolean	compact
protected static final String	COMPACT_EOL
protected final boolean	complete
protected static final String	DEFAULT_EOL
protected final String	eol
protected final boolean	includeNullDelimiter
protected final com.fasterxml.jackson.databind.ObjectWriter	objectWriter

Fields inherited from class AbstractStringLayout

DEFAULT_STRING_BUILDER_SIZE, MAX_STRING_BUILDER_SIZE

Fields inherited from class AbstractLayout

configuration, eventCount, footer, header, LOGGER

Fields inherited from interface Layout

ELEMENT_TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractJacksonLayout(Configuration config, com.fasterxml.jackson.databind.ObjectWriter objectWriter, Charset charset, boolean compact, boolean complete, boolean eventEol, String endOfLine, AbstractStringLayout.Serializer headerSerializer, AbstractStringLayout.Serializer footerSerializer, boolean includeNullDelimiter, KeyValuePair[] additionalFields)
protected	AbstractJacksonLayout(Configuration config, com.fasterxml.jackson.databind.ObjectWriter objectWriter, Charset charset, boolean compact, boolean complete, boolean eventEol, AbstractStringLayout.Serializer headerSerializer, AbstractStringLayout.Serializer footerSerializer)	Deprecated.
protected	AbstractJacksonLayout(Configuration config, com.fasterxml.jackson.databind.ObjectWriter objectWriter, Charset charset, boolean compact, boolean complete, boolean eventEol, AbstractStringLayout.Serializer headerSerializer, AbstractStringLayout.Serializer footerSerializer, boolean includeNullDelimiter)	Deprecated.

Method Summary

Modifier and Type	Method	Description
private static LogEvent	convertMutableToLog4jEvent(LogEvent event)
private static AbstractJacksonLayout.ResolvableKeyValuePair[]	prepareAdditionalFields(Configuration config, KeyValuePair[] additionalFields)
private Map<String,String>	resolveAdditionalFields(LogEvent logEvent)
String	toSerializable(LogEvent event)	Formats a LogEvent.
void	toSerializable(LogEvent event, Writer writer)
protected static boolean	valueNeedsLookup(String value)
protected Object	wrapLogEvent(LogEvent event)

Methods inherited from class AbstractStringLayout

getBytes, getCharset, getContentType, getFooter, getFooterSerializer, getHeader, getHeaderSerializer, getStringBuilder, getStringBuilderEncoder, requiresLocation, serializeToBytes, serializeToString, toByteArray, trimToMaxSize

Methods inherited from class AbstractLayout

encode, getConfiguration, getContentFormat, markEvent

Methods inherited from class Object

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

Methods inherited from interface Encoder

encode

Methods inherited from interface Layout

getContentFormat

Field Details

DEFAULT_EOL

protected static final String DEFAULT_EOL

See Also:

• Constant Field Values

COMPACT_EOL

protected static final String COMPACT_EOL

See Also:

• Constant Field Values

eol

protected final String eol

objectWriter

protected final com.fasterxml.jackson.databind.ObjectWriter objectWriter

compact

protected final boolean compact

complete

protected final boolean complete

includeNullDelimiter

protected final boolean includeNullDelimiter

additionalFields

protected final AbstractJacksonLayout.ResolvableKeyValuePair[] additionalFields

Constructor Details

AbstractJacksonLayout

@Deprecated
protected AbstractJacksonLayout(Configuration config,
 com.fasterxml.jackson.databind.ObjectWriter objectWriter,
 Charset charset,
 boolean compact,
 boolean complete,
 boolean eventEol,
 AbstractStringLayout.Serializer headerSerializer,
 AbstractStringLayout.Serializer footerSerializer)

Deprecated.

AbstractJacksonLayout

@Deprecated
protected AbstractJacksonLayout(Configuration config,
 com.fasterxml.jackson.databind.ObjectWriter objectWriter,
 Charset charset,
 boolean compact,
 boolean complete,
 boolean eventEol,
 AbstractStringLayout.Serializer headerSerializer,
 AbstractStringLayout.Serializer footerSerializer,
 boolean includeNullDelimiter)

Deprecated.

AbstractJacksonLayout

protected AbstractJacksonLayout(Configuration config,
 com.fasterxml.jackson.databind.ObjectWriter objectWriter,
 Charset charset,
 boolean compact,
 boolean complete,
 boolean eventEol,
 String endOfLine,
 AbstractStringLayout.Serializer headerSerializer,
 AbstractStringLayout.Serializer footerSerializer,
 boolean includeNullDelimiter,
 KeyValuePair[] additionalFields)

Method Details

valueNeedsLookup

protected static boolean valueNeedsLookup(String value)

prepareAdditionalFields

private static AbstractJacksonLayout.ResolvableKeyValuePair[] prepareAdditionalFields(Configuration config,
 KeyValuePair[] additionalFields)

toSerializable

public String toSerializable(LogEvent event)

Formats a LogEvent.

Parameters:

event - The LogEvent.

Returns:

The XML representation of the LogEvent.

convertMutableToLog4jEvent

private static LogEvent convertMutableToLog4jEvent(LogEvent event)

wrapLogEvent

protected Object wrapLogEvent(LogEvent event)

resolveAdditionalFields

private Map<String,String> resolveAdditionalFields(LogEvent logEvent)

toSerializable

public void toSerializable(LogEvent event,
 Writer writer)
                    throws com.fasterxml.jackson.core.JsonGenerationException,
com.fasterxml.jackson.databind.JsonMappingException,
IOException

Throws:

com.fasterxml.jackson.core.JsonGenerationException

com.fasterxml.jackson.databind.JsonMappingException

IOException