Uses of Interface
org.apache.logging.log4j.core.Layout
-
Packages that use Layout Package Description 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.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.web.appender -
-
Uses of Layout in org.apache.log4j.layout
Classes in org.apache.log4j.layout that implement Layout Modifier and Type Class Description class
Log4j1XmlLayout
Port of XMLLayout in Log4j 1.x. -
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 protected Layout<?>
OutputStreamManager. 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; useConsoleAppender.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; useConsoleAppender.newBuilder()
.static <B extends FileAppender.Builder<B>>
FileAppenderFileAppender. 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.static <B extends MemoryMappedFileAppender.Builder<B>>
MemoryMappedFileAppenderMemoryMappedFileAppender. 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.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>>
RandomAccessFileAppenderRandomAccessFileAppender. 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.static <B extends RollingFileAppender.Builder<B>>
RollingFileAppenderRollingFileAppender. 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.static <B extends RollingRandomAccessFileAppender.Builder<B>>
RollingRandomAccessFileAppenderRollingRandomAccessFileAppender. 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.static SmtpAppender
SmtpAppender. createAppender(Configuration config, java.lang.String name, java.lang.String to, java.lang.String cc, java.lang.String bcc, java.lang.String from, java.lang.String replyTo, java.lang.String subject, java.lang.String smtpProtocol, java.lang.String smtpHost, java.lang.String smtpPortStr, java.lang.String smtpUsername, java.lang.String smtpPassword, java.lang.String smtpDebug, java.lang.String bufferSizeStr, Layout<? extends java.io.Serializable> layout, Filter filter, java.lang.String ignore)
Create a SmtpAppender.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; useSocketAppender.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; useSocketAppender.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)
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.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 isFlush, int bufferSize, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout, Configuration configuration)
Returns the RandomAccessFileManager.abstract void
HttpManager. send(Layout<?> layout, LogEvent event)
void
HttpURLConnectionManager. send(Layout<?> layout, LogEvent event)
OutputStreamAppender.Builder
OutputStreamAppender.Builder. setLayout(Layout<? extends java.io.Serializable> aLayout)
B
AbstractAppender.Builder. withLayout(Layout<? extends java.io.Serializable> 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)
Constructor that defaults to suppressing exceptions.AbstractAppender(java.lang.String name, Filter filter, Layout<? extends java.io.Serializable> layout, boolean ignoreExceptions)
Constructor.AbstractOutputStreamAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, M manager)
Instantiates a WriterAppender and set the output destination to a newOutputStreamWriter
initialized withos
as itsOutputStream
.CountingNoOpAppender(java.lang.String name, Layout<?> layout)
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)
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)
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)
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)
SocketAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, AbstractSocketManager manager, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser)
SyslogAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, AbstractSocketManager manager, Advertiser advertiser)
-
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 returnsnull
, as database appenders do not use a single layout. -
Uses of Layout in org.apache.logging.log4j.core.appender.db.jdbc
Methods in org.apache.logging.log4j.core.appender.db.jdbc that return Layout Modifier and Type Method Description Layout<? extends java.io.Serializable>
JdbcAppender.Builder. getLayout()
Deprecated.Layout<? extends java.io.Serializable>
JdbcAppender.Builder. getOrCreateLayout()
Deprecated.Layout<? extends java.io.Serializable>
JdbcAppender.Builder. getOrCreateLayout(java.nio.charset.Charset charset)
Deprecated.Methods in org.apache.logging.log4j.core.appender.db.jdbc with parameters of type Layout Modifier and Type Method Description B
JdbcAppender.Builder. withLayout(Layout<? extends java.io.Serializable> layout)
Deprecated. -
Uses of Layout in org.apache.logging.log4j.core.appender.mom
Methods in org.apache.logging.log4j.core.appender.mom with parameters of type Layout Modifier and Type Method Description JmsAppender.Builder
JmsAppender.Builder. setLayout(Layout<? extends java.io.Serializable> layout)
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)
-
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)
-
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(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 RollingFileManager(java.lang.String fileName, java.lang.String pattern, java.io.OutputStream os, boolean append, long size, long time, 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 time, 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 time, 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 time, 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 time, 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.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
Appends a series of JSON events as strings serialized as bytes.class
MessageLayout
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 ofevent
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
Methods in org.apache.logging.log4j.core.net with parameters of type Layout Modifier and Type Method Description protected byte[]
SmtpManager. formatContentToBytes(LogEvent[] priorEvents, LogEvent appendEvent, Layout<?> layout)
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)
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)
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.void
SmtpManager. sendEvents(Layout<?> layout, LogEvent appendEvent)
Send the contents of the cyclic buffer as an e-mail message.protected void
SmtpManager. writeBuffer(LogEvent[] priorEvents, LogEvent appendEvent, Layout<?> layout, java.io.OutputStream out)
protected void
SmtpManager. writeFooter(Layout<?> layout, java.io.OutputStream out)
protected void
SmtpManager. writeHeader(Layout<?> layout, java.io.OutputStream out)
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)
The Constructor.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.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)
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)
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.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.
-