Deprecated API
Contents
-
Deprecated InterfacesInterfaceDescriptionStarting with version
2.25.0, this class is assumed to be internal and planned to be removed in the next major release.Since 2.24.0 no class implements this.As of version2.25.0, planned to be removed!
-
Deprecated ClassesClassDescriptionUse
AtomicReference.UseAtomicReference.Useorg.apache.logging.log4j.core.appender.mom.jakarta.JmsAppender.Useorg.apache.logging.log4j.core.appender.mom.jakarta.JmsManager.since 2.24.0 useDurationinstead.Only used internally, will be removed in the next major version.since 2.24.0. ADurationconverter will be available in 3.0.0.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 isJsonLayoutwhen configured with properties="true". Deprecated since 2.9.Starting with version2.25.0, this class is assumed to be internal and planned to be removed in the next major release.Starting with version2.25.0, this class is assumed to be internal and planned to be removed in the next major release.Starting with version2.25.0, this class is assumed to be internal and planned to be removed in the next major release.Starting with version2.25.0, this class is assumed to be internal and planned to be removed in the next major release.Starting with version2.25.0, this class is assumed to be internal and planned to be removed in the next major release.Deprecated since 2.24.0.LoggeracceptsStructuredDataMessages, users should use to that instead.Starting with version2.25.0, this class is planned to be removed in the next major release.As of version2.25.0, planned to be removed!with no replacement - no longer usedAs of version2.25.0, planned to be removed!As of version2.25.0, planned to be removed!
-
Deprecated EnumsEnumDescriptionThis class is not used anymore and only kept for binary backward compatibility.
-
Deprecated FieldsFieldDescriptionOptions are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.Use
LogLog.DEBUG_KEYinstead.This variable is for internal use only. It will become private in future versions.This variable is for internal use only. It will become package protected in future versions.This variable is for internal use only. It will become private in future versions.This variable is for internal use only. It will become private in future versions.UseLevel.DEBUGinstead.UseLevel.ERRORinstead.UseLevel.FATALinstead.UseLevel.INFOinstead.UseLevel.WARNinstead.As of 1.2.12, useFilter.getNext()andFilter.setNext(Filter)insteadOptions are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.Kept for binary backward compatibility.no longer used, lookups are only used when%m{lookups}is specifiedsince 2.24.0 useStatusLogger.DEFAULT_STATUS_LISTENER_LEVELinstead.Deprecated in 2.7: useNullOutputStream.getInstance().Replaced since 2.24.0 with "log4j.provider".since 2.24.0since 2.24.0since 2.24.0
-
Deprecated MethodsMethodDescriptionPlease use
LogManager.exists(String)instead.Please useLogManager.getCurrentLoggers()instead.Please useLogManager.getLoggerRepository()instead.Please useCategory.getLoggerRepository()instead.Use the setter method for the option directly instead of the genericsetOptionmethod.Use the setter method for the option directly instead of the genericsetOptionmethod.as of 1.2.Please useHierarchy.getCurrentLoggers()instead.Deprecated with no replacement.Deprecated with no replacement.This method will be removed with no replacement.Please use theLevel.toLevel(int)method instead.Please use theLevel.toLevel(int, Level)method instead.Please use theLevel.toLevel(String)method instead.Please use theLevel.toLevel(String, Level)method instead.We now use JavaBeans introspection to configure components. Options strings are no longer needed.Use the setter method for the option directly instead of the genericsetOptionmethod.Use getNullAppender instead. getInstance should have been static.We now use JavaBeans introspection to configure components. Options strings are no longer needed.Use the setter method for the option directly instead of the genericsetOptionmethod.since 2.26.0 useAbstractFileAppender.Builder.setAdvertise(boolean).since 2.26.0 useAbstractFileAppender.Builder.setAdvertiseUri(String).since 2.26.0 useAbstractFileAppender.Builder.setAppend(boolean).since 2.26.0 useAbstractFileAppender.Builder.setCreateOnDemand(boolean).since 2.26.0 useAbstractFileAppender.Builder.setFileGroup(String).since 2.26.0 useAbstractFileAppender.Builder.setFileName(String).since 2.26.0 useAbstractFileAppender.Builder.setFileOwner(String).since 2.26.0 useAbstractFileAppender.Builder.setFilePermissions(String).since 2.26.0 useAbstractFileAppender.Builder.setLocking(boolean).In 2.7, useAbstractManager.close().since 2.26.0 useAppenderSet.Builder.setConfiguration(Configuration).since 2.26.0 useAppenderSet.Builder.setNode(Node).useAsyncAppender.BuilderinsteadDeprecated in 2.7; useConsoleAppender.newBuilder().Deprecated in 2.7; useConsoleAppender.newBuilder().since 2.11.0 UseAbstractDatabaseManager.write(LogEvent, Serializable).since 2.26.0 useFileAppender.Builder.setAdvertise(boolean).since 2.26.0 useFileAppender.Builder.setAdvertiseUri(String).since 2.26.0 useFileAppender.Builder.setAppend(boolean).since 2.26.0 useFileAppender.Builder.setCreateOnDemand(boolean).since 2.26.0 useFileAppender.Builder.setFileGroup(String).since 2.26.0 useFileAppender.Builder.setFileName(String).since 2.26.0 useFileAppender.Builder.setFileOwner(String).since 2.26.0 useFileAppender.Builder.setFilePermissions(String).since 2.26.0 useFileAppender.Builder.setLocking(boolean).end-of-batch on the event is used instead.end-of-batch on the event is used instead.Use setPassword(char[])since 2.11.0; useNoSqlAppender.Builder.end-of-batch on the event is used instead.end-of-batch on the event is used instead.In favor ofGzCompressAction.execute(File, File, boolean, int).since 2.24.0 useIfLastModified.newBuilder()instead.since 2.24.0. In 3.0.0 the signature will change.since 2.26.0 usePosixViewAttributeAction.Builder.setBasePath(String).since 2.26.0 usePosixViewAttributeAction.Builder.setConfiguration(Configuration).since 2.26.0 usePosixViewAttributeAction.Builder.setFileGroup(String).since 2.26.0 usePosixViewAttributeAction.Builder.setFileOwner(String).since 2.26.0 usePosixViewAttributeAction.Builder.setFilePermissionsString(String).since 2.26.0 usePosixViewAttributeAction.Builder.setFollowLinks(boolean).since 2.26.0 usePosixViewAttributeAction.Builder.setMaxDepth(int).since 2.26.0 usePosixViewAttributeAction.Builder.setPathConditions(PathCondition[]).since 2.26.0 usePosixViewAttributeAction.Builder.setSubst(StrSubstitutor).since 2.26.0 useDefaultRolloverStrategy.Builder.setCompressionLevelStr(String).since 2.26.0 useDefaultRolloverStrategy.Builder.setConfig(Configuration).since 2.26.0 useDefaultRolloverStrategy.Builder.setCustomActions(Action[]).org.apache.logging.log4j.core.appender.rolling.DefaultRolloverStrategy.Builder.withFileIndex(String) since 2.26.0 useDefaultRolloverStrategy.Builder.setFileIndex(String).since 2.26.0 useDefaultRolloverStrategy.Builder.setMax(String).since 2.26.0 useDefaultRolloverStrategy.Builder.setMin(String).since 2.26.0 useDefaultRolloverStrategy.Builder.setStopCustomActionsOnError(boolean).since 2.26.0 useDefaultRolloverStrategy.Builder.setTempCompressedFilePattern(String).Since 2.9 Usage of Builder API is preferablesince 2.26.0 useDirectWriteRolloverStrategy.Builder.setCompressionLevelStr(String).since 2.26.0 useDirectWriteRolloverStrategy.Builder.setConfig(Configuration).since 2.26.0 useDirectWriteRolloverStrategy.Builder.setCustomActions(Action[]).since 2.26.0 useDirectWriteRolloverStrategy.Builder.setMaxFiles(String).since 2.26.0 useDirectWriteRolloverStrategy.Builder.setStopCustomActionsOnError(boolean).since 2.26.0 useDirectWriteRolloverStrategy.Builder.setTempCompressedFilePattern(String).Since 2.9 Usage of Builder API is preferableend-of-batch on the event is used instead.org.apache.logging.log4j.core.appender.rolling.RollingRandomAccessFileManager.setEndOfBatch(boolean) end-of-batch on the event is used instead.since 2.26.0 useTimeBasedTriggeringPolicy.Builder.setInterval(int).since 2.26.0 useTimeBasedTriggeringPolicy.Builder.setMaxRandomDelay(int).since 2.26.0 useTimeBasedTriggeringPolicy.Builder.setModulate(boolean).since 2.26.0 useRollingFileAppender.Builder.setAdvertise(boolean).since 2.26.0 useRollingFileAppender.Builder.setAdvertiseUri(String).since 2.26.0 useRollingFileAppender.Builder.setAppend(boolean).since 2.26.0 useRollingFileAppender.Builder.setCreateOnDemand(boolean).since 2.26.0 useRollingFileAppender.Builder.setFileGroup(String).since 2.26.0 useRollingFileAppender.Builder.setFileName(String).since 2.26.0 useRollingFileAppender.Builder.setFileOwner(String).since 2.26.0 useRollingFileAppender.Builder.setFilePattern(String).since 2.26.0 useRollingFileAppender.Builder.setFilePermissions(String).since 2.26.0 useRollingFileAppender.Builder.setLocking(boolean).since 2.26.0 useRollingFileAppender.Builder.setPolicy(TriggeringPolicy).since 2.26.0 useRollingFileAppender.Builder.setStrategy(RolloverStrategy).since 2.26.0 useRollingRandomAccessFileAppender.Builder.setAdvertise(boolean).since 2.26.0 useRollingRandomAccessFileAppender.Builder.setAdvertiseURI(String).since 2.26.0 useRollingRandomAccessFileAppender.Builder.setAppend(boolean).org.apache.logging.log4j.core.appender.RollingRandomAccessFileAppender.Builder.withFileGroup(String) since 2.26.0 useRollingRandomAccessFileAppender.Builder.setFileGroup(String).since 2.26.0 useRollingRandomAccessFileAppender.Builder.setFileName(String).org.apache.logging.log4j.core.appender.RollingRandomAccessFileAppender.Builder.withFileOwner(String) since 2.26.0 useRollingRandomAccessFileAppender.Builder.setFileOwner(String).since 2.26.0 useRollingRandomAccessFileAppender.Builder.setFilePattern(String).since 2.26.0 useRollingRandomAccessFileAppender.Builder.setFilePermissions(String).since 2.26.0 useRollingRandomAccessFileAppender.Builder.setPolicy(TriggeringPolicy).since 2.26.0 useRollingRandomAccessFileAppender.Builder.setStrategy(RolloverStrategy).since 2.26.0 useRoutes.Builder.setConfiguration(Configuration).since 2.26.0 useRoutes.Builder.setPattern(String).since 2.26.0 useRoutes.Builder.setPatternScript(AbstractScript).since 2.26.0 useRoutes.Builder.setRoutes(Route[]).since 2.7; useRoutes.newBuilder().since 2.26.0 useRoutingAppender.Builder.setDefaultRouteScript(AbstractScript).since 2.26.0 useRoutingAppender.Builder.setPurgePolicy(PurgePolicy).since 2.26.0 useRoutingAppender.Builder.setRewritePolicy(RewritePolicy).since 2.26.0 useRoutingAppender.Builder.setRoutes(Routes).Since 2.7; useRoutingAppender.newBuilder()since 2.26.0 useScriptAppenderSelector.Builder.setAppenderNodeSet(AppenderSet).since 2.26.0 useScriptAppenderSelector.Builder.setConfiguration(Configuration).since 2.26.0 useScriptAppenderSelector.Builder.setName(String).since 2.26.0 useScriptAppenderSelector.Builder.setScript(AbstractScript).Deprecated in 2.7; useSocketAppender.newBuilder()Deprecated in 2.5; useSocketAppender.newBuilder()since 2.25.0. The method will become private in version 3.0.since 2.26.0 useAsyncWaitStrategyFactoryConfig.Builder.setFactoryClassName(String).since 2.25.0. UseLogEvent.toImmutable()instead.since 2.25.0. UseBuilder(LogEvent)instead.since 2.25.0.RingBufferLogEventTranslatorinstances should only be used on the thread that created it.This method is ineffective and only kept for binary backward compatibility.Not used internally, no replacement.since 2.26.0 useLoggerConfig.Builder.setAdditivity(boolean).since 2.26.0 useLoggerConfig.Builder.setConfig(Configuration).since 2.25.0. UseLoggerConfig.Builder.setFilter(Filter)instead.since 2.26.0 useLoggerConfig.Builder.setIncludeLocation(String).since 2.26.0 useLoggerConfig.Builder.setLevel(Level).since 2.26.0 useLoggerConfig.Builder.setLevelAndRefs(String).since 2.26.0 useLoggerConfig.Builder.setLoggerName(String).since 2.26.0 useLoggerConfig.Builder.setProperties(Property[]).since 2.26.0 useLoggerConfig.Builder.setRefs(AppenderRef[]).UseLoggerConfig.Builder.setFilter(Filter)insteaduseLoggerConfig.getPropertyList()insteadsince 2.26.0 useLoggerConfig.RootLogger.Builder.setAdditivity(boolean).since 2.26.0 useLoggerConfig.RootLogger.Builder.setConfig(Configuration).since 2.26.0 useLoggerConfig.RootLogger.Builder.setIncludeLocation(String).since 2.26.0 useLoggerConfig.RootLogger.Builder.setLevel(Level).since 2.26.0 useLoggerConfig.RootLogger.Builder.setLevelAndRefs(String).since 2.26.0 useLoggerConfig.RootLogger.Builder.setProperties(Property[]).since 2.26.0 useLoggerConfig.RootLogger.Builder.setRefs(AppenderRef[]).since 2.25.0. UseLoggerConfig.RootLogger.Builder.setFilter(Filter)instead.UsePluginProcessorinstead. To do so, simply includelog4j-corein your dependencies and make sure annotation processing is not disabled. By default, supported Java compilers will automatically use that plugin processor providedlog4j-coreis on the classpath.UseStatusLogger.getLogger()and thenAbstractLogger.error(String)instead.This class is not used anymore and only kept for binary backward compatibility.This method is ineffective and only kept for binary backward compatibility.This method is ineffective and only kept for binary backward compatibility.Since 2.24.0 useContextDataInjector.getValue(String)instead.useMapFilter.getStringMap()insteadsince 2.25.0, useStringMatchFilter.Builder.setText(String)instead.since 2.25.0 without a replacementuseLog4jLogEvent.Builderinstead. This method will be removed in an upcoming release.since 2.25.0. UseLogEvent.toImmutable()instead.since 2.25.0. UseBuilder(LogEvent)instead.no-opUseGelfLayout.newBuilder()insteadsince 2.26.0 useHtmlLayout.Builder.setCharset(Charset).since 2.26.0 useHtmlLayout.Builder.setContentType(String).since 2.26.0 useHtmlLayout.Builder.setFontName(String).since 2.26.0 useHtmlLayout.Builder.setFontSize(FontSize).since 2.26.0 useHtmlLayout.Builder.setLocationInfo(boolean).since 2.26.0 useHtmlLayout.Builder.setTitle(String).UseJsonLayout.newBuilder()insteadUseLevelPatternSelector.newBuilder()instead.UseMarkerPatternSelector.newBuilder()instead.since 2.26.0 usePatternLayout.Builder.setAlwaysWriteExceptions(boolean).since 2.26.0 usePatternLayout.Builder.setCharset(Charset).since 2.26.0 usePatternLayout.Builder.setConfiguration(Configuration).since 2.26.0 usePatternLayout.Builder.setDisableAnsi(boolean).since 2.26.0 usePatternLayout.Builder.setFooter(String).since 2.26.0 usePatternLayout.Builder.setHeader(String).since 2.26.0 usePatternLayout.Builder.setNoConsoleNoAnsi(boolean).since 2.26.0 usePatternLayout.Builder.setPattern(String).since 2.26.0 usePatternLayout.Builder.setPatternSelector(PatternSelector).since 2.26.0 usePatternLayout.Builder.setRegexReplacement(RegexReplacement).UsePatternLayout.newBuilder()instead. This will be private in a future version.UsePatternLayout.newSerializerBuilder()instead.Since 2.21.0 useinsteadSince 2.24.0 useAbstractLayout.Builder.setConfiguration(Configuration)instead.Since 2.26.0 useRfc5424Layout.Rfc5424LayoutBuilder.setNewLineEscape(String)instead.since 2.26.0 useRfc5424Layout.Rfc5424LayoutBuilder.setMdcExcludes(String)insteadSince 2.26.0 useRfc5424Layout.Rfc5424LayoutBuilder.setNewLine(boolean)instead.since 2.26.0 useRfc5424Layout.Rfc5424LayoutBuilder.setMdcIncludes(String)insteadsince 2.26.0 useRfc5424Layout.Rfc5424LayoutBuilder.setMdcRequired(String)insteadsince 2.26.0 useRfc5424Layout.Rfc5424LayoutBuilder.setUseTlsMessageFormat(boolean)insteadUseScriptPatternSelector.newBuilder()instead.UseXmlLayout.newBuilder()insteadUseYamlLayout.newBuilder()insteaduseLogEvent.getContextData()insteadsince 2.25.0. This method should be replaced withLogEvent.getThrown().since 2.25.0 without a replacement.As of 2.4, useMainMapLookup.setMainArguments(String[])Planned to be removed in the next major releaseUse getPasswordAsCharArray()Use getPasswordAsCharArray()Planned to be removed in the next major releaseStarting with version2.25.0, this method is deprecated and planned to be removed in the next major release.Starting with version2.25.0, this method is deprecated and planned to be removed in the next major release.Starting with version2.25.0, this method is deprecated and planned to be removed in the next major release.Planned to be removed without a replacementuseCommandLine.Help.synopsis(int)insteaduseCommandLine.Help.TextTable.textAt(int, int)insteadSince 2.25.0 without a replacement.org.apache.logging.log4j.core.util.StringEncoder.encodeIsoChars(CharSequence, int, byte[], int, int) No longer necessary given better performance in Java 8No longer necessary given better performance in Java 8No longer necessary given better performance in Java 8use getConfigurationWatchers.Since 2.6, useLogger.traceEntry()instead which performs the same function.since 2.11.2, useLogger.traceEntry(String, Object...)instead which performs the same function.Since 2.6, useLogger.traceExit()instead which performs the same function.Since 2.6, useLogger.traceExit(Object)instead which performs the same function.Use the Marker add or set methods to add parent Markers. Will be removed by final GA release.Use the Marker add or set methods to add parent Markers. Will be removed by final GA release.Deprecated since version2.24.0. UseMultiformatMessageinstead to implement messages that can format themselves in one or more encodings.Since 2.18.0, useStructuredDataId.makeId(String, String)insteadPlease use theSmtpManager.sendMultipartMessage(MimeMessage, MimeMultipart, String)method instead.As of version2.25.0, planned to be removed! Instead, inLoggerContext.getLogger(String, MessageFactory)implementations, namespace loggers with message factories. If your implementation usesLoggerRegistry, you are already covered.As of version2.25.0, planned to be removed! UseLoggerRegistry.getLogger(String, MessageFactory)instead.As of version2.25.0, planned to be removed! UseLoggerRegistry.hasLogger(String, MessageFactory)instead.since 2.24.0, without a replacement.since 2.23.0, this method is ineffective and only kept for binary backward compatibility.since 2.23.0, useStatusData.getInstant()instead.Since 2.23.0, instead of relying on the buffering provided byStatusLogger, users should register their own listeners to access to logged events.Since 2.23.0, instead of relying on the buffering provided byStatusLogger, users should register their own listeners to access to logged events.Since 2.23.0, instead use thesetLevel(Level)method on the fallback listener returned byStatusLogger.getFallbackListener().Since 2.23.0, instead use thesetLevel(Level)method on the fallback listener returned byStatusLogger.getFallbackListener().since 2.22.0, useBase64instead.since 2.24.0 caching of property values is disabled.UseProviderUtil.loadProvider(java.net.URL, ClassLoader)instead. Will be removed in 3.0.
-
Deprecated ConstructorsConstructorDescriptionSince 2.9 Added tempCompressedFilePatternString parameterSince 2.9 Added tempCompressedFilePatternString parameterfor performance reasons since 2.23. Use
JdkMapAdapterStringMap(Map, boolean)instead.useLog4jLogEvent.Builderinstead. This constructor will be removed in an upcoming release.useLog4jLogEvent.Builderinstead. This constructor will be removed in an upcoming release.useLog4jLogEvent.Builderinstead. This constructor will be removed in an upcoming release.UseGelfLayout.newBuilder()insteadUseJsonLayout.newBuilder()insteadUseLevelPatternSelector.newBuilder()instead. This will be private in a future version.UseMarkerPatternSelector.newBuilder()instead. This will be private in a future version.UseScriptPatternSelector.newBuilder()instead. This will be private in a future version.org.apache.logging.log4j.core.layout.XmlLayout(boolean, boolean, boolean, boolean, Charset, boolean) UseXmlLayout.newBuilder()insteadUseYamlLayout.newBuilder()insteadUseSource(URI).Since 2.6, useParameterizedMessage(String, Object[], Throwable)insteadSince 2.18.0, useStructuredDataId(String, String, String[], String[])instead.Since 2.18.0, useStructuredDataId(String, String, String[], String[], int)instead.Since 2.24.0. UseNoOpThreadContextMapfor a no-op implementation.since 2.24.0 without a replacement.As of version2.25.0, planned to be removed!since 2.24.0
-
Deprecated Enum ConstantsEnum ConstantDescriptionThis attribute sets font-weight as "bold" and doesn't set color brightness. Use BOLD if you need to change font-weight and BRIGHT_* to use a bright color.
-
Deprecated Annotation Type ElementsAnnotation Type ElementDescription