Deprecated API

Contents

• Deprecated Packages
• Deprecated Interfaces
• Deprecated Classes
• Deprecated Enums
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors
• Deprecated Enum Constants

Deprecated Packages

Package and Description
org.springframework.boot.jta.bitronix since 2.3.0 as the Bitronix project is no longer being maintained

Deprecated Interfaces

Interface and Description
org.springframework.boot.autoconfigure.elasticsearch.rest.RestClientBuilderCustomizer as of 2.3.1 in favor of RestClientBuilderCustomizer

Deprecated Classes

Class and Description
org.springframework.boot.jta.bitronix.BitronixDependentBeanFactoryPostProcessor since 2.3.0 as the Bitronix project is no longer being maintained
org.springframework.boot.jta.bitronix.BitronixXAConnectionFactoryWrapper since 2.3.0 as the Bitronix project is no longer being maintained
org.springframework.boot.jta.bitronix.BitronixXADataSourceWrapper since 2.3.0 as the Bitronix project is no longer being maintained
org.springframework.boot.actuate.cassandra.CassandraHealthIndicator since 2.4.0 in favor of CassandraDriverHealthIndicator
org.springframework.boot.actuate.cassandra.CassandraReactiveHealthIndicator since 2.4.0 in favor of CassandraDriverHealthIndicator
org.springframework.boot.test.context.ConfigFileApplicationContextInitializer since 2.4.0 in favor of ConfigDataApplicationContextInitializer
org.springframework.boot.context.config.ConfigFileApplicationListener since 2.4.0 in favor of ConfigDataEnvironmentPostProcessor
org.springframework.boot.autoconfigure.cache.CouchbaseCacheConfiguration since 2.3.3 as this class is not intended for public use. It will be made package-private in a future release
org.springframework.boot.actuate.autoconfigure.endpoint.ExposeExcludePropertyEndpointFilter since 2.2.7 in favor of IncludeExcludeEndpointFilter
org.springframework.boot.autoconfigure.batch.JobLauncherCommandLineRunner since 2.3.0 in favor of JobLauncherApplicationRunner
org.springframework.boot.jta.bitronix.PoolingConnectionFactoryBean since 2.3.0 as the Bitronix project is no longer being maintained
org.springframework.boot.jta.bitronix.PoolingDataSourceBean since 2.3.0 as the Bitronix project is no longer being maintained
org.springframework.boot.autoconfigure.web.ResourceProperties since 2.4.0 in favor of WebProperties.Resources
org.springframework.boot.autoconfigure.web.ResourceProperties.Cache
org.springframework.boot.autoconfigure.web.ResourceProperties.Cache.Cachecontrol
org.springframework.boot.autoconfigure.web.ResourceProperties.Chain
org.springframework.boot.autoconfigure.web.ResourceProperties.Content
org.springframework.boot.autoconfigure.web.ResourceProperties.Fixed
org.springframework.boot.autoconfigure.web.ResourceProperties.Strategy
org.springframework.boot.actuate.autoconfigure.metrics.ServiceLevelAgreementBoundary as of 2.3.0 in favor of ServiceLevelObjectiveBoundary

Deprecated Enums

Enum and Description
org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.LocaleResolver since 2.4.0 in favor of WebProperties.LocaleResolver

Deprecated Fields

Field and Description
org.springframework.boot.SpringApplication.DEFAULT_CONTEXT_CLASS since 2.4.0 in favour of using a ApplicationContextFactory
org.springframework.boot.SpringApplication.DEFAULT_REACTIVE_WEB_CONTEXT_CLASS since 2.4.0 in favour of using an ApplicationContextFactory
org.springframework.boot.SpringApplication.DEFAULT_SERVLET_WEB_CONTEXT_CLASS since 2.4.0 in favour of using an ApplicationContextFactory
org.springframework.boot.logging.LoggingSystemProperties.FILE_CLEAN_HISTORY_ON_START since 2.4.0 in favor of LogbackLoggingSystemProperties.ROLLINGPOLICY_CLEAN_HISTORY_ON_START
org.springframework.boot.logging.LoggingSystemProperties.FILE_MAX_HISTORY since 2.4.0 in favor of LogbackLoggingSystemProperties.ROLLINGPOLICY_MAX_HISTORY
org.springframework.boot.logging.LoggingSystemProperties.FILE_MAX_SIZE since 2.4.0 in favor of LogbackLoggingSystemProperties.ROLLINGPOLICY_MAX_FILE_SIZE
org.springframework.boot.logging.LoggingSystemProperties.FILE_TOTAL_SIZE_CAP since 2.4.0 in favor of LogbackLoggingSystemProperties.ROLLINGPOLICY_TOTAL_SIZE_CAP
org.springframework.boot.logging.LoggingSystemProperties.ROLLING_FILE_NAME_PATTERN since 2.4.0 in favor of LogbackLoggingSystemProperties.ROLLINGPOLICY_FILE_NAME_PATTERN

Deprecated Methods

Method and Description
org.springframework.boot.actuate.endpoint.invoker.cache.CachingOperationInvoker.apply(OperationInvoker, long) as of 2.3.0 to make it package-private in 2.4
org.springframework.boot.test.json.JsonContent.assertThat() to prevent accidental use. Prefer standard AssertJ assertThat(context)... calls instead.
org.springframework.boot.test.context.assertj.ApplicationContextAssertProvider.assertThat() to prevent accidental use. Prefer standard AssertJ assertThat(context)... calls instead.
org.springframework.boot.builder.SpringApplicationBuilder.contextClass(Class<? extends ConfigurableApplicationContext>) since 2.4.0 in favor of SpringApplicationBuilder.contextFactory(ApplicationContextFactory)
org.springframework.boot.loader.Launcher.createClassLoader(List<Archive>) since 2.3.0 in favor of Launcher.createClassLoader(Iterator)
org.springframework.boot.SpringApplicationRunListener.environmentPrepared(ConfigurableEnvironment) since 2.4.0 in favor of SpringApplicationRunListener.environmentPrepared(ConfigurableBootstrapContext, ConfigurableEnvironment)
org.springframework.boot.loader.archive.Archive.forEach(Consumer<? super Archive.Entry>) since 2.3.0 in favor of using JarFile to access entries and Archive.getNestedArchives(EntryFilter, EntryFilter) for accessing nested archives.
org.springframework.boot.autoconfigure.web.ServerProperties.Jetty.getAcceptors()
org.springframework.boot.test.context.SpringBootContextLoader.getArgs(MergedContextConfiguration) since 2.2.7
org.springframework.boot.loader.Launcher.getClassPathArchives() since 2.3.0 in favor of implementing Launcher.getClassPathArchivesIterator().
org.springframework.boot.autoconfigure.cassandra.CassandraProperties.getClusterName()
org.springframework.boot.autoconfigure.cassandra.CassandraProperties.getConnectTimeout()
org.springframework.boot.autoconfigure.cassandra.CassandraProperties.getConsistencyLevel()
org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties.Servlet.getContextPath() since 2.4.0 in favor of ManagementServerProperties.getBasePath()
org.springframework.boot.autoconfigure.web.reactive.WebFluxProperties.getDateFormat()
org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.getDateFormat()
org.springframework.boot.autoconfigure.web.servlet.error.AbstractErrorController.getErrorAttributes(HttpServletRequest, boolean) since 2.3.0 in favor of AbstractErrorController.getErrorAttributes(HttpServletRequest, ErrorAttributeOptions)
org.springframework.boot.web.reactive.error.ErrorAttributes.getErrorAttributes(ServerRequest, boolean) since 2.3.0 in favor of ErrorAttributes.getErrorAttributes(ServerRequest, ErrorAttributeOptions)
org.springframework.boot.web.reactive.error.DefaultErrorAttributes.getErrorAttributes(ServerRequest, boolean)
org.springframework.boot.autoconfigure.web.reactive.error.AbstractErrorWebExceptionHandler.getErrorAttributes(ServerRequest, boolean) since 2.3.0 in favor of AbstractErrorWebExceptionHandler.getErrorAttributes(ServerRequest, ErrorAttributeOptions)
org.springframework.boot.web.servlet.error.ErrorAttributes.getErrorAttributes(WebRequest, boolean) since 2.3.0 in favor of ErrorAttributes.getErrorAttributes(WebRequest, ErrorAttributeOptions)
org.springframework.boot.web.servlet.error.DefaultErrorAttributes.getErrorAttributes(WebRequest, boolean)
org.springframework.boot.web.servlet.error.ErrorController.getErrorPath() since 2.3.0 in favor of setting the property `server.error.path`
org.springframework.boot.autoconfigure.web.servlet.error.BasicErrorController.getErrorPath()
org.springframework.boot.autoconfigure.cassandra.CassandraProperties.getFetchSize()
org.springframework.boot.autoconfigure.mongo.MongoProperties.getGridFsDatabase() since 2.4.0 in favor of MongoProperties.Gridfs.getDatabase()
org.springframework.boot.autoconfigure.web.ServerProperties.Tomcat.getHostHeader()
org.springframework.boot.autoconfigure.web.ServerProperties.Tomcat.getInternalProxies()
org.springframework.boot.autoconfigure.web.ServerProperties.Undertow.getIoThreads()
org.springframework.boot.loader.tools.Layouts.Jar.getLibraryDestination(String, LibraryScope)
org.springframework.boot.loader.tools.Layouts.War.getLibraryDestination(String, LibraryScope)
org.springframework.boot.loader.tools.Layout.getLibraryDestination(String, LibraryScope) since 2.3.0 in favor of Layout.getLibraryLocation(java.lang.String, org.springframework.boot.loader.tools.LibraryScope)
org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.getLocale()
org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.getLocaleResolver()
org.springframework.boot.autoconfigure.web.ServerProperties.Jetty.getMaxQueueCapacity()
org.springframework.boot.autoconfigure.web.ServerProperties.Tomcat.getMaxThreads()
org.springframework.boot.autoconfigure.web.ServerProperties.Jetty.getMaxThreads()
org.springframework.boot.autoconfigure.web.ServerProperties.Tomcat.getMinSpareThreads()
org.springframework.boot.autoconfigure.web.ServerProperties.Jetty.getMinThreads()
org.springframework.boot.loader.archive.Archive.getNestedArchives(Archive.EntryFilter) since 2.3.0 in favor of Archive.getNestedArchives(EntryFilter, EntryFilter)
org.springframework.boot.autoconfigure.web.ServerProperties.Tomcat.getPortHeader()
org.springframework.boot.autoconfigure.web.ServerProperties.Tomcat.getProtocolHeader()
org.springframework.boot.autoconfigure.web.ServerProperties.Tomcat.getProtocolHeaderHttpsValue()
org.springframework.boot.actuate.autoconfigure.metrics.export.ganglia.GangliaProperties.getProtocolVersion()
org.springframework.boot.actuate.autoconfigure.metrics.export.ganglia.GangliaProperties.getRateUnits()
org.springframework.boot.autoconfigure.cassandra.CassandraProperties.getReadTimeout()
org.springframework.boot.autoconfigure.web.ServerProperties.Tomcat.getRemoteIpHeader()
org.springframework.boot.autoconfigure.web.ServerProperties.Jetty.getSelectors()
org.springframework.boot.autoconfigure.cassandra.CassandraProperties.getSerialConsistencyLevel()
org.springframework.boot.actuate.autoconfigure.metrics.MetricsProperties.Distribution.getSla()
org.springframework.boot.autoconfigure.security.saml2.Saml2RelyingPartyProperties.Identityprovider.getSsoUrl()
org.springframework.boot.autoconfigure.web.ServerProperties.Jetty.getThreadIdleTimeout()
org.springframework.boot.autoconfigure.web.ServerProperties.Tomcat.getUseRelativeRedirects()
org.springframework.boot.autoconfigure.web.ServerProperties.Undertow.getWorkerThreads()
org.springframework.boot.web.embedded.undertow.UndertowServletWebServerFactory.isEagerInitFilters() since 2.4.0 in favor of UndertowServletWebServerFactory.isEagerFilterInit()
org.springframework.boot.jdbc.EmbeddedDatabaseConnection.isEmbedded(String) since 2.4.0 in favor of EmbeddedDatabaseConnection.isEmbedded(String, String)
org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer.isEndpointExposed(Object)
org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer.isExtensionExposed(Object)
org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.Contentnegotiation.isFavorPathExtension()
org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.Pathmatch.isUseRegisteredSuffixPattern()
org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.Pathmatch.isUseSuffixPattern()
org.springframework.boot.loader.archive.JarFileArchive.iterator()
org.springframework.boot.loader.archive.Archive.iterator() since 2.3.0 in favor of using JarFile to access entries and Archive.getNestedArchives(EntryFilter, EntryFilter) for accessing nested archives.
org.springframework.boot.loader.archive.ExplodedArchive.iterator()
org.springframework.boot.cloud.CloudFoundryVcapEnvironmentPostProcessor.onApplicationEvent(ApplicationPreparedEvent) since 2.4.0 in favor of only using EnvironmentPostProcessor callbacks
org.springframework.boot.buildpack.platform.build.AbstractBuildLog.pulledBuilder(BuildRequest, Image)
org.springframework.boot.buildpack.platform.build.BuildLog.pulledBuilder(BuildRequest, Image) since 2.4.0 in favor of BuildLog.pulledImage(Image, ImageType)
org.springframework.boot.buildpack.platform.build.AbstractBuildLog.pulledRunImage(BuildRequest, Image)
org.springframework.boot.buildpack.platform.build.BuildLog.pulledRunImage(BuildRequest, Image) since 2.4.0 in favor of BuildLog.pulledImage(Image, ImageType)
org.springframework.boot.buildpack.platform.build.AbstractBuildLog.pullingBuilder(BuildRequest, ImageReference)
org.springframework.boot.buildpack.platform.build.BuildLog.pullingBuilder(BuildRequest, ImageReference) since 2.4.0 in favor of BuildLog.pullingImage(ImageReference, ImageType)
org.springframework.boot.buildpack.platform.build.AbstractBuildLog.pullingRunImage(BuildRequest, ImageReference)
org.springframework.boot.buildpack.platform.build.BuildLog.pullingRunImage(BuildRequest, ImageReference) since 2.4.0 in favor of BuildLog.pullingImage(ImageReference, ImageType)
org.springframework.boot.SpringApplication.refresh(ApplicationContext) since 2.3.0 in favor of SpringApplication.refresh(ConfigurableApplicationContext)
org.springframework.boot.autoconfigure.web.ServerProperties.Jetty.setAcceptors(Integer)
org.springframework.boot.SpringApplication.setApplicationContextClass(Class<? extends ConfigurableApplicationContext>) since 2.4.0 in favor of SpringApplication.setApplicationContextFactory(ApplicationContextFactory)
org.springframework.boot.autoconfigure.cassandra.CassandraProperties.setClusterName(String)
org.springframework.boot.autoconfigure.cassandra.CassandraProperties.setConnectTimeout(Duration)
org.springframework.boot.autoconfigure.cassandra.CassandraProperties.setConsistencyLevel(DefaultConsistencyLevel)
org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties.Servlet.setContextPath(String) since 2.4.0 in favor of ManagementServerProperties.setBasePath(String)
org.springframework.boot.autoconfigure.web.reactive.WebFluxProperties.setDateFormat(String)
org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.setDateFormat(String)
org.springframework.boot.web.embedded.undertow.UndertowServletWebServerFactory.setEagerInitFilters(boolean) since 2.4.0 in favor of UndertowServletWebServerFactory.isEagerFilterInit()
org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.Contentnegotiation.setFavorPathExtension(boolean)
org.springframework.boot.autoconfigure.cassandra.CassandraProperties.setFetchSize(int)
org.springframework.boot.autoconfigure.mongo.MongoProperties.setGridFsDatabase(String)
org.springframework.boot.autoconfigure.web.ServerProperties.Tomcat.setHostHeader(String)
org.springframework.boot.autoconfigure.web.ServerProperties.Tomcat.setInternalProxies(String)
org.springframework.boot.autoconfigure.web.ServerProperties.Undertow.setIoThreads(Integer)
org.springframework.boot.autoconfigure.web.ServerProperties.Jetty.setMaxQueueCapacity(Integer)
org.springframework.boot.autoconfigure.web.ServerProperties.Tomcat.setMaxThreads(int)
org.springframework.boot.autoconfigure.web.ServerProperties.Jetty.setMaxThreads(Integer)
org.springframework.boot.autoconfigure.web.ServerProperties.Tomcat.setMinSpareThreads(int)
org.springframework.boot.autoconfigure.web.ServerProperties.Jetty.setMinThreads(Integer)
org.springframework.boot.autoconfigure.web.ServerProperties.Tomcat.setPortHeader(String)
org.springframework.boot.autoconfigure.web.ServerProperties.Tomcat.setProtocolHeader(String)
org.springframework.boot.autoconfigure.web.ServerProperties.Tomcat.setProtocolHeaderHttpsValue(String)
org.springframework.boot.actuate.autoconfigure.metrics.export.ganglia.GangliaProperties.setProtocolVersion(String)
org.springframework.boot.actuate.autoconfigure.metrics.export.ganglia.GangliaProperties.setRateUnits(TimeUnit)
org.springframework.boot.autoconfigure.cassandra.CassandraProperties.setReadTimeout(Duration)
org.springframework.boot.autoconfigure.web.ServerProperties.Tomcat.setRemoteIpHeader(String)
org.springframework.boot.autoconfigure.web.ServerProperties.Jetty.setSelectors(Integer)
org.springframework.boot.autoconfigure.cassandra.CassandraProperties.setSerialConsistencyLevel(DefaultConsistencyLevel)
org.springframework.boot.autoconfigure.security.saml2.Saml2RelyingPartyProperties.Identityprovider.setSsoUrl(String)
org.springframework.boot.autoconfigure.web.ServerProperties.Jetty.setThreadIdleTimeout(Duration)
org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.Pathmatch.setUseRegisteredSuffixPattern(boolean)
org.springframework.boot.autoconfigure.web.ServerProperties.Tomcat.setUseRelativeRedirects(Boolean)
org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.Pathmatch.setUseSuffixPattern(boolean)
org.springframework.boot.autoconfigure.web.ServerProperties.Undertow.setWorkerThreads(Integer)
org.springframework.boot.loader.archive.Archive.spliterator() since 2.3.0 in favor of using JarFile to access entries and Archive.getNestedArchives(EntryFilter, EntryFilter) for accessing nested archives.
org.springframework.boot.SpringApplicationRunListener.starting() since 2.4.0 in favor of SpringApplicationRunListener.starting(ConfigurableBootstrapContext)
org.springframework.boot.actuate.metrics.web.reactive.client.WebClientExchangeTags.status(ClientResponse) since 2.3.0 in favor of WebClientExchangeTags.status(ClientResponse, Throwable)
org.springframework.boot.actuate.metrics.web.reactive.client.WebClientExchangeTags.status(Throwable) since 2.3.0 in favor of WebClientExchangeTags.status(ClientResponse, Throwable)
org.springframework.boot.actuate.autoconfigure.metrics.MeterValue.valueOf(long) as of 2.3.0 in favor of MeterValue.valueOf(double)

Deprecated Constructors

Constructor and Description
org.springframework.boot.autoconfigure.web.reactive.error.AbstractErrorWebExceptionHandler(ErrorAttributes, ResourceProperties, ApplicationContext) since 2.4.0 in favor of #AbstractErrorWebExceptionHandler(ErrorAttributes, Resources, ApplicationContext)
org.springframework.boot.context.event.ApplicationEnvironmentPreparedEvent(SpringApplication, String[], ConfigurableEnvironment) since 2.4.0 in favor of ApplicationEnvironmentPreparedEvent(ConfigurableBootstrapContext, SpringApplication, String[], ConfigurableEnvironment)
org.springframework.boot.context.event.ApplicationStartingEvent(SpringApplication, String[]) since 2.4.0 in favor of ApplicationStartingEvent(ConfigurableBootstrapContext, SpringApplication, String[])
org.springframework.boot.cloud.CloudFoundryVcapEnvironmentPostProcessor() since 2.4.0 in favor of CloudFoundryVcapEnvironmentPostProcessor(Log)
org.springframework.boot.web.reactive.error.DefaultErrorAttributes(boolean) since 2.3.0 in favor of ErrorAttributeOptions.including(Include...)
org.springframework.boot.web.servlet.error.DefaultErrorAttributes(boolean) since 2.3.0 in favor of ErrorAttributeOptions.including(Include...)
org.springframework.boot.autoconfigure.web.servlet.error.DefaultErrorViewResolver(ApplicationContext, ResourceProperties) since 2.4.0 in favour of #DefaultErrorViewResolver(ApplicationContext, Resources)
org.springframework.boot.autoconfigure.web.reactive.error.DefaultErrorWebExceptionHandler(ErrorAttributes, ResourceProperties, ErrorProperties, ApplicationContext) since 2.4.0 in favor of #DefaultErrorWebExceptionHandler(ErrorAttributes, Resources, ErrorProperties, ApplicationContext)
org.springframework.boot.autoconfigure.mongo.MongoClientFactory(MongoProperties, Environment) since 2.3.0 in favor of MongoClientFactory(List)
org.springframework.boot.autoconfigure.mongo.MongoClientFactory(MongoProperties, Environment, List<MongoClientSettingsBuilderCustomizer>) since 2.4.0 in favor of MongoClientFactory(List)
org.springframework.boot.autoconfigure.mongo.MongoClientFactorySupport(MongoProperties, Environment, List<MongoClientSettingsBuilderCustomizer>, BiFunction<MongoClientSettings, MongoDriverInformation, T>)
org.springframework.boot.test.util.TestPropertyValues.Pair(String, String) since 2.4.0 in favor of TestPropertyValues.Pair.of(String, String)
org.springframework.boot.autoconfigure.mongo.ReactiveMongoClientFactory(MongoProperties, Environment, List<MongoClientSettingsBuilderCustomizer>) since 2.4.0 in favor of ReactiveMongoClientFactory(List)
org.springframework.boot.web.embedded.undertow.UndertowServletWebServer(Undertow.Builder, DeploymentManager, String, boolean, boolean, Compression) since 2.3.0 in favor of UndertowServletWebServer(io.undertow.Undertow.Builder, Iterable, String, boolean)
org.springframework.boot.web.embedded.undertow.UndertowServletWebServer(Undertow.Builder, DeploymentManager, String, boolean, boolean, Compression, String) since 2.3.0 in favor of UndertowServletWebServer(io.undertow.Undertow.Builder, Iterable, String, boolean)
org.springframework.boot.web.embedded.undertow.UndertowServletWebServer(Undertow.Builder, DeploymentManager, String, boolean, Compression) since 2.3.0 in favor of UndertowServletWebServer(io.undertow.Undertow.Builder, Iterable, String, boolean)
org.springframework.boot.web.embedded.undertow.UndertowWebServer(Undertow.Builder, boolean, Closeable) since 2.3.0 in favor of UndertowWebServer(io.undertow.Undertow.Builder, Iterable, boolean)
org.springframework.boot.autoconfigure.web.format.WebConversionService(String) since 2.3.0 in favor of WebConversionService(DateTimeFormatters)

Deprecated Enum Constants

Enum Constant and Description
org.springframework.boot.jdbc.EmbeddedDatabaseConnection.HSQL since 2.4.0 in favor of EmbeddedDatabaseConnection.HSQLDB.
org.springframework.boot.autoconfigure.web.ErrorProperties.IncludeStacktrace.ON_TRACE_PARAM