org.apache.logging.log4j.core.layout

Class MessageLayout

java.lang.Object

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

org.apache.logging.log4j.core.layout.MessageLayout

All Implemented Interfaces:

Layout<Message>, Encoder<LogEvent>

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

Formats a LogEvent in its Message form.

Useful in combination with a JMS Appender to map a Log4j MapMessage or StringMapMessage to a JMS MapMessage.

Nested Class Summary

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

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

Field Summary

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

Constructor and Description
MessageLayout()
MessageLayout(Configuration configuration, byte[] header, byte[] footer)

Method Summary

Modifier and Type	Method and Description
static Layout<?>	createLayout()
String	getContentType() Returns the content type output by this layout.
byte[]	toByteArray(LogEvent event) Formats the event suitable for display.
Message	toSerializable(LogEvent event) Formats the event as an Object that can be serialized.

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

encode, getConfiguration, getContentFormat, getFooter, getHeader, markEvent

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageLayout

public MessageLayout()

MessageLayout

public MessageLayout(Configuration configuration,
                     byte[] header,
                     byte[] footer)

Method Detail

toByteArray

public byte[] toByteArray(LogEvent event)

Description copied from interface: Layout

Formats the event suitable for display.

Parameters:

event - The Logging Event.

Returns:

The formatted event.

toSerializable

public Message toSerializable(LogEvent event)

Description copied from interface: Layout

Formats the event as an Object that can be serialized.

Parameters:

event - The Logging Event.

Returns:

The formatted event.

getContentType

public String getContentType()

Description copied from interface: Layout

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

Returns:

the content type.

createLayout

@PluginFactory
public static Layout<?> createLayout()