Deprecated API

Contents

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

Deprecated Interfaces

Interface and Description
org.springframework.boot.Bootstrapper since 2.4.5 for removal in 2.6 in favor of BootstrapRegistryInitializer

Deprecated Classes

Class and Description
org.springframework.boot.actuate.endpoint.http.ActuatorMediaType since 2.5.0 for removal in 2.7.0 in favor of ApiVersion.getProducedMimeType()
org.springframework.boot.actuate.cassandra.CassandraHealthIndicator since 2.4.0 for removal in 2.6.0 in favor of CassandraDriverHealthIndicator
org.springframework.boot.actuate.cassandra.CassandraReactiveHealthIndicator since 2.4.0 for removal in 2.6.0 in favor of CassandraDriverHealthIndicator
org.springframework.boot.context.logging.ClasspathLoggingApplicationListener since 2.4.0 for removal in 2.6.0 with no direct replacement. FailureAnalysis is now the preferred approach for diagnosing and reporting startup failures.
org.springframework.boot.test.context.ConfigFileApplicationContextInitializer since 2.4.0 for removal in 2.6.0 in favor of ConfigDataApplicationContextInitializer
org.springframework.boot.context.config.ConfigFileApplicationListener since 2.4.0 for removal in 2.6.0 in favor of ConfigDataEnvironmentPostProcessor
org.springframework.boot.autoconfigure.r2dbc.ConnectionFactoryBuilder since 2.5.0 for removal in 2.7.0 in favor of ConnectionFactoryBuilder
org.springframework.boot.autoconfigure.jdbc.DataSourceSchemaCreatedEvent since 2.5.0 for removal in 2.7.0 with no replacement as the event is no longer published
org.springframework.boot.autoconfigure.jooq.DslContextDependsOnPostProcessor since 2.5.0 for removal in 2.7.0 in favor of DependsOnDatabaseInitializationDetector
org.springframework.boot.autoconfigure.data.jpa.EntityManagerFactoryDependsOnPostProcessor since 2.5.0 for removal in 2.7.0 in favor of EntityManagerFactoryDependsOnPostProcessor
org.springframework.boot.autoconfigure.hazelcast.HazelcastClientFactory since 2.4.3 for removal in 2.6 in favor of using the Hazelcast API directly
org.springframework.boot.autoconfigure.hazelcast.HazelcastInstanceFactory since 2.4.3 for removal in 2.6 in favor of using the Hazelcast API directly
org.springframework.boot.autoconfigure.hateoas.HypermediaHttpMessageConverterConfiguration since 2.5.0 for removal in 2.7.0 in favor of a HalConfiguration bean
org.springframework.boot.autoconfigure.jdbc.JdbcOperationsDependsOnPostProcessor since 2.5.0 for removal in 2.7.0 in favor of DependsOnDatabaseInitializationDetector
org.springframework.boot.autoconfigure.batch.JobLauncherCommandLineRunner since 2.3.0 for removal in 2.6.0 in favor of JobLauncherApplicationRunner
org.springframework.boot.autoconfigure.mustache.MustacheEnvironmentCollector since 2.5.0 for removal in 2.7.0 in favor of direct addition of values from the Environment to the model
org.springframework.boot.autoconfigure.jdbc.NamedParameterJdbcOperationsDependsOnPostProcessor since 2.5.0 for removal in 2.7.0 in favor of DependsOnDatabaseInitializationDetector
org.springframework.boot.autoconfigure.web.ResourceProperties since 2.4.0 for removal in 2.6.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.web.embedded.netty.SslServerCustomizer this class is meant for Spring Boot internal use only.

Deprecated Enums

Enum and Description
org.springframework.boot.actuate.endpoint.http.ApiVersion since 2.5.0 for removal in 2.7.0 in favor of ApiVersion
org.springframework.boot.autoconfigure.r2dbc.EmbeddedDatabaseConnection since 2.5.0 for removal in 2.7.0 in favor of EmbeddedDatabaseConnection
org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.LocaleResolver since 2.4.0 for removal in 2.6.0 in favor of WebProperties.LocaleResolver

Deprecated Exceptions

Exceptions and Description
org.springframework.boot.autoconfigure.flyway.FlywayMigrationScriptMissingException since 2.5.0 for removal in 2.7.0 as location checking is deprecated

Deprecated Fields

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

Deprecated Methods

Method and Description
org.springframework.boot.builder.SpringApplicationBuilder.addBootstrapper(Bootstrapper) since 2.4.5 for removal in 2.6 in favor of SpringApplicationBuilder.addBootstrapRegistryInitializer(BootstrapRegistryInitializer)
org.springframework.boot.SpringApplication.addBootstrapper(Bootstrapper) since 2.4.5 for removal in 2.6 in favor of SpringApplication.addBootstrapRegistryInitializer(BootstrapRegistryInitializer)
org.springframework.boot.test.context.assertj.ApplicationContextAssertProvider.assertThat() to prevent accidental use. Prefer standard AssertJ assertThat(context)... calls instead.
org.springframework.boot.test.json.JsonContent.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 for removal in 2.6.0 in favor of SpringApplicationBuilder.contextFactory(ApplicationContextFactory)
org.springframework.boot.loader.Launcher.createClassLoader(List<Archive>) since 2.3.0 for removal in 2.5.0 in favor of Launcher.createClassLoader(Iterator)
org.springframework.boot.SpringApplicationRunListener.environmentPrepared(ConfigurableEnvironment) since 2.4.0 for removal in 2.6.0 in favor of SpringApplicationRunListener.environmentPrepared(ConfigurableBootstrapContext, ConfigurableEnvironment)
org.springframework.boot.loader.archive.Archive.forEach(Consumer<? super Archive.Entry>) since 2.3.0 for removal in 2.5.0 in favor of using JarFile to access entries and Archive.getNestedArchives(EntryFilter, EntryFilter) for accessing nested archives.
org.springframework.boot.actuate.endpoint.http.ApiVersion.fromHttpHeaders(Map<String, List<String>>) since 2.5.0 for removal in 2.7.0 in favor of direct injection with resolution via the ProducibleOperationArgumentResolver.
org.springframework.boot.actuate.endpoint.InvocationContext.getApiVersion() since 2.5.0 for removal in 2.7.0 in favor of InvocationContext.resolveArgument(Class) using ApiVersion
org.springframework.boot.loader.Launcher.getClassPathArchives() since 2.3.0 for removal in 2.5.0 in favor of implementing Launcher.getClassPathArchivesIterator().
org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties.Servlet.getContextPath() since 2.4.0 for removal in 2.6.0 in favor of ManagementServerProperties.getBasePath()
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.getData()
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.getDataPassword()
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.getDataUsername()
org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.getDateFormat()
org.springframework.boot.autoconfigure.web.reactive.error.AbstractErrorWebExceptionHandler.getErrorAttributes(ServerRequest, boolean) since 2.3.0 for removal in 2.5.0 in favor of AbstractErrorWebExceptionHandler.getErrorAttributes(ServerRequest, ErrorAttributeOptions)
org.springframework.boot.autoconfigure.mongo.MongoProperties.getGridFsDatabase() since 2.4.0 for removal in 2.6.0 in favor of MongoProperties.Gridfs.getDatabase()
org.springframework.boot.autoconfigure.jms.artemis.ArtemisProperties.getHost() since 2.5.0 for removal in 2.7.0 in favor of broker url
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.getInitializationMode()
org.springframework.boot.autoconfigure.batch.BatchProperties.getInitializeSchema() since 2.5.0 for removal in 2.7.0 in favor of BatchProperties.Jdbc.getInitializeSchema()
org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.getLocale()
org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.getLocaleResolver()
org.springframework.boot.loader.archive.Archive.getNestedArchives(Archive.EntryFilter) since 2.3.0 for removal in 2.5.0 in favor of Archive.getNestedArchives(EntryFilter, EntryFilter)
org.springframework.boot.context.config.ConfigData.getOptions() since 2.4.5 in favor of ConfigData.getOptions(PropertySource)
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.getPlatform()
org.springframework.boot.autoconfigure.jms.artemis.ArtemisProperties.getPort() since 2.5.0 for removal in 2.7.0 in favor of broker url
org.springframework.boot.actuate.autoconfigure.metrics.export.ganglia.GangliaProperties.getProtocolVersion()
org.springframework.boot.actuate.autoconfigure.metrics.export.ganglia.GangliaProperties.getRateUnits()
org.springframework.boot.autoconfigure.batch.BatchProperties.getSchema() since 2.5.0 for removal in 2.7.0 in favor of BatchProperties.Jdbc.getSchema()
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.getSchema()
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.getSchemaPassword()
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.getSchemaUsername()
org.springframework.boot.actuate.endpoint.InvocationContext.getSecurityContext() since 2.5.0 for removal in 2.7.0 in favor of InvocationContext.resolveArgument(Class)
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.getSeparator()
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.getSqlScriptEncoding()
org.springframework.boot.autoconfigure.batch.BatchProperties.getTablePrefix() since 2.5.0 for removal in 2.7.0 in favor of BatchProperties.Jdbc.getTablePrefix()
org.springframework.boot.Bootstrapper.intitialize(BootstrapRegistry) since 2.4.4 for removal in 2.6 in favor of Bootstrapper.initialize(BootstrapRegistry)
org.springframework.boot.autoconfigure.flyway.FlywayProperties.isCheckLocation()
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.isContinueOnError()
org.springframework.boot.autoconfigure.flyway.FlywayProperties.isCreateDataSource() since 2.5.0 for removal in 2.7.0 in favor of directly checking user and url.
org.springframework.boot.web.embedded.undertow.UndertowServletWebServerFactory.isEagerInitFilters() since 2.4.0 for removal in 2.6.0 in favor of UndertowServletWebServerFactory.isEagerFilterInit()
org.springframework.boot.jdbc.EmbeddedDatabaseConnection.isEmbedded(String) since 2.4.0 for removal in 2.6.0 in favor of EmbeddedDatabaseConnection.isEmbedded(String, String)
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 for removal in 2.5.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.autoconfigure.jooq.JooqAutoConfiguration.DslContextConfiguration.jooqProvidersDefaultConfigurationCustomizer(ObjectProvider<TransactionProvider>, ObjectProvider<RecordMapperProvider>, ObjectProvider<RecordUnmapperProvider>, ObjectProvider<Settings>, ObjectProvider<RecordListenerProvider>, ObjectProvider<VisitListenerProvider>, ObjectProvider<TransactionListenerProvider>, ObjectProvider<ExecutorProvider>)
org.springframework.boot.cloud.CloudFoundryVcapEnvironmentPostProcessor.onApplicationEvent(ApplicationPreparedEvent) since 2.4.0 for removal in 2.6.0 in favor of only using EnvironmentPostProcessor callbacks
org.springframework.boot.actuate.metrics.web.reactive.server.WebFluxTags.outcome(ServerWebExchange) since 2.5.0 for removal in 2.7.0 in favor of WebFluxTags.outcome(ServerWebExchange, Throwable)
org.springframework.boot.buildpack.platform.build.BuildLog.pulledBuilder(BuildRequest, Image) since 2.4.0 for removal in 2.6.0 in favor of BuildLog.pulledImage(Image, ImageType)
org.springframework.boot.buildpack.platform.build.AbstractBuildLog.pulledBuilder(BuildRequest, Image)
org.springframework.boot.buildpack.platform.build.BuildLog.pulledRunImage(BuildRequest, Image) since 2.4.0 for removal in 2.6.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.pullingBuilder(BuildRequest, ImageReference) since 2.4.0 for removal in 2.6.0 in favor of BuildLog.pullingImage(ImageReference, ImageType)
org.springframework.boot.buildpack.platform.build.AbstractBuildLog.pullingBuilder(BuildRequest, ImageReference)
org.springframework.boot.buildpack.platform.build.BuildLog.pullingRunImage(BuildRequest, ImageReference) since 2.4.0 for removal in 2.6.0 in favor of BuildLog.pullingImage(ImageReference, ImageType)
org.springframework.boot.buildpack.platform.build.AbstractBuildLog.pullingRunImage(BuildRequest, ImageReference)
org.springframework.boot.SpringApplication.setApplicationContextClass(Class<? extends ConfigurableApplicationContext>) since 2.4.0 for removal in 2.6.0 in favor of SpringApplication.setApplicationContextFactory(ApplicationContextFactory)
org.springframework.boot.autoconfigure.flyway.FlywayProperties.setCheckLocation(boolean)
org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties.Servlet.setContextPath(String) since 2.4.0 for removal in 2.6.0 in favor of ManagementServerProperties.setBasePath(String)
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.setContinueOnError(boolean)
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.setData(List<String>)
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.setDataPassword(String)
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.setDataUsername(String)
org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.setDateFormat(String)
org.springframework.boot.web.embedded.undertow.UndertowServletWebServerFactory.setEagerInitFilters(boolean) since 2.4.0 for removal in 2.6.0 in favor of UndertowServletWebServerFactory.isEagerFilterInit()
org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.Contentnegotiation.setFavorPathExtension(boolean)
org.springframework.boot.autoconfigure.mongo.MongoProperties.setGridFsDatabase(String)
org.springframework.boot.autoconfigure.jms.artemis.ArtemisProperties.setHost(String)
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.setInitializationMode(DataSourceInitializationMode)
org.springframework.boot.autoconfigure.batch.BatchProperties.setInitializeSchema(DataSourceInitializationMode)
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.setPlatform(String)
org.springframework.boot.autoconfigure.jms.artemis.ArtemisProperties.setPort(int)
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.jdbc.DataSourceProperties.setSchema(List<String>)
org.springframework.boot.autoconfigure.batch.BatchProperties.setSchema(String)
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.setSchemaPassword(String)
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.setSchemaUsername(String)
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.setSeparator(String)
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.setSqlScriptEncoding(Charset)
org.springframework.boot.autoconfigure.batch.BatchProperties.setTablePrefix(String)
org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.Pathmatch.setUseRegisteredSuffixPattern(boolean)
org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.Pathmatch.setUseSuffixPattern(boolean)
org.springframework.boot.loader.archive.Archive.spliterator() since 2.3.0 for removal in 2.5.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 for removal in 2.6.0 in favor of SpringApplicationRunListener.starting(ConfigurableBootstrapContext)

Deprecated Constructors

Constructor and Description
org.springframework.boot.autoconfigure.web.reactive.error.AbstractErrorWebExceptionHandler(ErrorAttributes, ResourceProperties, ApplicationContext) since 2.4.0 for removal in 2.6.0 in favor of #AbstractErrorWebExceptionHandler(ErrorAttributes, Resources, ApplicationContext)
org.springframework.boot.context.event.ApplicationEnvironmentPreparedEvent(SpringApplication, String[], ConfigurableEnvironment) since 2.4.0 for removal in 2.6.0 in favor of ApplicationEnvironmentPreparedEvent(ConfigurableBootstrapContext, SpringApplication, String[], ConfigurableEnvironment)
org.springframework.boot.context.event.ApplicationStartingEvent(SpringApplication, String[]) since 2.4.0 for removal in 2.6.0 in favor of ApplicationStartingEvent(ConfigurableBootstrapContext, SpringApplication, String[])
org.springframework.boot.cloud.CloudFoundryVcapEnvironmentPostProcessor() since 2.4.0 for removal in 2.6.0 in favor of CloudFoundryVcapEnvironmentPostProcessor(Log)
org.springframework.boot.autoconfigure.web.servlet.error.DefaultErrorViewResolver(ApplicationContext, ResourceProperties) since 2.4.0 for removal in 2.6.0 in favor of #DefaultErrorViewResolver(ApplicationContext, Resources)
org.springframework.boot.autoconfigure.web.reactive.error.DefaultErrorWebExceptionHandler(ErrorAttributes, ResourceProperties, ErrorProperties, ApplicationContext) since 2.4.0 for removal in 2.6.0 in favor of #DefaultErrorWebExceptionHandler(ErrorAttributes, Resources, ErrorProperties, ApplicationContext)
org.springframework.boot.actuate.endpoint.InvocationContext(ApiVersion, SecurityContext, Map<String, Object>) since 2.5.0 for removal in 2.7.0 in favor of InvocationContext(SecurityContext, Map, OperationArgumentResolver[])
org.springframework.boot.loader.tools.Packager(File, LayoutFactory) since 2.3.10 for removal in 2.5 in favor of Packager(File) and Packager.setLayoutFactory(LayoutFactory)
org.springframework.boot.test.util.TestPropertyValues.Pair(String, String) since 2.4.0 for removal in 2.6.0 in favor of TestPropertyValues.Pair.of(String, String)
org.springframework.boot.loader.tools.Repackager(File, LayoutFactory) since 2.3.10 for removal in 2.5 in favor of Repackager(File) and Packager.setLayoutFactory(LayoutFactory)

Deprecated Enum Constants

Enum Constant and Description
org.springframework.boot.jdbc.EmbeddedDatabaseConnection.HSQL since 2.4.0 for removal in 2.6.0 in favor of EmbeddedDatabaseConnection.HSQLDB.