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

Packages that use Layout

Package	Description
org.apache.log4j.bridge
org.apache.log4j.layout
org.apache.logging.log4j.core	Implementation of Log4j 2.
org.apache.logging.log4j.core.appender	Log4j 2 Appenders.
org.apache.logging.log4j.core.appender.db	The classes in this package and sub packages provide appenders for various types of databases and methods for accessing databases.
org.apache.logging.log4j.core.appender.db.jdbc	The JDBC Appender supports writing log events to a relational database using standard JDBC connections.
org.apache.logging.log4j.core.appender.mom	Message oriented middleware appenders.
org.apache.logging.log4j.core.appender.mom.jeromq	Classes and interfaces for ZeroMQ/JeroMQ support.
org.apache.logging.log4j.core.appender.nosql	The NoSQL Appender supports writing log events to NoSQL databases.
org.apache.logging.log4j.core.appender.rolling	Rolling File Appender and support classes.
org.apache.logging.log4j.core.layout	Log4j 2 Layout support.
org.apache.logging.log4j.core.net	Log4j 2 network support.
org.apache.logging.log4j.layout.template.json
org.apache.logging.log4j.smtp
org.apache.logging.log4j.web.appender

Uses of Layout in org.apache.log4j.bridge

Classes in org.apache.log4j.bridge that implement Layout

Modifier and Type	Class	Description
class	LayoutAdapter	Class Description goes here.

Fields in org.apache.log4j.bridge declared as Layout

Modifier and Type	Field	Description
private Layout<?>	LayoutWrapper.layout

Methods in org.apache.log4j.bridge that return Layout

Modifier and Type	Method	Description
static Layout<?>	LayoutAdapter.adapt(Layout layout)	Adapts a Log4j 1.x layout into a Log4j 2.x layout.
Layout<?>	LayoutWrapper.getLayout()	Unwraps.

Methods in org.apache.log4j.bridge with parameters of type Layout

Modifier and Type	Method	Description
static Layout	LayoutWrapper.adapt(Layout<?> layout)	Adapts a Log4j 2.x layout into a Log4j 1.x layout.

Constructors in org.apache.log4j.bridge with parameters of type Layout

Constructor	Description
Adapter(java.lang.String name, Filter filter, Layout<? extends java.io.Serializable> layout, boolean ignoreExceptions, Property[] properties)
LayoutWrapper(Layout<?> layout)	Constructs a new instance.

Uses of Layout in org.apache.log4j.layout

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

Modifier and Type	Class	Description
class	Log4j1SyslogLayout	Port of the layout used by SyslogAppender in Log4j 1.x.
class	Log4j1XmlLayout	Port of XMLLayout in Log4j 1.x.

Fields in org.apache.log4j.layout declared as Layout

Modifier and Type	Field	Description
private Layout<? extends java.io.Serializable>	Log4j1SyslogLayout.Builder.messageLayout

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

Modifier and Type	Method	Description
Layout<? extends java.io.Serializable>	Log4j1SyslogLayout.Builder.getMessageLayout()

Methods in org.apache.log4j.layout with parameters of type Layout

Modifier and Type	Method	Description
B	Log4j1SyslogLayout.Builder.setMessageLayout(Layout<? extends java.io.Serializable> messageLayout)

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 @{link Layout} type for String-based layouts.

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

Modifier and Type	Method	Description
Layout<? extends java.io.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
private Layout<? extends java.io.Serializable>	AbstractAppender.Builder.layout
private Layout<? extends java.io.Serializable>	AbstractAppender.layout
private Layout<? extends java.io.Serializable>	ConsoleAppender.FactoryData.layout
private Layout<? extends java.io.Serializable>	FileManager.FactoryData.layout
private Layout<? extends java.io.Serializable>	MemoryMappedFileManager.FactoryData.layout
private Layout<? extends java.io.Serializable>	OutputStreamAppender.FactoryData.layout
protected Layout<?>	OutputStreamManager.layout
private Layout<? extends java.io.Serializable>	RandomAccessFileManager.FactoryData.layout

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

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

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

Constructor	Description
AbstractAppender(java.lang.String name, Filter filter, Layout<? extends java.io.Serializable> layout)	Deprecated. Use AbstractAppender(String, Filter, Layout, boolean, Property[]).
AbstractAppender(java.lang.String name, Filter filter, Layout<? extends java.io.Serializable> layout, boolean ignoreExceptions)	Deprecated. Use AbstractAppender(String, Filter, Layout, boolean, Property[])
AbstractAppender(java.lang.String name, Filter filter, Layout<? extends java.io.Serializable> layout, boolean ignoreExceptions, Property[] properties)	Constructor.
AbstractFileAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, M manager, java.lang.String filename, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser, Property[] properties)
AbstractOutputStreamAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, M manager)	Deprecated. Use AbstractOutputStreamAppender(String, Layout, Filter, boolean, boolean, Property[], OutputStreamManager)
AbstractOutputStreamAppender(java.lang.String name, Layout<? extends java.io.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.
ConsoleAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, OutputStreamManager manager, boolean ignoreExceptions, ConsoleAppender.Target target, Property[] properties)
CountingNoOpAppender(java.lang.String name, Layout<?> layout)
CountingNoOpAppender(java.lang.String name, Layout<?> layout, Property[] properties)
FactoryData(java.io.OutputStream os, java.lang.String type, Layout<? extends java.io.Serializable> layout)	Constructor.
FactoryData(boolean append, boolean locking, boolean bufferedIo, int bufferSize, boolean createOnDemand, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout, java.lang.String filePermissions, java.lang.String fileOwner, java.lang.String fileGroup, Configuration configuration)	Constructor.
FactoryData(boolean append, boolean immediateFlush, int regionLength, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout)	Constructor.
FactoryData(java.io.OutputStream os, java.lang.String type, Layout<? extends java.io.Serializable> layout)	Builds instances.
FactoryData(boolean append, boolean immediateFlush, int bufferSize, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout, Configuration configuration)	Constructor.
FileAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, FileManager manager, java.lang.String filename, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser, Property[] properties)
FileManager(java.lang.String fileName, java.io.OutputStream os, boolean append, boolean locking, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout, boolean writeHeader, java.nio.ByteBuffer buffer)	Deprecated.
FileManager(java.lang.String fileName, java.io.OutputStream os, boolean append, boolean locking, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout, int bufferSize, boolean writeHeader)	Deprecated.
FileManager(LoggerContext loggerContext, java.lang.String fileName, java.io.OutputStream os, boolean append, boolean locking, boolean createOnDemand, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout, boolean writeHeader, java.nio.ByteBuffer buffer)	Deprecated.
FileManager(LoggerContext loggerContext, java.lang.String fileName, java.io.OutputStream os, boolean append, boolean locking, boolean createOnDemand, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout, java.lang.String filePermissions, java.lang.String fileOwner, java.lang.String fileGroup, boolean writeHeader, java.nio.ByteBuffer buffer)
HttpAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, boolean ignoreExceptions, HttpManager manager, Property[] properties)
MemoryMappedFileAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, MemoryMappedFileManager manager, java.lang.String filename, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser, Property[] properties)
MemoryMappedFileManager(java.io.RandomAccessFile file, java.lang.String fileName, java.io.OutputStream os, boolean immediateFlush, long position, int regionLength, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout, boolean writeHeader)
OutputStreamAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, OutputStreamManager manager, boolean ignoreExceptions, Property[] properties)
OutputStreamManager(java.io.OutputStream os, java.lang.String streamName, Layout<?> layout, boolean writeHeader)
OutputStreamManager(java.io.OutputStream os, java.lang.String streamName, Layout<?> layout, boolean writeHeader, int bufferSize)
OutputStreamManager(java.io.OutputStream os, java.lang.String streamName, Layout<?> layout, boolean writeHeader, java.nio.ByteBuffer byteBuffer)	Deprecated.
OutputStreamManager(LoggerContext loggerContext, java.io.OutputStream os, java.lang.String streamName, boolean createOnDemand, Layout<? extends java.io.Serializable> layout, boolean writeHeader, java.nio.ByteBuffer byteBuffer)
RandomAccessFileAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, RandomAccessFileManager manager, java.lang.String filename, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser, Property[] properties)
RandomAccessFileManager(LoggerContext loggerContext, java.io.RandomAccessFile file, java.lang.String fileName, java.io.OutputStream os, int bufferSize, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout, boolean writeHeader)
RollingFileAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, RollingFileManager manager, java.lang.String fileName, java.lang.String filePattern, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser, Property[] properties)
RollingRandomAccessFileAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, RollingRandomAccessFileManager manager, java.lang.String fileName, java.lang.String filePattern, boolean ignoreExceptions, boolean immediateFlush, int bufferSize, Advertiser advertiser, Property[] properties)
ScriptAppenderSelector(java.lang.String name, Filter filter, Layout<? extends java.io.Serializable> layout, Property[] properties)
SocketAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, AbstractSocketManager manager, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser)	Deprecated. SocketAppender(String, Layout, Filter, AbstractSocketManager, boolean, boolean, Advertiser, Property[]).
SocketAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, AbstractSocketManager manager, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser, Property[] properties)
SyslogAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, AbstractSocketManager manager, Advertiser advertiser)	Deprecated. Use SyslogAppender(String, Layout, Filter, boolean, boolean, AbstractSocketManager, Advertiser, Property[]).
SyslogAppender(java.lang.String name, Layout<? extends java.io.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

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

Modifier and Type	Field	Description
private Layout<? extends java.io.Serializable>	AbstractDatabaseManager.AbstractFactoryData.layout
private Layout<? extends java.io.Serializable>	AbstractDatabaseManager.layout

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 java.io.Serializable>	AbstractDatabaseManager.AbstractFactoryData.getLayout()	Gets the layout.

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

Constructor	Description
AbstractDatabaseAppender(java.lang.String name, Filter filter, Layout<? extends java.io.Serializable> layout, boolean ignoreExceptions, Property[] properties, T manager)	Instantiates the base appender.
AbstractDatabaseAppender(java.lang.String name, Filter filter, Layout<? extends java.io.Serializable> layout, boolean ignoreExceptions, T manager)	Deprecated. Use AbstractDatabaseAppender(String, Filter, Layout, boolean, Property[], AbstractDatabaseManager)
AbstractDatabaseManager(java.lang.String name, int bufferSize, Layout<? extends java.io.Serializable> layout)	Deprecated. Use AbstractDatabaseManager(String, int, Layout, Configuration).
AbstractDatabaseManager(java.lang.String name, int bufferSize, Layout<? extends java.io.Serializable> layout, Configuration configuration)	Constructs the base manager.
AbstractFactoryData(int bufferSize, Layout<? extends java.io.Serializable> layout)	Deprecated. Use AbstractFactoryData(Configuration, int, Layout).
AbstractFactoryData(Configuration configuration, int bufferSize, Layout<? extends java.io.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(java.lang.String name, int bufferSize, Layout<? extends java.io.Serializable> layout, ConnectionSource connectionSource, java.lang.String tableName, ColumnConfig[] columnConfigs, ColumnMapping[] columnMappings)	Deprecated.
static JdbcDatabaseManager	JdbcDatabaseManager.getManager(java.lang.String name, int bufferSize, Layout<? extends java.io.Serializable> layout, ConnectionSource connectionSource, java.lang.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(java.lang.String name, int bufferSize, Layout<? extends java.io.Serializable> layout, ConnectionSource connectionSource, java.lang.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.

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

Constructor	Description
FactoryData(int bufferSize, Layout<? extends java.io.Serializable> layout, ConnectionSource connectionSource, java.lang.String tableName, ColumnConfig[] columnConfigs, ColumnMapping[] columnMappings, boolean immediateFail, long reconnectIntervalMillis, boolean truncateStrings)
JdbcAppender(java.lang.String name, Filter filter, Layout<? extends java.io.Serializable> layout, boolean ignoreExceptions, Property[] properties, JdbcDatabaseManager manager)

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(java.lang.String name, Filter filter, Layout<? extends java.io.Serializable> layout, boolean ignoreExceptions, JmsManager manager)	Deprecated. Use JmsAppender(String, Filter, Layout, boolean, Property[], JmsManager).
JmsAppender(java.lang.String name, Filter filter, Layout<? extends java.io.Serializable> layout, boolean ignoreExceptions, Property[] properties, JmsManager manager)	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(java.lang.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)

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

Constructor

Description

JeroMqAppender(java.lang.String name, Filter filter, Layout<? extends java.io.Serializable> layout, boolean ignoreExceptions, java.util.List<java.lang.String> endpoints, 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, Property[] properties)

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

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

Constructor	Description
NoSqlAppender(java.lang.String name, Filter filter, Layout<? extends java.io.Serializable> layout, boolean ignoreExceptions, Property[] properties, NoSqlDatabaseManager<?> manager)

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

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

Modifier and Type	Field	Description
private Layout<? extends java.io.Serializable>	RollingFileManager.FactoryData.layout
private Layout<? extends java.io.Serializable>	RollingRandomAccessFileManager.FactoryData.layout

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

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

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

Constructor	Description
FactoryData(java.lang.String fileName, java.lang.String pattern, boolean append, boolean bufferedIO, TriggeringPolicy policy, RolloverStrategy strategy, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout, int bufferSize, boolean immediateFlush, boolean createOnDemand, java.lang.String filePermissions, java.lang.String fileOwner, java.lang.String fileGroup, Configuration configuration)	Creates the data for the factory.
FactoryData(java.lang.String fileName, java.lang.String pattern, boolean append, boolean immediateFlush, int bufferSize, TriggeringPolicy policy, RolloverStrategy strategy, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout, java.lang.String filePermissions, java.lang.String fileOwner, java.lang.String fileGroup, Configuration configuration)	Create the data for the factory.
RollingFileManager(java.lang.String fileName, java.lang.String pattern, java.io.OutputStream os, boolean append, long size, long initialTime, TriggeringPolicy triggeringPolicy, RolloverStrategy rolloverStrategy, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout, boolean writeHeader, java.nio.ByteBuffer buffer)	Deprecated.
RollingFileManager(java.lang.String fileName, java.lang.String pattern, java.io.OutputStream os, boolean append, long size, long initialTime, TriggeringPolicy triggeringPolicy, RolloverStrategy rolloverStrategy, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout, int bufferSize, boolean writeHeader)	Deprecated.
RollingFileManager(LoggerContext loggerContext, java.lang.String fileName, java.lang.String pattern, java.io.OutputStream os, boolean append, boolean createOnDemand, long size, long initialTime, TriggeringPolicy triggeringPolicy, RolloverStrategy rolloverStrategy, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout, boolean writeHeader, java.nio.ByteBuffer buffer)	Deprecated.
RollingFileManager(LoggerContext loggerContext, java.lang.String fileName, java.lang.String pattern, java.io.OutputStream os, boolean append, boolean createOnDemand, long size, long initialTime, TriggeringPolicy triggeringPolicy, RolloverStrategy rolloverStrategy, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout, java.lang.String filePermissions, java.lang.String fileOwner, java.lang.String fileGroup, boolean writeHeader, java.nio.ByteBuffer buffer)
RollingRandomAccessFileManager(LoggerContext loggerContext, java.io.RandomAccessFile raf, java.lang.String fileName, java.lang.String pattern, java.io.OutputStream os, boolean append, boolean immediateFlush, int bufferSize, long size, long time, TriggeringPolicy policy, RolloverStrategy strategy, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout, boolean writeHeader)	Deprecated.
RollingRandomAccessFileManager(LoggerContext loggerContext, java.io.RandomAccessFile raf, java.lang.String fileName, java.lang.String pattern, java.io.OutputStream os, boolean append, boolean immediateFlush, int bufferSize, long size, long initialTime, TriggeringPolicy policy, RolloverStrategy strategy, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout, java.lang.String filePermissions, java.lang.String fileOwner, java.lang.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.
(package private) class	AbstractJacksonLayout
class	AbstractLayout<T extends java.io.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.dtd.
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

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

Modifier and Type	Field	Description
private Layout<? extends java.io.Serializable>	DatagramSocketManager.FactoryData.layout
protected Layout<? extends java.io.Serializable>	TcpSocketManager.FactoryData.layout

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

Modifier and Type	Method	Description
static DatagramSocketManager	DatagramSocketManager.getSocketManager(java.lang.String host, int port, Layout<? extends java.io.Serializable> layout, int bufferSize)	Obtain a SocketManager.
static SslSocketManager	SslSocketManager.getSocketManager(SslConfiguration sslConfig, java.lang.String host, int port, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, Layout<? extends java.io.Serializable> layout, int bufferSize)	Deprecated. Use SslSocketManager.getSocketManager(SslConfiguration, String, int, int, int, boolean, Layout, int, SocketOptions).
static SslSocketManager	SslSocketManager.getSocketManager(SslConfiguration sslConfig, java.lang.String host, int port, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, Layout<? extends java.io.Serializable> layout, int bufferSize, SocketOptions socketOptions)
static TcpSocketManager	TcpSocketManager.getSocketManager(java.lang.String host, int port, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, Layout<? extends java.io.Serializable> layout, int bufferSize)	Deprecated. Use TcpSocketManager.getSocketManager(String, int, int, int, boolean, Layout, int, SocketOptions).
static TcpSocketManager	TcpSocketManager.getSocketManager(java.lang.String host, int port, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, Layout<? extends java.io.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(java.lang.String name, java.io.OutputStream os, java.net.InetAddress inetAddress, java.lang.String host, int port, Layout<? extends java.io.Serializable> layout, boolean writeHeader, int bufferSize)	Constructs a new instance.
DatagramSocketManager(java.lang.String name, java.io.OutputStream os, java.net.InetAddress inetAddress, java.lang.String host, int port, Layout<? extends java.io.Serializable> layout, int bufferSize)	The Constructor.
FactoryData(java.lang.String host, int port, Layout<? extends java.io.Serializable> layout, int bufferSize)
FactoryData(java.lang.String host, int port, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, Layout<? extends java.io.Serializable> layout, int bufferSize, SocketOptions socketOptions)
SslFactoryData(SslConfiguration sslConfiguration, java.lang.String host, int port, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, Layout<? extends java.io.Serializable> layout, int bufferSize, SocketOptions socketOptions)
SslSocketManager(java.lang.String name, java.io.OutputStream os, java.net.Socket sock, SslConfiguration sslConfig, java.net.InetAddress inetAddress, java.lang.String host, int port, int connectTimeoutMillis, int reconnectionDelayMillis, boolean immediateFail, Layout<? extends java.io.Serializable> layout, int bufferSize)	Deprecated. Use SslSocketManager(String, OutputStream, Socket, SslConfiguration, InetAddress, String, int, int, int, boolean, Layout, int, SocketOptions).
SslSocketManager(java.lang.String name, java.io.OutputStream os, java.net.Socket sock, SslConfiguration sslConfig, java.net.InetAddress inetAddress, java.lang.String host, int port, int connectTimeoutMillis, int reconnectionDelayMillis, boolean immediateFail, Layout<? extends java.io.Serializable> layout, int bufferSize, SocketOptions socketOptions)
TcpSocketManager(java.lang.String name, java.io.OutputStream os, java.net.Socket socket, java.net.InetAddress inetAddress, java.lang.String host, int port, int connectTimeoutMillis, int reconnectionDelayMillis, boolean immediateFail, Layout<? extends java.io.Serializable> layout, int bufferSize)	Deprecated. Use TcpSocketManager(String, OutputStream, Socket, InetAddress, String, int, int, int, boolean, Layout, int, SocketOptions).
TcpSocketManager(java.lang.String name, java.io.OutputStream os, java.net.Socket socket, java.net.InetAddress inetAddress, java.lang.String host, int port, int connectTimeoutMillis, int reconnectionDelayMillis, boolean immediateFail, Layout<? extends java.io.Serializable> layout, int bufferSize, SocketOptions socketOptions)	Constructs.

Uses of Layout in org.apache.logging.log4j.layout.template.json

Classes in org.apache.logging.log4j.layout.template.json that implement Layout

Modifier and Type	Class	Description
class	JsonTemplateLayout

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

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

Modifier and Type	Method	Description
protected byte[]	SmtpManager.formatContentToBytes(LogEvent[] priorEvents, LogEvent appendEvent, Layout<?> layout)
void	SmtpManager.sendEvents(Layout<?> layout, LogEvent appendEvent)
protected void	SmtpManager.writeBuffer(LogEvent[] priorEvents, LogEvent appendEvent, Layout<?> layout, java.io.OutputStream out)
private void	SmtpManager.writeContent(LogEvent[] priorEvents, LogEvent appendEvent, Layout<?> layout, java.io.ByteArrayOutputStream out)
protected void	SmtpManager.writeFooter(Layout<?> layout, java.io.OutputStream out)
protected void	SmtpManager.writeHeader(Layout<?> layout, java.io.OutputStream out)

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 java.io.Serializable> layout, Filter filter, java.lang.String name, boolean ignoreExceptions)	Deprecated. Use ServletAppender.newBuilder().

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

Constructor	Description
ServletAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, jakarta.servlet.ServletContext servletContext, boolean ignoreExceptions, boolean logThrowables)