org.apache.logging.log4j.core.layout

Class SerializedLayout

java.lang.Object

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

org.apache.logging.log4j.core.layout.SerializedLayout

All Implemented Interfaces:

Layout<LogEvent>, Encoder<LogEvent>

@Plugin(name="SerializedLayout",
        category="Core",
        elementType="layout",
        printObject=true)
public final class SerializedLayout
extends AbstractLayout<LogEvent>

Formats a LogEvent in its Java serialized form.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	SerializedLayout.PrivateObjectOutputStream The stream header will be written in the Manager so skip it here.

Nested classes/interfaces inherited from class org.apache.logging.log4j.core.layout.AbstractLayout

AbstractLayout.Builder<B extends AbstractLayout.Builder<B>>

Field Summary

Fields

Modifier and Type	Field and Description
private static byte[]	serializedHeader

Fields inherited from class org.apache.logging.log4j.core.layout.AbstractLayout

configuration, eventCount, footer, header, LOGGER

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

ELEMENT_TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SerializedLayout()

Method Summary

Modifier and Type	Method and Description
static SerializedLayout	createLayout() Creates a SerializedLayout.
java.lang.String	getContentType() SerializedLayout returns a binary stream.
byte[]	getHeader() Returns the header, if one is available.
byte[]	toByteArray(LogEvent event) Formats a LogEvent as a serialized byte array of the LogEvent object.
LogEvent	toSerializable(LogEvent event) Returns the LogEvent.

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

encode, getConfiguration, getContentFormat, getFooter, markEvent, writeTo

Methods inherited from class java.lang.Object

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

Field Detail

serializedHeader

private static byte[] serializedHeader

Constructor Detail

SerializedLayout

private SerializedLayout()

Method Detail

toByteArray

public byte[] toByteArray(LogEvent event)

Formats a LogEvent as a serialized byte array of the LogEvent object.

Parameters:

event - The LogEvent.

Returns:

the formatted LogEvent.

toSerializable

public LogEvent toSerializable(LogEvent event)

Returns the LogEvent.

Parameters:

event - The Logging Event.

Returns:

The LogEvent.

createLayout

@PluginFactory
public static SerializedLayout createLayout()

Creates a SerializedLayout.

Returns:

A SerializedLayout.

getHeader

public byte[] getHeader()

Description copied from class: AbstractLayout

Returns the header, if one is available.

Specified by:

getHeader in interface Layout<LogEvent>

Overrides:

getHeader in class AbstractLayout<LogEvent>

Returns:

A byte array containing the header.

getContentType

public java.lang.String getContentType()

SerializedLayout returns a binary stream.

Returns:

The content type.