Package org.apache.logging.log4j.layout.template.json

Class JsonTemplateLayout

java.lang.Object

org.apache.logging.log4j.layout.template.json.JsonTemplateLayout

All Implemented Interfaces:

Layout<java.lang.String>, Encoder<LogEvent>, StringLayout

@Plugin(name="JsonTemplateLayout",
        category="Core",
        elementType="layout")
public class JsonTemplateLayout
extends java.lang.Object
implements StringLayout

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonTemplateLayout.Builder
private static class	JsonTemplateLayout.Context
static class	JsonTemplateLayout.EventTemplateAdditionalField
private static class	JsonTemplateLayout.StringBuilderEncoder	StringBuilderEncoder clone replacing thread-local allocations with instance fields.

Field Summary

Fields

Modifier and Type	Field	Description
private java.nio.charset.Charset	charset
private static java.util.Map<java.lang.String,java.lang.String>	CONTENT_FORMAT
private java.lang.String	contentType
private Recycler<JsonTemplateLayout.Context>	contextRecycler
private java.lang.String	eventDelimiter
private TemplateResolver<LogEvent>	eventResolver

Fields inherited from interface org.apache.logging.log4j.core.Layout

ELEMENT_TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	JsonTemplateLayout(JsonTemplateLayout.Builder builder)

Method Summary

Modifier and Type	Method	Description
private static Recycler<JsonTemplateLayout.Context>	createContextRecycler(JsonTemplateLayout.Builder builder, JsonWriter jsonWriter)
private static java.util.function.Supplier<JsonTemplateLayout.Context>	createContextSupplier(java.nio.charset.Charset charset, JsonWriter jsonWriter)
private TemplateResolver<LogEvent>	createEventResolver(JsonTemplateLayout.Builder builder, Configuration configuration, java.nio.charset.Charset charset, JsonWriter jsonWriter)
void	encode(LogEvent event, ByteBufferDestination destination)	Encodes the specified source object to some binary representation and writes the result to the specified destination.
java.nio.charset.Charset	getCharset()	Gets the Charset this layout uses to encode Strings into bytes.
java.util.Map<java.lang.String,java.lang.String>	getContentFormat()	Returns a description of the content format.
java.lang.String	getContentType()	Returns the content type output by this layout.
byte[]	getFooter()	Returns the format for the layout format.
byte[]	getHeader()	Returns the header for the layout format.
static JsonTemplateLayout.Builder	newBuilder()
private static java.lang.String	readEventTemplate(JsonTemplateLayout.Builder builder)
private static java.lang.String	readStackTraceElementTemplate(JsonTemplateLayout.Builder builder)
private static java.lang.String	readTemplate(java.lang.String template, java.lang.String templateUri, java.nio.charset.Charset charset)
byte[]	toByteArray(LogEvent event)	Formats the event suitable for display.
java.lang.String	toSerializable(LogEvent event)	Formats the event as an Object that can be serialized.

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_FORMAT

private static final java.util.Map<java.lang.String,java.lang.String> CONTENT_FORMAT

charset

private final java.nio.charset.Charset charset

contentType

private final java.lang.String contentType

eventResolver

private final TemplateResolver<LogEvent> eventResolver

eventDelimiter

private final java.lang.String eventDelimiter

contextRecycler

private final Recycler<JsonTemplateLayout.Context> contextRecycler

Constructor Detail

JsonTemplateLayout

private JsonTemplateLayout(JsonTemplateLayout.Builder builder)

Method Detail

createEventResolver

private TemplateResolver<LogEvent> createEventResolver(JsonTemplateLayout.Builder builder,
                                                       Configuration configuration,
                                                       java.nio.charset.Charset charset,
                                                       JsonWriter jsonWriter)

readEventTemplate

private static java.lang.String readEventTemplate(JsonTemplateLayout.Builder builder)

readStackTraceElementTemplate

private static java.lang.String readStackTraceElementTemplate(JsonTemplateLayout.Builder builder)

readTemplate

private static java.lang.String readTemplate(java.lang.String template,
                                             java.lang.String templateUri,
                                             java.nio.charset.Charset charset)

createContextRecycler

private static Recycler<JsonTemplateLayout.Context> createContextRecycler(JsonTemplateLayout.Builder builder,
                                                                          JsonWriter jsonWriter)

createContextSupplier

private static java.util.function.Supplier<JsonTemplateLayout.Context> createContextSupplier(java.nio.charset.Charset charset,
                                                                                             JsonWriter jsonWriter)

toByteArray

public byte[] toByteArray(LogEvent event)

Description copied from interface: Layout

Formats the event suitable for display.

Specified by:

toByteArray in interface Layout<java.lang.String>

Parameters:

event - The Logging Event.

Returns:

The formatted event.

toSerializable

public java.lang.String toSerializable(LogEvent event)

Description copied from interface: Layout

Formats the event as an Object that can be serialized.

Specified by:

toSerializable in interface Layout<java.lang.String>

Parameters:

event - The Logging Event.

Returns:

The formatted event.

encode

public void encode(LogEvent event,
                   ByteBufferDestination destination)

Description copied from interface: Encoder

Encodes the specified source object to some binary representation and writes the result to the specified destination.

Specified by:

encode in interface Encoder<LogEvent>

Parameters:

event - the object to encode.

destination - holds the ByteBuffer to write into.

getFooter

public byte[] getFooter()

Description copied from interface: Layout

Returns the format for the layout format.

Specified by:

getFooter in interface Layout<java.lang.String>

Returns:

The footer.

getHeader

public byte[] getHeader()

Description copied from interface: Layout

Returns the header for the layout format.

Specified by:

getHeader in interface Layout<java.lang.String>

Returns:

The header.

getCharset

public java.nio.charset.Charset getCharset()

Description copied from interface: StringLayout

Gets the Charset this layout uses to encode Strings into bytes.

Specified by:

getCharset in interface StringLayout

Returns:

the Charset this layout uses to encode Strings into bytes.

getContentType

public java.lang.String getContentType()

Description copied from interface: Layout

Returns the content type output by this layout. The base class returns "text/plain".

Specified by:

getContentType in interface Layout<java.lang.String>

Returns:

the content type.

getContentFormat

public java.util.Map<java.lang.String,java.lang.String> getContentFormat()

Description copied from interface: Layout

Returns a description of the content format.

Specified by:

getContentFormat in interface Layout<java.lang.String>

Returns:

a Map of key/value pairs describing the Layout-specific content format, or an empty Map if no content format descriptors are specified.

newBuilder

@PluginBuilderFactory
public static JsonTemplateLayout.Builder newBuilder()