Uses of Interface
org.apache.logging.log4j.core.Layout
Packages that use Layout
Package
Description
Implementation of Log4j 2.
Log4j 2 Appenders.
The classes in this package and sub packages provide appenders for various types of databases and methods for
accessing databases.
The JDBC Appender supports writing log events to a relational database using standard JDBC connections.
Message oriented middleware appenders.
Classes and interfaces for ZeroMQ/JeroMQ support.
Classes and interfaces for Kafka appender support.
Rolling File Appender and support classes.
Log4j 2 Layout support.
Log4j 2 network support.
-
Uses of Layout in org.apache.logging.log4j.core
Subinterfaces of Layout in org.apache.logging.log4j.coreModifier and TypeInterfaceDescriptioninterfaceInstantiates theLayouttype for String-based layouts.Methods in org.apache.logging.log4j.core that return LayoutModifier and TypeMethodDescriptionLayout<? 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 LayoutMethods in org.apache.logging.log4j.core.appender that return LayoutModifier and TypeMethodDescriptionLayout<? 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 LayoutModifier and TypeMethodDescriptionstatic ConsoleAppenderConsoleAppender.createAppender(Layout<? extends Serializable> layout, Filter filter, String target, String name, String follow, String ignoreExceptions) Deprecated.static ConsoleAppenderConsoleAppender.createAppender(Layout<? extends Serializable> layout, Filter filter, ConsoleAppender.Target target, String name, boolean follow, boolean direct, boolean ignoreExceptions) Deprecated.Deprecated in 2.7; useConsoleAppender.newBuilder().static <B extends FileAppender.Builder<B>>
FileAppenderFileAppender.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.static <B extends MemoryMappedFileAppender.Builder<B>>
MemoryMappedFileAppenderMemoryMappedFileAppender.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.static OutputStreamAppenderOutputStreamAppender.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>>
RandomAccessFileAppenderRandomAccessFileAppender.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.static <B extends RollingFileAppender.Builder<B>>
RollingFileAppenderRollingFileAppender.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.static <B extends RollingRandomAccessFileAppender.Builder<B>>
RollingRandomAccessFileAppenderRollingRandomAccessFileAppender.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.static SmtpAppenderSmtpAppender.createAppender(Configuration config, String name, String to, String cc, String bcc, String from, String replyTo, String subject, String smtpProtocol, String smtpHost, String smtpPortStr, String smtpUsername, String smtpPassword, String smtpDebug, String bufferSizeStr, Layout<? extends Serializable> layout, Filter filter, String ignore) Deprecated.UseSmtpAppender.newBuilder()to create and configure aSmtpAppender.Builderinstance.static SocketAppenderSocketAppender.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; useSocketAppender.newBuilder()static SocketAppenderSocketAppender.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; useSocketAppender.newBuilder()static ConsoleAppenderConsoleAppender.createDefaultAppenderForLayout(Layout<? extends Serializable> layout) protected static AbstractSocketManagerSocketAppender.createSocketManager(String name, Protocol protocol, String host, int port, int connectTimeoutMillis, SslConfiguration sslConfig, int reconnectDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize) protected static AbstractSocketManagerSocketAppender.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 FileManagerFileManager.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 MemoryMappedFileManagerMemoryMappedFileManager.getFileManager(String fileName, boolean append, boolean immediateFlush, int regionLength, String advertiseURI, Layout<? extends Serializable> layout) Returns the MemoryMappedFileManager.static RandomAccessFileManagerRandomAccessFileManager.getFileManager(String fileName, boolean append, boolean immediateFlush, int bufferSize, String advertiseURI, Layout<? extends Serializable> layout, Configuration configuration) Returns the RandomAccessFileManager.abstract voidvoidAbstractAppender.Builder.setLayout(Layout<? extends Serializable> layout) SmtpAppender.Builder.setLayout(Layout<? extends Serializable> layout) Specifies the layout used for the email message body.AbstractAppender.Builder.withLayout(Layout<? extends Serializable> layout) Deprecated.Constructors in org.apache.logging.log4j.core.appender with parameters of type LayoutModifierConstructorDescriptionprotectedAbstractAppender(String name, Filter filter, Layout<? extends Serializable> layout) Deprecated.protectedAbstractAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions) Deprecated.protectedAbstractAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, Property[] properties) Constructor.protectedAbstractOutputStreamAppender(String name, Layout<? extends Serializable> layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, M manager) protectedAbstractOutputStreamAppender(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 newOutputStreamWriterinitialized withosas itsOutputStream.CountingNoOpAppender(String name, Layout<?> layout) protectedFileManager(String fileName, OutputStream os, boolean append, boolean locking, String advertiseURI, Layout<? extends Serializable> layout, boolean writeHeader, ByteBuffer buffer) Deprecated.protectedFileManager(String fileName, OutputStream os, boolean append, boolean locking, String advertiseURI, Layout<? extends Serializable> layout, int bufferSize, boolean writeHeader) Deprecated.protectedFileManager(LoggerContext loggerContext, String fileName, OutputStream os, boolean append, boolean locking, boolean createOnDemand, String advertiseURI, Layout<? extends Serializable> layout, boolean writeHeader, ByteBuffer buffer) Deprecated.protectedFileManager(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) protectedMemoryMappedFileManager(RandomAccessFile file, String fileName, OutputStream os, boolean immediateFlush, long position, int regionLength, String advertiseURI, Layout<? extends Serializable> layout, boolean writeHeader) protectedOutputStreamManager(OutputStream os, String streamName, Layout<?> layout, boolean writeHeader) protectedOutputStreamManager(OutputStream os, String streamName, Layout<?> layout, boolean writeHeader, int bufferSize) protectedOutputStreamManager(OutputStream os, String streamName, Layout<?> layout, boolean writeHeader, ByteBuffer byteBuffer) Deprecated.protectedOutputStreamManager(LoggerContext loggerContext, OutputStream os, String streamName, boolean createOnDemand, Layout<? extends Serializable> layout, boolean writeHeader, ByteBuffer byteBuffer) protectedRandomAccessFileManager(LoggerContext loggerContext, RandomAccessFile file, String fileName, OutputStream os, int bufferSize, String advertiseURI, Layout<? extends Serializable> layout, boolean writeHeader) protectedSocketAppender(String name, Layout<? extends Serializable> layout, Filter filter, AbstractSocketManager manager, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser) protectedSocketAppender(String name, Layout<? extends Serializable> layout, Filter filter, AbstractSocketManager manager, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser, Property[] properties) protectedSyslogAppender(String name, Layout<? extends Serializable> layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, AbstractSocketManager manager, Advertiser advertiser) protectedSyslogAppender(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 LayoutModifier and TypeMethodDescriptionAbstractDatabaseAppender.getLayout()This always returnsnull, 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 LayoutModifierConstructorDescriptionprotectedAbstractDatabaseAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, Property[] properties, T manager) Instantiates the base appender.protectedAbstractDatabaseAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, T manager) protectedAbstractDatabaseManager(String name, int bufferSize, Layout<? extends Serializable> layout) Deprecated.protectedAbstractDatabaseManager(String name, int bufferSize, Layout<? extends Serializable> layout, Configuration configuration) Constructs the base manager.protectedAbstractFactoryData(int bufferSize, Layout<? extends Serializable> layout) Deprecated.protectedAbstractFactoryData(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 LayoutModifier and TypeMethodDescriptionstatic JdbcDatabaseManagerJdbcDatabaseManager.getManager(String name, int bufferSize, Layout<? extends Serializable> layout, ConnectionSource connectionSource, String tableName, ColumnConfig[] columnConfigs, ColumnMapping[] columnMappings) Deprecated.static JdbcDatabaseManagerJdbcDatabaseManager.getManager(String name, int bufferSize, Layout<? extends Serializable> layout, ConnectionSource connectionSource, String tableName, ColumnConfig[] columnConfigs, ColumnMapping[] columnMappings, boolean immediateFail, long reconnectIntervalMillis) static JdbcDatabaseManagerJdbcDatabaseManager.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 theJdbcAppender, 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 LayoutModifierConstructorDescriptionprotectedJmsAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, JmsManager manager) Deprecated.protectedJmsAppender(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 LayoutModifier and TypeMethodDescriptionstatic JeroMqAppenderJeroMqAppender.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.mom.kafka
Methods in org.apache.logging.log4j.core.appender.mom.kafka with parameters of type LayoutModifier and TypeMethodDescriptionstatic KafkaAppenderKafkaAppender.createAppender(Layout<? extends Serializable> layout, Filter filter, String name, boolean ignoreExceptions, String topic, Property[] properties, Configuration configuration, String key) Deprecated. -
Uses of Layout in org.apache.logging.log4j.core.appender.rolling
Methods in org.apache.logging.log4j.core.appender.rolling with parameters of type LayoutModifier and TypeMethodDescriptionstatic RollingFileManagerRollingFileManager.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.RollingRandomAccessFileManager.getRollingRandomAccessFileManager(String fileName, String filePattern, boolean isAppend, 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 LayoutModifierConstructorDescriptionprotectedRollingFileManager(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.protectedRollingFileManager(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.protectedRollingFileManager(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.protectedRollingFileManager(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 LayoutModifier and TypeClassDescriptionclassA superclass for Comma-Separated Value (CSV) layouts.classAbstractLayout<T extends Serializable>Abstract base class for Layouts.classAbstract base class for Layouts that result in a String.classA Comma-Separated Value (CSV) layout to log events.classA Comma-Separated Value (CSV) layout to log event parameters.final classLays out events in the Graylog Extended Log Format (GELF) 1.1.final classOutputs events as rows in an HTML table on an HTML page.final classNote: The JsonLayout should be considered to be deprecated.classfinal classA flexible layout configurable with pattern string.final classFormats a log event in accordance with RFC 5424.final classDeprecated.Java Serialization has inherent security weaknesses, see https://www.owasp.org/index.php/Deserialization_of_untrusted_data .final classFormats a log event as a BSD Log record.final classAppends a series ofeventelements as defined in the Log4j-events.xsd.final classAppends a series of YAML events as strings serialized as bytes.Methods in org.apache.logging.log4j.core.layout that return Layout -
Uses of Layout in org.apache.logging.log4j.core.net
Methods in org.apache.logging.log4j.core.net with parameters of type LayoutModifier and TypeMethodDescriptionprotected byte[]SmtpManager.formatContentToBytes(LogEvent[] priorEvents, LogEvent appendEvent, Layout<?> layout) static DatagramSocketManagerDatagramSocketManager.getSocketManager(String host, int port, Layout<? extends Serializable> layout, int bufferSize) Obtain a SocketManager.static SslSocketManagerSslSocketManager.getSocketManager(SslConfiguration sslConfig, String host, int port, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize) static SslSocketManagerSslSocketManager.getSocketManager(SslConfiguration sslConfig, String host, int port, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize, SocketOptions socketOptions) static TcpSocketManagerTcpSocketManager.getSocketManager(String host, int port, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize) static TcpSocketManagerTcpSocketManager.getSocketManager(String host, int port, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize, SocketOptions socketOptions) Obtains a TcpSocketManager.abstract voidMailManager.sendEvents(Layout<?> layout, LogEvent appendEvent) Send the contents of the cyclic buffer as an e-mail message.voidSmtpManager.sendEvents(Layout<?> layout, LogEvent appendEvent) protected voidSmtpManager.writeBuffer(LogEvent[] priorEvents, LogEvent appendEvent, Layout<?> layout, OutputStream out) protected voidSmtpManager.writeFooter(Layout<?> layout, OutputStream out) protected voidSmtpManager.writeHeader(Layout<?> layout, OutputStream out) Constructors in org.apache.logging.log4j.core.net with parameters of type LayoutModifierConstructorDescriptionAbstractSocketManager(String name, OutputStream os, InetAddress inetAddress, String host, int port, Layout<? extends Serializable> layout, boolean writeHeader, int bufferSize) Constructs a new instance.protectedDatagramSocketManager(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) 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) 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.
ConsoleAppender.newBuilder().