Uses of Interface
org.apache.logging.log4j.core.Layout

Packages that use Layout

Package	Description
org.apache.logging.log4j.core
org.apache.logging.log4j.core.appender
org.apache.logging.log4j.core.appender.db
org.apache.logging.log4j.core.appender.db.jdbc
org.apache.logging.log4j.core.appender.mom
org.apache.logging.log4j.core.appender.mom.jeromq
org.apache.logging.log4j.core.appender.rolling
org.apache.logging.log4j.core.layout
org.apache.logging.log4j.core.net
org.apache.logging.log4j.web.appender

Uses of Layout in org.apache.logging.log4j.core

Subinterfaces of Layout in org.apache.logging.log4j.core

Modifier and Type	Interface	Description
interface	StringLayout	Instantiates the Layout type for String-based layouts.

Methods in org.apache.logging.log4j.core that return Layout

Modifier and Type	Method	Description
Layout<? extends Serializable>	Appender.getLayout()	Returns the Layout used by this Appender if applicable.

Uses of Layout in org.apache.logging.log4j.core.appender

Fields in org.apache.logging.log4j.core.appender declared as Layout

Modifier and Type	Field	Description
protected Layout<?>	OutputStreamManager.layout

Methods in org.apache.logging.log4j.core.appender that return Layout

Modifier and Type	Method	Description
Layout<? extends Serializable>	AbstractAppender.Builder.getLayout()
Layout<? extends Serializable>	AbstractAppender.getLayout()	Returns the Layout for the appender.
Layout<? extends Serializable>	AbstractAppender.Builder.getOrCreateLayout()
Layout<? extends Serializable>	AbstractAppender.Builder.getOrCreateLayout(Charset charset)

Methods in org.apache.logging.log4j.core.appender with parameters of type Layout

Modifier and Type	Method	Description
static ConsoleAppender	ConsoleAppender.createAppender(Layout<? extends Serializable> layout, Filter filter, String target, String name, String follow, String ignoreExceptions)	Deprecated. Deprecated in 2.7; use ConsoleAppender.newBuilder().
static ConsoleAppender	ConsoleAppender.createAppender(Layout<? extends Serializable> layout, Filter filter, ConsoleAppender.Target target, String name, boolean follow, boolean direct, boolean ignoreExceptions)	Deprecated. Deprecated in 2.7; use ConsoleAppender.newBuilder().
static <B extends FileAppender.Builder<B>> FileAppender	FileAppender.createAppender(String fileName, String append, String locking, String name, String immediateFlush, String ignoreExceptions, String bufferedIo, String bufferSizeStr, Layout<? extends Serializable> layout, Filter filter, String advertise, String advertiseUri, Configuration config)	Deprecated. Use FileAppender.newBuilder()
static <B extends MemoryMappedFileAppender.Builder<B>> MemoryMappedFileAppender	MemoryMappedFileAppender.createAppender(String fileName, String append, String name, String immediateFlush, String regionLengthStr, String ignore, Layout<? extends Serializable> layout, Filter filter, String advertise, String advertiseURI, Configuration config)	Deprecated. Use MemoryMappedFileAppender.newBuilder().
static OutputStreamAppender	OutputStreamAppender.createAppender(Layout<? extends Serializable> layout, Filter filter, OutputStream target, String name, boolean follow, boolean ignore)	Creates an OutputStream Appender.
static <B extends RandomAccessFileAppender.Builder<B>> RandomAccessFileAppender	RandomAccessFileAppender.createAppender(String fileName, String append, String name, String immediateFlush, String bufferSizeStr, String ignore, Layout<? extends Serializable> layout, Filter filter, String advertise, String advertiseURI, Configuration configuration)	Deprecated. Use RandomAccessFileAppender.newBuilder().
static <B extends RollingFileAppender.Builder<B>> RollingFileAppender	RollingFileAppender.createAppender(String fileName, String filePattern, String append, String name, String bufferedIO, String bufferSizeStr, String immediateFlush, TriggeringPolicy policy, RolloverStrategy strategy, Layout<? extends Serializable> layout, Filter filter, String ignore, String advertise, String advertiseUri, Configuration config)	Deprecated. Use RollingFileAppender.newBuilder().
static <B extends RollingRandomAccessFileAppender.Builder<B>> RollingRandomAccessFileAppender	RollingRandomAccessFileAppender.createAppender(String fileName, String filePattern, String append, String name, String immediateFlush, String bufferSizeStr, TriggeringPolicy policy, RolloverStrategy strategy, Layout<? extends Serializable> layout, Filter filter, String ignoreExceptions, String advertise, String advertiseURI, Configuration configuration)	Deprecated. Use RollingRandomAccessFileAppender.newBuilder().
static SocketAppender	SocketAppender.createAppender(String host, int port, Protocol protocol, SslConfiguration sslConfig, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, String name, boolean immediateFlush, boolean ignoreExceptions, Layout<? extends Serializable> layout, Filter filter, boolean advertise, Configuration configuration)	Deprecated. Deprecated in 2.7; use SocketAppender.newBuilder()
static SocketAppender	SocketAppender.createAppender(String host, String portNum, String protocolIn, SslConfiguration sslConfig, int connectTimeoutMillis, String delayMillis, String immediateFail, String name, String immediateFlush, String ignore, Layout<? extends Serializable> layout, Filter filter, String advertise, Configuration config)	Deprecated. Deprecated in 2.5; use SocketAppender.newBuilder()
static ConsoleAppender	ConsoleAppender.createDefaultAppenderForLayout(Layout<? extends Serializable> layout)
protected static AbstractSocketManager	SocketAppender.createSocketManager(String name, Protocol protocol, String host, int port, int connectTimeoutMillis, SslConfiguration sslConfig, int reconnectDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize)	Deprecated. Use SocketAppender.createSocketManager(String, Protocol, String, int, int, SslConfiguration, int, boolean, Layout, int, SocketOptions).
protected static AbstractSocketManager	SocketAppender.createSocketManager(String name, Protocol protocol, String host, int port, int connectTimeoutMillis, SslConfiguration sslConfig, int reconnectDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize, SocketOptions socketOptions)	Creates an AbstractSocketManager for TCP, UDP, and SSL.
static FileManager	FileManager.getFileManager(String fileName, boolean append, boolean locking, boolean bufferedIo, boolean createOnDemand, String advertiseURI, Layout<? extends Serializable> layout, int bufferSize, String filePermissions, String fileOwner, String fileGroup, Configuration configuration)	Returns the FileManager.
static MemoryMappedFileManager	MemoryMappedFileManager.getFileManager(String fileName, boolean append, boolean immediateFlush, int regionLength, String advertiseURI, Layout<? extends Serializable> layout)	Returns the MemoryMappedFileManager.
static RandomAccessFileManager	RandomAccessFileManager.getFileManager(String fileName, boolean append, boolean immediateFlush, int bufferSize, String advertiseURI, Layout<? extends Serializable> layout, Configuration configuration)	Returns the RandomAccessFileManager.
abstract void	HttpManager.send(Layout<?> layout, LogEvent event)
void	HttpURLConnectionManager.send(Layout<?> layout, LogEvent event)
B	AbstractAppender.Builder.setLayout(Layout<? extends Serializable> layout)
B	AbstractAppender.Builder.withLayout(Layout<? extends Serializable> layout)	Deprecated. use AbstractAppender.Builder.setLayout(Layout).

Constructors in org.apache.logging.log4j.core.appender with parameters of type Layout

Constructor	Description
AbstractAppender(String name, Filter filter, Layout<? extends Serializable> layout)	Deprecated. Use AbstractAppender(String, Filter, Layout, boolean, Property[]).
AbstractAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions)	Deprecated. Use AbstractAppender(String, Filter, Layout, boolean, Property[])
AbstractAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, Property[] properties)	Constructor.
AbstractOutputStreamAppender(String name, Layout<? extends Serializable> layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, M manager)	Deprecated. Use AbstractOutputStreamAppender(String, Layout, Filter, boolean, boolean, Property[], OutputStreamManager)
AbstractOutputStreamAppender(String name, Layout<? extends Serializable> layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, Property[] properties, M manager)	Instantiates a WriterAppender and set the output destination to a new OutputStreamWriter initialized with os as its OutputStream.
CountingNoOpAppender(String name, Layout<?> layout)
FileManager(String fileName, OutputStream os, boolean append, boolean locking, String advertiseURI, Layout<? extends Serializable> layout, boolean writeHeader, ByteBuffer buffer)	Deprecated.
FileManager(String fileName, OutputStream os, boolean append, boolean locking, String advertiseURI, Layout<? extends Serializable> layout, int bufferSize, boolean writeHeader)	Deprecated.
FileManager(LoggerContext loggerContext, String fileName, OutputStream os, boolean append, boolean locking, boolean createOnDemand, String advertiseURI, Layout<? extends Serializable> layout, boolean writeHeader, ByteBuffer buffer)	Deprecated.
FileManager(LoggerContext loggerContext, String fileName, OutputStream os, boolean append, boolean locking, boolean createOnDemand, String advertiseURI, Layout<? extends Serializable> layout, String filePermissions, String fileOwner, String fileGroup, boolean writeHeader, ByteBuffer buffer)
MemoryMappedFileManager(RandomAccessFile file, String fileName, OutputStream os, boolean immediateFlush, long position, int regionLength, String advertiseURI, Layout<? extends Serializable> layout, boolean writeHeader)
OutputStreamManager(OutputStream os, String streamName, Layout<?> layout, boolean writeHeader)
OutputStreamManager(OutputStream os, String streamName, Layout<?> layout, boolean writeHeader, int bufferSize)
OutputStreamManager(OutputStream os, String streamName, Layout<?> layout, boolean writeHeader, ByteBuffer byteBuffer)	Deprecated.
OutputStreamManager(LoggerContext loggerContext, OutputStream os, String streamName, boolean createOnDemand, Layout<? extends Serializable> layout, boolean writeHeader, ByteBuffer byteBuffer)
RandomAccessFileManager(LoggerContext loggerContext, RandomAccessFile file, String fileName, OutputStream os, int bufferSize, String advertiseURI, Layout<? extends Serializable> layout, boolean writeHeader)
SocketAppender(String name, Layout<? extends Serializable> layout, Filter filter, AbstractSocketManager manager, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser)	Deprecated. SocketAppender(String, Layout, Filter, AbstractSocketManager, boolean, boolean, Advertiser, Property[]).
SocketAppender(String name, Layout<? extends Serializable> layout, Filter filter, AbstractSocketManager manager, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser, Property[] properties)
SyslogAppender(String name, Layout<? extends Serializable> layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, AbstractSocketManager manager, Advertiser advertiser)	Deprecated. Use SyslogAppender(String, Layout, Filter, boolean, boolean, AbstractSocketManager, Advertiser, Property[]).
SyslogAppender(String name, Layout<? extends Serializable> layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, AbstractSocketManager manager, Advertiser advertiser, Property[] properties)

Uses of Layout in org.apache.logging.log4j.core.appender.db

Methods in org.apache.logging.log4j.core.appender.db that return Layout

Modifier and Type	Method	Description
Layout<LogEvent>	AbstractDatabaseAppender.getLayout()	This always returns null, as database appenders do not use a single layout.
Layout<? extends Serializable>	AbstractDatabaseManager.AbstractFactoryData.getLayout()	Gets the layout.

Constructors in org.apache.logging.log4j.core.appender.db with parameters of type Layout

Constructor	Description
AbstractDatabaseAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, Property[] properties, T manager)	Instantiates the base appender.
AbstractDatabaseAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, T manager)	Deprecated. Use AbstractDatabaseAppender(String, Filter, Layout, boolean, Property[], AbstractDatabaseManager)
AbstractDatabaseManager(String name, int bufferSize, Layout<? extends Serializable> layout)	Deprecated. Use AbstractDatabaseManager(String, int, Layout, Configuration).
AbstractDatabaseManager(String name, int bufferSize, Layout<? extends Serializable> layout, Configuration configuration)	Constructs the base manager.
AbstractFactoryData(int bufferSize, Layout<? extends Serializable> layout)	Deprecated. Use AbstractFactoryData(Configuration, int, Layout).
AbstractFactoryData(Configuration configuration, int bufferSize, Layout<? extends Serializable> layout)	Constructs the base factory data.

Uses of Layout in org.apache.logging.log4j.core.appender.db.jdbc

Methods in org.apache.logging.log4j.core.appender.db.jdbc with parameters of type Layout

Modifier and Type	Method	Description
static JdbcDatabaseManager	JdbcDatabaseManager.getManager(String name, int bufferSize, Layout<? extends Serializable> layout, ConnectionSource connectionSource, String tableName, ColumnConfig[] columnConfigs, ColumnMapping[] columnMappings)	Deprecated.
static JdbcDatabaseManager	JdbcDatabaseManager.getManager(String name, int bufferSize, Layout<? extends Serializable> layout, ConnectionSource connectionSource, String tableName, ColumnConfig[] columnConfigs, ColumnMapping[] columnMappings, boolean immediateFail, long reconnectIntervalMillis)	Deprecated. use JdbcDatabaseManager.getManager(String, int, Layout, ConnectionSource, String, ColumnConfig[], ColumnMapping[], boolean, long)
static JdbcDatabaseManager	JdbcDatabaseManager.getManager(String name, int bufferSize, Layout<? extends Serializable> layout, ConnectionSource connectionSource, String tableName, ColumnConfig[] columnConfigs, ColumnMapping[] columnMappings, boolean immediateFail, long reconnectIntervalMillis, boolean truncateStrings)	Creates a JDBC manager for use within the JdbcAppender, or returns a suitable one if it already exists.

Uses of Layout in org.apache.logging.log4j.core.appender.mom

Constructors in org.apache.logging.log4j.core.appender.mom with parameters of type Layout

Constructor	Description
JmsAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, JmsManager manager)	Deprecated. Use JmsAppender(String, Filter, Layout, boolean, Property[], JmsManager).
JmsAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, Property[] properties, JmsManager manager)	Deprecated. Constructs a new instance.

Uses of Layout in org.apache.logging.log4j.core.appender.mom.jeromq

Methods in org.apache.logging.log4j.core.appender.mom.jeromq with parameters of type Layout

Modifier and Type	Method	Description
static JeroMqAppender	JeroMqAppender.createAppender(String name, Layout<?> layout, Filter filter, Property[] properties, boolean ignoreExceptions, long affinity, long backlog, boolean delayAttachOnConnect, byte[] identity, boolean ipv4Only, long linger, long maxMsgSize, long rcvHwm, long receiveBufferSize, int receiveTimeOut, long reconnectIVL, long reconnectIVLMax, long sendBufferSize, int sendTimeOut, long sndHwm, int tcpKeepAlive, long tcpKeepAliveCount, long tcpKeepAliveIdle, long tcpKeepAliveInterval, boolean xpubVerbose)

Uses of Layout in org.apache.logging.log4j.core.appender.rolling

Methods in org.apache.logging.log4j.core.appender.rolling with parameters of type Layout

Modifier and Type	Method	Description
static RollingFileManager	RollingFileManager.getFileManager(String fileName, String pattern, boolean append, boolean bufferedIO, TriggeringPolicy policy, RolloverStrategy strategy, String advertiseURI, Layout<? extends Serializable> layout, int bufferSize, boolean immediateFlush, boolean createOnDemand, String filePermissions, String fileOwner, String fileGroup, Configuration configuration)	Returns a RollingFileManager.
static RollingRandomAccessFileManager	RollingRandomAccessFileManager.getRollingRandomAccessFileManager(String fileName, String filePattern, boolean append, boolean immediateFlush, int bufferSize, TriggeringPolicy policy, RolloverStrategy strategy, String advertiseURI, Layout<? extends Serializable> layout, String filePermissions, String fileOwner, String fileGroup, Configuration configuration)

Constructors in org.apache.logging.log4j.core.appender.rolling with parameters of type Layout

Constructor	Description
RollingFileManager(String fileName, String pattern, OutputStream os, boolean append, long size, long initialTime, TriggeringPolicy triggeringPolicy, RolloverStrategy rolloverStrategy, String advertiseURI, Layout<? extends Serializable> layout, boolean writeHeader, ByteBuffer buffer)	Deprecated.
RollingFileManager(String fileName, String pattern, OutputStream os, boolean append, long size, long initialTime, TriggeringPolicy triggeringPolicy, RolloverStrategy rolloverStrategy, String advertiseURI, Layout<? extends Serializable> layout, int bufferSize, boolean writeHeader)	Deprecated.
RollingFileManager(LoggerContext loggerContext, String fileName, String pattern, OutputStream os, boolean append, boolean createOnDemand, long size, long initialTime, TriggeringPolicy triggeringPolicy, RolloverStrategy rolloverStrategy, String advertiseURI, Layout<? extends Serializable> layout, boolean writeHeader, ByteBuffer buffer)	Deprecated.
RollingFileManager(LoggerContext loggerContext, String fileName, String pattern, OutputStream os, boolean append, boolean createOnDemand, long size, long initialTime, TriggeringPolicy triggeringPolicy, RolloverStrategy rolloverStrategy, String advertiseURI, Layout<? extends Serializable> layout, String filePermissions, String fileOwner, String fileGroup, boolean writeHeader, ByteBuffer buffer)
RollingRandomAccessFileManager(LoggerContext loggerContext, RandomAccessFile raf, String fileName, String pattern, OutputStream os, boolean append, boolean immediateFlush, int bufferSize, long size, long time, TriggeringPolicy policy, RolloverStrategy strategy, String advertiseURI, Layout<? extends Serializable> layout, boolean writeHeader)	Deprecated.
RollingRandomAccessFileManager(LoggerContext loggerContext, RandomAccessFile raf, String fileName, String pattern, OutputStream os, boolean append, boolean immediateFlush, int bufferSize, long size, long initialTime, TriggeringPolicy policy, RolloverStrategy strategy, String advertiseURI, Layout<? extends Serializable> layout, String filePermissions, String fileOwner, String fileGroup, boolean writeHeader)

Uses of Layout in org.apache.logging.log4j.core.layout

Classes in org.apache.logging.log4j.core.layout that implement Layout

Modifier and Type	Class	Description
class	AbstractCsvLayout	A superclass for Comma-Separated Value (CSV) layouts.
class	AbstractLayout<T extends Serializable>	Abstract base class for Layouts.
class	AbstractStringLayout	Abstract base class for Layouts that result in a String.
class	CsvLogEventLayout	A Comma-Separated Value (CSV) layout to log events.
class	CsvParameterLayout	A Comma-Separated Value (CSV) layout to log event parameters.
class	GelfLayout	Lays out events in the Graylog Extended Log Format (GELF) 1.1.
class	HtmlLayout	Outputs events as rows in an HTML table on an HTML page.
class	JsonLayout	Note: The JsonLayout should be considered to be deprecated.
class	MessageLayout	Formats a LogEvent in its Message form.
class	PatternLayout	A flexible layout configurable with pattern string.
class	Rfc5424Layout	Formats a log event in accordance with RFC 5424.
class	SerializedLayout	Deprecated. Java Serialization has inherent security weaknesses, see https://www.owasp.org/index.php/Deserialization_of_untrusted_data .
class	SyslogLayout	Formats a log event as a BSD Log record.
class	XmlLayout	Appends a series of event elements as defined in the Log4j-events.xsd.
class	YamlLayout	Appends a series of YAML events as strings serialized as bytes.

Methods in org.apache.logging.log4j.core.layout that return Layout

Modifier and Type	Method	Description
static Layout<?>	MessageLayout.createLayout()

Uses of Layout in org.apache.logging.log4j.core.net

Methods in org.apache.logging.log4j.core.net with parameters of type Layout

Modifier and Type	Method	Description
static DatagramSocketManager	DatagramSocketManager.getSocketManager(String host, int port, Layout<? extends Serializable> layout, int bufferSize)	Obtain a SocketManager.
static SslSocketManager	SslSocketManager.getSocketManager(SslConfiguration sslConfig, String host, int port, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize)	Deprecated. Use SslSocketManager.getSocketManager(SslConfiguration, String, int, int, int, boolean, Layout, int, SocketOptions).
static SslSocketManager	SslSocketManager.getSocketManager(SslConfiguration sslConfig, String host, int port, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize, SocketOptions socketOptions)
static TcpSocketManager	TcpSocketManager.getSocketManager(String host, int port, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize)	Deprecated. Use TcpSocketManager.getSocketManager(String, int, int, int, boolean, Layout, int, SocketOptions).
static TcpSocketManager	TcpSocketManager.getSocketManager(String host, int port, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize, SocketOptions socketOptions)	Obtains a TcpSocketManager.
abstract void	MailManager.sendEvents(Layout<?> layout, LogEvent appendEvent)	Send the contents of the cyclic buffer as an e-mail message.

Constructors in org.apache.logging.log4j.core.net with parameters of type Layout

Constructor	Description
AbstractSocketManager(String name, OutputStream os, InetAddress inetAddress, String host, int port, Layout<? extends Serializable> layout, boolean writeHeader, int bufferSize)	Constructs a new instance.
DatagramSocketManager(String name, OutputStream os, InetAddress inetAddress, String host, int port, Layout<? extends Serializable> layout, int bufferSize)	The Constructor.
SslSocketManager(String name, OutputStream os, Socket sock, SslConfiguration sslConfig, InetAddress inetAddress, String host, int port, int connectTimeoutMillis, int reconnectionDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize)	Deprecated. Use SslSocketManager(String, OutputStream, Socket, SslConfiguration, InetAddress, String, int, int, int, boolean, Layout, int, SocketOptions).
SslSocketManager(String name, OutputStream os, Socket sock, SslConfiguration sslConfig, InetAddress inetAddress, String host, int port, int connectTimeoutMillis, int reconnectionDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize, SocketOptions socketOptions)
TcpSocketManager(String name, OutputStream os, Socket socket, InetAddress inetAddress, String host, int port, int connectTimeoutMillis, int reconnectionDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize)	Deprecated. Use TcpSocketManager(String, OutputStream, Socket, InetAddress, String, int, int, int, boolean, Layout, int, SocketOptions).
TcpSocketManager(String name, OutputStream os, Socket socket, InetAddress inetAddress, String host, int port, int connectTimeoutMillis, int reconnectionDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize, SocketOptions socketOptions)	Constructs.

Uses of Layout in org.apache.logging.log4j.web.appender

Methods in org.apache.logging.log4j.web.appender with parameters of type Layout

Modifier and Type	Method	Description
static ServletAppender	ServletAppender.createAppender(Layout<? extends Serializable> layout, Filter filter, String name, boolean ignoreExceptions)	Deprecated. Use ServletAppender.newBuilder().