Deprecated API

Contents

• Deprecated Classes
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors
• Deprecated Annotation Type Elements

Deprecated Classes

Class and Description
org.apache.logging.log4j.core.layout.SerializedLayout Java Serialization has inherent security weaknesses, see https://www.owasp.org/index.php/Deserialization_of_untrusted_data . Using this layout is no longer recommended. An alternative layout containing the same information is JsonLayout when configured with properties="true". Deprecated since 2.9.

Deprecated Fields

Field and Description
org.apache.logging.log4j.core.util.Constants.FORMAT_MESSAGES_PATTERN_DISABLE_LOOKUPS Since 2.12.2
org.apache.logging.log4j.core.util.NullOutputStream.NULL_OUTPUT_STREAM Deprecated in 2.7: use NullOutputStream.getInstance().

Deprecated Methods

Method and Description
org.apache.logging.log4j.core.util.datetime.FastDatePrinter.applyRules(Calendar, StringBuffer) use FastDatePrinter.format(Calendar) or FastDatePrinter.format(Calendar, Appendable)
org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.TextTable.cellAt(int, int) use CommandLine.Help.TextTable.textAt(int, int) instead
org.apache.logging.log4j.core.appender.AsyncAppender.createAppender(AppenderRef[], String, boolean, long, int, String, boolean, Filter, Configuration, boolean) use AsyncAppender.Builder instead
org.apache.logging.log4j.core.appender.SmtpAppender.createAppender(Configuration, String, String, String, String, String, String, String, String, String, String, String, String, String, String, Layout<? extends Serializable>, Filter, String) Use SmtpAppender.newBuilder() to create and configure a SmtpAppender.Builder instance.
org.apache.logging.log4j.core.appender.ConsoleAppender.createAppender(Layout<? extends Serializable>, Filter, ConsoleAppender.Target, String, boolean, boolean, boolean) Deprecated in 2.7; use ConsoleAppender.newBuilder().
org.apache.logging.log4j.core.appender.mom.kafka.KafkaAppender.createAppender(Layout<? extends Serializable>, Filter, String, boolean, String, Property[], Configuration, String)
org.apache.logging.log4j.core.appender.ConsoleAppender.createAppender(Layout<? extends Serializable>, Filter, String, String, String, String) Deprecated in 2.7; use ConsoleAppender.newBuilder().
org.apache.logging.log4j.core.appender.SocketAppender.createAppender(String, int, Protocol, SslConfiguration, int, int, boolean, String, boolean, boolean, Layout<? extends Serializable>, Filter, boolean, Configuration) Deprecated in 2.7; use SocketAppender.newBuilder()
org.apache.logging.log4j.core.appender.SyslogAppender.createAppender(String, int, String, SslConfiguration, int, int, boolean, String, boolean, boolean, Facility, String, int, boolean, String, String, String, boolean, String, String, String, String, String, String, String, Filter, Configuration, Charset, String, LoggerFields[], boolean) Use SyslogAppender.newSyslogAppenderBuilder().
org.apache.logging.log4j.core.appender.db.jdbc.JdbcAppender.createAppender(String, String, Filter, ConnectionSource, String, String, ColumnConfig[]) use JdbcAppender.newBuilder()
org.apache.logging.log4j.core.appender.nosql.NoSqlAppender.createAppender(String, String, Filter, String, NoSqlProvider<?>) since 2.11.0; use NoSqlAppender.Builder.
org.apache.logging.log4j.core.appender.routing.RoutingAppender.createAppender(String, String, Routes, Configuration, RewritePolicy, PurgePolicy, Filter) Since 2.7; use RoutingAppender.newBuilder()
org.apache.logging.log4j.core.appender.SocketAppender.createAppender(String, String, String, SslConfiguration, int, String, String, String, String, String, Layout<? extends Serializable>, Filter, String, Configuration) Deprecated in 2.5; use SocketAppender.newBuilder()
org.apache.logging.log4j.core.appender.MemoryMappedFileAppender.createAppender(String, String, String, String, String, String, Layout<? extends Serializable>, Filter, String, String, Configuration) Use MemoryMappedFileAppender.newBuilder().
org.apache.logging.log4j.core.appender.RandomAccessFileAppender.createAppender(String, String, String, String, String, String, Layout<? extends Serializable>, Filter, String, String, Configuration) Use RandomAccessFileAppender.newBuilder().
org.apache.logging.log4j.core.appender.FileAppender.createAppender(String, String, String, String, String, String, String, String, Layout<? extends Serializable>, Filter, String, String, Configuration) Use FileAppender.newBuilder()
org.apache.logging.log4j.core.appender.RollingFileAppender.createAppender(String, String, String, String, String, String, String, TriggeringPolicy, RolloverStrategy, Layout<? extends Serializable>, Filter, String, String, String, Configuration) Use RollingFileAppender.newBuilder().
org.apache.logging.log4j.core.appender.RollingRandomAccessFileAppender.createAppender(String, String, String, String, String, String, TriggeringPolicy, RolloverStrategy, Layout<? extends Serializable>, Filter, String, String, String, Configuration) Use RollingRandomAccessFileAppender.newBuilder().
org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig.createColumnConfig(Configuration, String, String, String, String, String, String) use ColumnConfig.newBuilder()
org.apache.logging.log4j.core.impl.Log4jLogEvent.createEvent(String, Marker, String, Level, Message, Throwable, ThrowableProxy, Map<String, String>, ThreadContext.ContextStack, String, StackTraceElement, long) use Log4jLogEvent.Builder instead. This method will be removed in an upcoming release.
org.apache.logging.log4j.core.net.ssl.KeyStoreConfiguration.createKeyStoreConfiguration(String, char[], String, String) use KeyStoreConfiguration.createKeyStoreConfiguration(String, char[], String, String, String, String)
org.apache.logging.log4j.core.net.ssl.TrustStoreConfiguration.createKeyStoreConfiguration(String, char[], String, String) Use TrustStoreConfiguration.createKeyStoreConfiguration(String, char[], String, String, String, String)
org.apache.logging.log4j.core.net.ssl.KeyStoreConfiguration.createKeyStoreConfiguration(String, String, String, String) Use createKeyStoreConfiguration(String, char[], String, String)
org.apache.logging.log4j.core.net.ssl.TrustStoreConfiguration.createKeyStoreConfiguration(String, String, String, String) Use createKeyStoreConfiguration(String, char[], String, String)
org.apache.logging.log4j.core.layout.SerializedLayout.createLayout()
org.apache.logging.log4j.core.layout.XmlLayout.createLayout(boolean, boolean, boolean, boolean, Charset, boolean) Use XmlLayout.newBuilder() instead
org.apache.logging.log4j.core.layout.JsonLayout.createLayout(Configuration, boolean, boolean, boolean, boolean, boolean, boolean, String, String, Charset, boolean) Use JsonLayout.newBuilder() instead
org.apache.logging.log4j.core.layout.YamlLayout.createLayout(Configuration, boolean, boolean, String, String, Charset, boolean) Use YamlLayout.newBuilder() instead
org.apache.logging.log4j.core.layout.SyslogLayout.createLayout(Facility, boolean, String, Charset) Use SyslogLayout.newBuilder().
org.apache.logging.log4j.core.layout.GelfLayout.createLayout(String, KeyValuePair[], GelfLayout.CompressionType, int, boolean) Use GelfLayout.newBuilder() instead
org.apache.logging.log4j.core.layout.PatternLayout.createLayout(String, PatternSelector, Configuration, RegexReplacement, Charset, boolean, boolean, String, String) Use PatternLayout.newBuilder() instead. This will be private in a future version.
org.apache.logging.log4j.core.config.LoggerConfig.createLogger(String, Level, String, String, AppenderRef[], Property[], Configuration, Filter) Deprecated in 2.7; use LoggerConfig.createLogger(boolean, Level, String, String, AppenderRef[], Property[], Configuration, Filter)
org.apache.logging.log4j.core.async.AsyncLoggerConfig.RootLogger.createLogger(String, String, String, AppenderRef[], Property[], Configuration, Filter) use AsyncLoggerConfig.RootLogger.createLogger(String, Level, String, AppenderRef[], Property[], Configuration, Filter)
org.apache.logging.log4j.core.async.AsyncLoggerConfig.createLogger(String, String, String, String, AppenderRef[], Property[], Configuration, Filter) use AsyncLoggerConfig.createLogger(boolean, Level, String, String, AppenderRef[], Property[], Configuration, Filter)
org.apache.logging.log4j.core.appender.rolling.TimeBasedTriggeringPolicy.createPolicy(String, String) Use TimeBasedTriggeringPolicy.newBuilder().
org.apache.logging.log4j.core.appender.routing.Routes.createRoutes(String, Route...) since 2.7; use Routes.newBuilder().
org.apache.logging.log4j.core.layout.ScriptPatternSelector.createSelector(AbstractScript, PatternMatch[], String, boolean, boolean, Configuration) Use ScriptPatternSelector.newBuilder() instead.
org.apache.logging.log4j.core.layout.MarkerPatternSelector.createSelector(PatternMatch[], String, boolean, boolean, Configuration) Use MarkerPatternSelector.newBuilder() instead.
org.apache.logging.log4j.core.layout.PatternLayout.createSerializer(Configuration, RegexReplacement, String, String, PatternSelector, boolean, boolean) Use PatternLayout.newSerializerBuilder() instead.
org.apache.logging.log4j.core.appender.SocketAppender.createSocketManager(String, Protocol, String, int, int, SslConfiguration, int, boolean, Layout<? extends Serializable>, int) Use SocketAppender.createSocketManager(String, Protocol, String, int, int, SslConfiguration, int, boolean, Layout, int, SocketOptions).
org.apache.logging.log4j.core.appender.rolling.DirectWriteRolloverStrategy.createStrategy(String, String, Action[], boolean, Configuration) Since 2.9 Usage of Builder API is preferable
org.apache.logging.log4j.core.appender.rolling.DefaultRolloverStrategy.createStrategy(String, String, String, String, Action[], boolean, Configuration) Since 2.9 Usage of Builder API is preferable
org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.detailedSynopsis(Comparator<Field>, boolean) use CommandLine.Help.detailedSynopsis(int, Comparator, boolean) instead.
org.apache.logging.log4j.core.layout.TextEncoderHelper.encodeText(CharsetEncoder, CharBuffer, ByteBufferDestination)
org.apache.logging.log4j.core.appender.rolling.action.GzCompressAction.execute(File, File, boolean) In favor of GzCompressAction.execute(File, File, boolean, int).
org.apache.logging.log4j.core.util.datetime.FastDatePrinter.format(Object, StringBuilder, FieldPosition) Use {FastDatePrinter.format(Date), {FastDatePrinter.format(Calendar), {FastDatePrinter.format(long), or {FastDatePrinter.format(Object)
org.apache.logging.log4j.core.LogEvent.getContextMap() use LogEvent.getContextData() instead
org.apache.logging.log4j.core.filter.CompositeFilter.getFilters() Use CompositeFilter.getFiltersArray()
org.apache.logging.log4j.core.appender.db.jdbc.JdbcDatabaseManager.getJDBCDatabaseManager(String, int, ConnectionSource, String, ColumnConfig[]) use JdbcDatabaseManager.getManager(String, int, Layout, ConnectionSource, String, ColumnConfig[], ColumnMapping[], boolean, long)
org.apache.logging.log4j.core.appender.db.jdbc.JdbcDatabaseManager.getManager(String, int, Layout<? extends Serializable>, ConnectionSource, String, ColumnConfig[], ColumnMapping[])
org.apache.logging.log4j.core.appender.db.jdbc.JdbcDatabaseManager.getManager(String, int, Layout<? extends Serializable>, ConnectionSource, String, ColumnConfig[], ColumnMapping[], boolean, long) use JdbcDatabaseManager.getManager(String, int, Layout, ConnectionSource, String, ColumnConfig[], ColumnMapping[], boolean, long)
org.apache.logging.log4j.core.filter.MapFilter.getMap() use MapFilter.getStringMap() instead
org.apache.logging.log4j.core.net.MimeMessageBuilder.getMimeMessage() Use MimeMessageBuilder.build().
org.apache.logging.log4j.core.net.ssl.StoreConfiguration.getPassword() Use getPasswordAsCharArray()
org.apache.logging.log4j.core.config.LoggerConfig.getProperties() use LoggerConfig.getPropertyList() instead
org.apache.logging.log4j.core.net.SslSocketManager.getSocketManager(SslConfiguration, String, int, int, int, boolean, Layout<? extends Serializable>, int) Use SslSocketManager.getSocketManager(SslConfiguration, String, int, int, int, boolean, Layout, int, SocketOptions).
org.apache.logging.log4j.core.net.TcpSocketManager.getSocketManager(String, int, int, int, boolean, Layout<? extends Serializable>, int) Use TcpSocketManager.getSocketManager(String, int, int, int, boolean, Layout, int, SocketOptions).
org.apache.logging.log4j.core.util.WatchManager.getWatchers() use getConfigurationWatchers.
org.apache.logging.log4j.core.config.LoggerConfig.includeLocation(String) Please use LoggerConfig.includeLocation(String, Configuration)
org.apache.logging.log4j.core.config.plugins.util.PluginManager.main(String[]) Use PluginProcessor instead. To do so, simply include log4j-core in your dependencies and make sure annotation processing is not disabled. By default, supported Java compilers will automatically use that plugin processor provided log4j-core is on the classpath.
org.apache.logging.log4j.core.appender.AbstractManager.release() In 2.7, use AbstractManager.close().
org.apache.logging.log4j.core.impl.Log4jLogEvent.Builder.setContextMap(Map<String, String>)
org.apache.logging.log4j.core.lookup.MapLookup.setMainArguments(String...) As of 2.4, use MainMapLookup.setMainArguments(String[])
org.apache.logging.log4j.core.appender.mom.JmsAppender.Builder.setPassword(String) Use setPassword(char[])
org.apache.logging.log4j.core.net.ssl.StoreConfiguration.setPassword(String) Use getPasswordAsCharArray()
org.apache.logging.log4j.core.appender.mom.JmsAppender.Builder.setUsername(String) Use JmsAppender.Builder.setUserName(String).
org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.synopsis() use CommandLine.Help.synopsis(int) instead
org.apache.logging.log4j.core.appender.AbstractAppender.Builder.withConfiguration(Configuration) Use AbstractAppender.Builder.setConfiguration(Configuration)
org.apache.logging.log4j.core.filter.AbstractFilterable.Builder.withFilter(Filter) Use AbstractFilterable.Builder.setFilter(Filter).
org.apache.logging.log4j.core.appender.AbstractAppender.Builder.withIgnoreExceptions(boolean) use AbstractAppender.Builder.setIgnoreExceptions(boolean).
org.apache.logging.log4j.core.appender.AbstractAppender.Builder.withLayout(Layout<? extends Serializable>) use AbstractAppender.Builder.setLayout(Layout).
org.apache.logging.log4j.core.appender.AbstractAppender.Builder.withName(String) use AbstractAppender.Builder.setName(String).
org.apache.logging.log4j.core.appender.db.AbstractDatabaseManager.write(LogEvent) since 2.11.0 Use AbstractDatabaseManager.write(LogEvent, Serializable).
org.apache.logging.log4j.core.appender.db.AbstractDatabaseManager.writeInternal(LogEvent) Use AbstractDatabaseManager.writeInternal(LogEvent, Serializable).

Deprecated Constructors

Constructor and Description
org.apache.logging.log4j.core.appender.AbstractAppender(String, Filter, Layout<? extends Serializable>) Use AbstractAppender.AbstractAppender(String, Filter, Layout, boolean, Property[]).
org.apache.logging.log4j.core.appender.AbstractAppender(String, Filter, Layout<? extends Serializable>, boolean) Use AbstractAppender.AbstractAppender(String, Filter, Layout, boolean, Property[])
org.apache.logging.log4j.core.appender.db.AbstractDatabaseAppender(String, Filter, boolean, T) Use AbstractDatabaseAppender.AbstractDatabaseAppender(String, Filter, Layout, boolean, Property[], AbstractDatabaseManager).
org.apache.logging.log4j.core.appender.db.AbstractDatabaseAppender(String, Filter, Layout<? extends Serializable>, boolean, T) Use AbstractDatabaseAppender.AbstractDatabaseAppender(String, Filter, Layout, boolean, Property[], AbstractDatabaseManager)
org.apache.logging.log4j.core.net.ssl.AbstractKeyStoreConfiguration(String, char[], String) Use AbstractKeyStoreConfiguration.AbstractKeyStoreConfiguration(String, PasswordProvider, String) instead
org.apache.logging.log4j.core.net.ssl.AbstractKeyStoreConfiguration(String, String, String) Use AbstractKeyStoreConfiguration.AbstractKeyStoreConfiguration(String, PasswordProvider, String) instead
org.apache.logging.log4j.core.layout.AbstractLayout(byte[], byte[]) Use AbstractLayout.AbstractLayout(Configuration, byte[], byte[])
org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender(String, Layout<? extends Serializable>, Filter, boolean, boolean, M) Use AbstractOutputStreamAppender.AbstractOutputStreamAppender(String, Layout, Filter, boolean, boolean, Property[], OutputStreamManager)
org.apache.logging.log4j.core.appender.AbstractWriterAppender(String, StringLayout, Filter, boolean, boolean, M) Use AbstractWriterAppender.AbstractWriterAppender(String, StringLayout, Filter, boolean, boolean, Property[], WriterManager).
org.apache.logging.log4j.core.appender.rolling.DefaultRolloverStrategy(int, int, boolean, int, StrSubstitutor, Action[], boolean) Since 2.9 Added tempCompressedFilePatternString parameter
org.apache.logging.log4j.core.appender.rolling.DirectWriteRolloverStrategy(int, int, StrSubstitutor, Action[], boolean) Since 2.9 Added tempCompressedFilePatternString parameter
org.apache.logging.log4j.core.appender.FileManager(LoggerContext, String, OutputStream, boolean, boolean, boolean, String, Layout<? extends Serializable>, boolean, ByteBuffer)
org.apache.logging.log4j.core.appender.FileManager(String, OutputStream, boolean, boolean, String, Layout<? extends Serializable>, boolean, ByteBuffer)
org.apache.logging.log4j.core.appender.FileManager(String, OutputStream, boolean, boolean, String, Layout<? extends Serializable>, int, boolean)
org.apache.logging.log4j.core.layout.GelfLayout(String, KeyValuePair[], GelfLayout.CompressionType, int, boolean) Use GelfLayout.newBuilder() instead
org.apache.logging.log4j.core.appender.rolling.action.GzCompressAction(File, File, boolean) Prefer GzCompressAction.GzCompressAction(File, File, boolean, int).
org.apache.logging.log4j.core.appender.mom.JmsAppender(String, Filter, Layout<? extends Serializable>, boolean, JmsManager)
org.apache.logging.log4j.core.layout.JsonLayout(Configuration, boolean, boolean, boolean, boolean, boolean, boolean, String, String, String, Charset, boolean) Use JsonLayout.newBuilder() instead
org.apache.logging.log4j.core.net.ssl.KeyStoreConfiguration(String, char[], String, String) use KeyStoreConfiguration.KeyStoreConfiguration(String, PasswordProvider, String, String) instead
org.apache.logging.log4j.core.net.ssl.KeyStoreConfiguration(String, String, String, String) Use KeyStoreConfiguration.KeyStoreConfiguration(String, PasswordProvider, String, String) instead
org.apache.logging.log4j.core.impl.Log4jLogEvent(long) use Log4jLogEvent.Builder instead. This constructor will be removed in an upcoming release.
org.apache.logging.log4j.core.impl.Log4jLogEvent(String, Marker, String, Level, Message, Throwable) use Log4jLogEvent.Builder instead. This constructor will be removed in an upcoming release.
org.apache.logging.log4j.core.impl.Log4jLogEvent(String, Marker, String, Level, Message, Throwable, Map<String, String>, ThreadContext.ContextStack, String, StackTraceElement, long) use Log4jLogEvent.Builder instead. This constructor will be removed in an upcoming release.
org.apache.logging.log4j.core.layout.MarkerPatternSelector(PatternMatch[], String, boolean, boolean, Configuration) Use MarkerPatternSelector.newBuilder() instead. This will be private in a future version.
org.apache.logging.log4j.core.appender.OutputStreamManager(OutputStream, String, Layout<?>, boolean, ByteBuffer)
org.apache.logging.log4j.core.appender.rolling.RollingFileManager(LoggerContext, String, String, OutputStream, boolean, boolean, long, long, TriggeringPolicy, RolloverStrategy, String, Layout<? extends Serializable>, boolean, ByteBuffer)
org.apache.logging.log4j.core.appender.rolling.RollingFileManager(String, String, OutputStream, boolean, long, long, TriggeringPolicy, RolloverStrategy, String, Layout<? extends Serializable>, boolean, ByteBuffer)
org.apache.logging.log4j.core.appender.rolling.RollingFileManager(String, String, OutputStream, boolean, long, long, TriggeringPolicy, RolloverStrategy, String, Layout<? extends Serializable>, int, boolean)
org.apache.logging.log4j.core.appender.rolling.RollingRandomAccessFileManager(LoggerContext, RandomAccessFile, String, String, OutputStream, boolean, boolean, int, long, long, TriggeringPolicy, RolloverStrategy, String, Layout<? extends Serializable>, boolean)
org.apache.logging.log4j.core.layout.ScriptPatternSelector(AbstractScript, PatternMatch[], String, boolean, boolean, boolean, Configuration) Use ScriptPatternSelector.newBuilder() instead. This will be private in a future version.
org.apache.logging.log4j.core.appender.SocketAppender(String, Layout<? extends Serializable>, Filter, AbstractSocketManager, boolean, boolean, Advertiser) SocketAppender.SocketAppender(String, Layout, Filter, AbstractSocketManager, boolean, boolean, Advertiser, Property[]).
org.apache.logging.log4j.core.net.SslSocketManager(String, OutputStream, Socket, SslConfiguration, InetAddress, String, int, int, int, boolean, Layout<? extends Serializable>, int) Use SslSocketManager.SslSocketManager(String, OutputStream, Socket, SslConfiguration, InetAddress, String, int, int, int, boolean, Layout, int, SocketOptions).
org.apache.logging.log4j.core.net.ssl.StoreConfiguration(String, char[]) Use StoreConfiguration.StoreConfiguration(String, PasswordProvider)
org.apache.logging.log4j.core.net.ssl.StoreConfiguration(String, String) Use StoreConfiguration.StoreConfiguration(String, PasswordProvider)
org.apache.logging.log4j.core.appender.SyslogAppender(String, Layout<? extends Serializable>, Filter, boolean, boolean, AbstractSocketManager, Advertiser) Use SyslogAppender.SyslogAppender(String, Layout, Filter, boolean, boolean, AbstractSocketManager, Advertiser, Property[]).
org.apache.logging.log4j.core.net.TcpSocketManager(String, OutputStream, Socket, InetAddress, String, int, int, int, boolean, Layout<? extends Serializable>, int) Use TcpSocketManager.TcpSocketManager(String, OutputStream, Socket, InetAddress, String, int, int, int, boolean, Layout, int, SocketOptions).
org.apache.logging.log4j.core.pattern.ThrowablePatternConverter(String, String, String[]) Use ThrowablePatternConverter(String name, String stule, String[] options, Configuration config)
org.apache.logging.log4j.core.net.ssl.TrustStoreConfiguration(String, char[], String, String) Use TrustStoreConfiguration.TrustStoreConfiguration(String, PasswordProvider, String, String) instead
org.apache.logging.log4j.core.net.ssl.TrustStoreConfiguration(String, String, String, String) Use TrustStoreConfiguration.TrustStoreConfiguration(String, PasswordProvider, String, String) instead
org.apache.logging.log4j.core.layout.XmlLayout(boolean, boolean, boolean, boolean, Charset, boolean) Use XmlLayout.newBuilder() instead
org.apache.logging.log4j.core.layout.YamlLayout(Configuration, boolean, boolean, boolean, boolean, boolean, String, String, Charset, boolean) Use YamlLayout.newBuilder() instead

Deprecated Annotation Type Elements

Annotation Type Element and Description
org.apache.logging.log4j.core.tools.picocli.CommandLine.Option.help Use CommandLine.Option.usageHelp() and CommandLine.Option.versionHelp() instead. See CommandLine.printHelpIfRequested(List, PrintStream, CommandLine.Help.Ansi)