---- url: https://docs.spring.io/spring-boot/maven-plugin/aot.html ---- # Ahead-of-Time Processing Spring AOT is a process that analyzes your application at build-time and generate an optimized version of it. It is a mandatory step to run a Spring `ApplicationContext` in a native image. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | For an overview of GraalVM Native Images support in Spring Boot, check the [reference documentation](../reference/packaging/native-image/index.html). | The Spring Boot Maven plugin offers goals that can be used to perform AOT processing on both application and test code. ## [](#aot.processing-applications)Processing Applications To configure your application to use this feature, add an execution for the `process-aot` goal, as shown in the following example: ```xml org.springframework.boot spring-boot-maven-plugin process-aot process-aot ``` As the `BeanFactory` is fully prepared at build-time, conditions are also evaluated. This has an important difference compared to what a regular Spring Boot application does at runtime. For instance, if you want to opt-in or opt-out for certain features, you need to configure the environment used at build time to do so. The `process-aot` goal shares a number of properties with the [run goal](run.html) for that reason. ### [](#aot.processing-applications.using-the-native-profile)Using the Native Profile If you use `spring-boot-starter-parent` as the `parent` of your project, a `native` profile can be used to streamline the steps required to build a native image. The `native` profile configures the following: * Execution of `process-aot` when the Spring Boot Maven Plugin is applied on a project. * Suitable settings so that [build-image](build-image.html) generates a native image. * Sensible defaults for the [Native Build Tools Maven Plugin](https://graalvm.github.io/native-build-tools/1.1.8/maven-plugin.html), in particular: * Making sure the plugin uses the raw classpath, and not the main jar file as it does not understand our repackaged jar format. * Validate that a suitable GraalVM version is available. * Download third-party reachability metadata. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | The use of the raw classpath means that native image does not know about the generated `MANIFEST.MF`. If you need to read the content of the manifest in a native image, for instance to get the implementation version of your application, configure the `classesDirectory` option to use the regular jar. | To benefit from the `native` profile, a module that represents an application should define two plugins, as shown in the following example: ```xml org.graalvm.buildtools native-maven-plugin org.springframework.boot spring-boot-maven-plugin ``` A single project can trigger the generation of a native image on the command-line using either [Cloud Native Buildpacks](../how-to/native-image/developing-your-first-application.html#howto.native-image.developing-your-first-application.buildpacks.maven) or [Native Image Build Tools](../how-to/native-image/developing-your-first-application.html#howto.native-image.developing-your-first-application.native-build-tools.maven). To use the `native` profile with a multi-modules project, you can create a customization of the `native` profile so that it invokes your preferred technique. To bind Cloud Native Buildpacks during the `package` phase, add the following to the root POM of your multi-modules project: ```xml native org.springframework.boot spring-boot-maven-plugin build-image build-image-no-fork ``` The example below does the same for Native Build Tools: ```xml native org.graalvm.buildtools native-maven-plugin build-image compile-no-fork ``` Once the above is in place, you can build your multi-modules project and generate a native image in the relevant sub-modules, as shown in the following example: ```shell $ mvn package -Pnative ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | A "relevant" sub-module is a module that represents a Spring Boot application. Such module must define the Native Build Tools and Spring Boot plugins as described above. | ## [](#aot.process-aot-goal)`spring-boot:process-aot` `org.springframework.boot:spring-boot-maven-plugin:4.1.1` Invoke the AOT engine on the application. ### [](#aot.process-aot-goal.required-parameters)Required parameters | Name | Type | Default | | --------------------------------------------------------------------------------- | ------ | ------------------------------------------------------ | | [classesDirectory](#aot.process-aot-goal.parameter-details.classes-directory) | `File` | `${project.build.outputDirectory}` | | [generatedClasses](#aot.process-aot-goal.parameter-details.generated-classes) | `File` | `${project.build.directory}/spring-aot/main/classes` | | [generatedResources](#aot.process-aot-goal.parameter-details.generated-resources) | `File` | `${project.build.directory}/spring-aot/main/resources` | | [generatedSources](#aot.process-aot-goal.parameter-details.generated-sources) | `File` | `${project.build.directory}/spring-aot/main/sources` | ### [](#aot.process-aot-goal.optional-parameters)Optional parameters | Name | Type | Default | | -------------------------------------------------------------------------------------------- | ---------- | ------- | | [arguments](#aot.process-aot-goal.parameter-details.arguments) | `String[]` | | | [compilerArguments](#aot.process-aot-goal.parameter-details.compiler-arguments) | `String` | | | [excludeGroupIds](#aot.process-aot-goal.parameter-details.exclude-group-ids) | `String` | | | [excludes](#aot.process-aot-goal.parameter-details.excludes) | `List` | | | [includes](#aot.process-aot-goal.parameter-details.includes) | `List` | | | [jvmArguments](#aot.process-aot-goal.parameter-details.jvm-arguments) | `String` | | | [mainClass](#aot.process-aot-goal.parameter-details.main-class) | `String` | | | [profiles](#aot.process-aot-goal.parameter-details.profiles) | `String[]` | | | [skip](#aot.process-aot-goal.parameter-details.skip) | `boolean` | `false` | | [systemPropertyVariables](#aot.process-aot-goal.parameter-details.system-property-variables) | `Map` | | ### [](#aot.process-aot-goal.parameter-details)Parameter details #### [](#aot.process-aot-goal.parameter-details.arguments)`arguments` Application arguments that should be taken into account for AOT processing. | Name | `arguments` | | ------------- | -------------------- | | Type | `java.lang.String[]` | | Default value | | | User property | | | Since | | #### [](#aot.process-aot-goal.parameter-details.classes-directory)`classesDirectory` Directory containing the classes and resource files that should be packaged into the archive. | Name | `classesDirectory` | | ------------- | ---------------------------------- | | Type | `java.io.File` | | Default value | `${project.build.outputDirectory}` | | User property | | | Since | | #### [](#aot.process-aot-goal.parameter-details.compiler-arguments)`compilerArguments` Arguments that should be provided to the AOT compile process. On command line, make sure to wrap multiple values between quotes. | Name | `compilerArguments` | | ------------- | ----------------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.aot.compilerArguments` | | Since | | #### [](#aot.process-aot-goal.parameter-details.exclude-group-ids)`excludeGroupIds` Comma separated list of groupId names to exclude (exact match). | Name | `excludeGroupIds` | | ------------- | ----------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.excludeGroupIds` | | Since | `1.1.0` | #### [](#aot.process-aot-goal.parameter-details.excludes)`excludes` Collection of artifact definitions to exclude. The `Exclude` element defines mandatory `groupId` and `artifactId` components and an optional `classifier` component. When configured as a property, values should be comma-separated with colon-separated components: `groupId:artifactId,groupId:artifactId:classifier` | Name | `excludes` | | ------------- | ---------------------- | | Type | `java.util.List` | | Default value | | | User property | `spring-boot.excludes` | | Since | `1.1.0` | #### [](#aot.process-aot-goal.parameter-details.generated-classes)`generatedClasses` Directory containing the generated classes. | Name | `generatedClasses` | | ------------- | ---------------------------------------------------- | | Type | `java.io.File` | | Default value | `${project.build.directory}/spring-aot/main/classes` | | User property | | | Since | | #### [](#aot.process-aot-goal.parameter-details.generated-resources)`generatedResources` Directory containing the generated resources. | Name | `generatedResources` | | ------------- | ------------------------------------------------------ | | Type | `java.io.File` | | Default value | `${project.build.directory}/spring-aot/main/resources` | | User property | | | Since | | #### [](#aot.process-aot-goal.parameter-details.generated-sources)`generatedSources` Directory containing the generated sources. | Name | `generatedSources` | | ------------- | ---------------------------------------------------- | | Type | `java.io.File` | | Default value | `${project.build.directory}/spring-aot/main/sources` | | User property | | | Since | | #### [](#aot.process-aot-goal.parameter-details.includes)`includes` Collection of artifact definitions to include. The `Include` element defines mandatory `groupId` and `artifactId` components and an optional `classifier` component. When configured as a property, values should be comma-separated with colon-separated components: `groupId:artifactId,groupId:artifactId:classifier` | Name | `includes` | | ------------- | ---------------------- | | Type | `java.util.List` | | Default value | | | User property | `spring-boot.includes` | | Since | `1.2.0` | #### [](#aot.process-aot-goal.parameter-details.jvm-arguments)`jvmArguments` JVM arguments that should be associated with the AOT process. On command line, make sure to wrap multiple values between quotes. | Name | `jvmArguments` | | ------------- | ------------------------------ | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.aot.jvmArguments` | | Since | | #### [](#aot.process-aot-goal.parameter-details.main-class)`mainClass` Name of the main class to use as the source for the AOT process. If not specified the first compiled class found that contains a 'main' method will be used. | Name | `mainClass` | | ------------- | ---------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.aot.main-class` | | Since | | #### [](#aot.process-aot-goal.parameter-details.profiles)`profiles` Spring profiles to take into account for AOT processing. | Name | `profiles` | | ------------- | -------------------- | | Type | `java.lang.String[]` | | Default value | | | User property | | | Since | | #### [](#aot.process-aot-goal.parameter-details.skip)`skip` Skip the execution. | Name | `skip` | | ------------- | ---------------------- | | Type | `boolean` | | Default value | `false` | | User property | `spring-boot.aot.skip` | | Since | | #### [](#aot.process-aot-goal.parameter-details.system-property-variables)`systemPropertyVariables` List of JVM system properties to pass to the AOT process. | Name | `systemPropertyVariables` | | ------------- | ------------------------- | | Type | `java.util.Map` | | Default value | | | User property | | | Since | | ## [](#aot.processing-tests)Processing Tests The AOT engine can be applied to JUnit 5 tests that use Spring’s Test Context Framework. Those tests are processed by the AOT engine and are then executed in a native image. | | | | -- | ------------------------------------------------------------------------------------------------ | | ** | Tests are not processed when the regular tests are skipped using the `maven.test.skip` property. | Just like [for production code](#aot.processing-applications.using-the-native-profile), the `spring-boot-starter-parent` defines a `nativeTest` profile that can be used to streamline the steps required to execute your tests in a native image. The `nativeTest` profile configures the following: * Execution of `process-test-aot` when the Spring Boot Maven Plugin is applied on a project. * Execution of `test` when the [Native Build Tools Maven Plugin](https://graalvm.github.io/native-build-tools/1.1.8/maven-plugin.html) is applied on a project. The execution defines sensible defaults, in particular: * Making sure the plugin uses the raw classpath, and not the main jar file as it does not understand our repackaged jar format. * Validate that a suitable GraalVM version is available. * Download third-party reachability metadata. To benefit from the `nativeTest` profile, a module that represents an application should define two plugins, as shown in the following example: ```xml org.graalvm.buildtools native-maven-plugin org.springframework.boot spring-boot-maven-plugin ``` Once the above is in place for each module that needs this feature, you can build your multi-modules project and execute your tests in a native image in the relevant sub-modules, as shown in the following example: ```shell $ mvn test -PnativeTest ``` | | | | -- | -------------------------------------------------------------------------------------- | | ** | As with application AOT processing, the `BeanFactory` is fully prepared at build-time. | ## [](#aot.process-test-aot-goal)`spring-boot:process-test-aot` `org.springframework.boot:spring-boot-maven-plugin:4.1.1` Invoke the AOT engine on tests. ### [](#aot.process-test-aot-goal.required-parameters)Required parameters | Name | Type | Default | | ------------------------------------------------------------------------------------------- | ------ | ------------------------------------------------------ | | [classesDirectory](#aot.process-test-aot-goal.parameter-details.classes-directory) | `File` | `${project.build.outputDirectory}` | | [generatedClasses](#aot.process-test-aot-goal.parameter-details.generated-classes) | `File` | `${project.build.directory}/spring-aot/main/classes` | | [generatedResources](#aot.process-test-aot-goal.parameter-details.generated-resources) | `File` | `${project.build.directory}/spring-aot/test/resources` | | [generatedSources](#aot.process-test-aot-goal.parameter-details.generated-sources) | `File` | `${project.build.directory}/spring-aot/test/sources` | | [generatedTestClasses](#aot.process-test-aot-goal.parameter-details.generated-test-classes) | `File` | `${project.build.directory}/spring-aot/test/classes` | | [testClassesDirectory](#aot.process-test-aot-goal.parameter-details.test-classes-directory) | `File` | `${project.build.testOutputDirectory}` | ### [](#aot.process-test-aot-goal.optional-parameters)Optional parameters | Name | Type | Default | | ------------------------------------------------------------------------------------------------- | --------- | ------- | | [compilerArguments](#aot.process-test-aot-goal.parameter-details.compiler-arguments) | `String` | | | [excludeGroupIds](#aot.process-test-aot-goal.parameter-details.exclude-group-ids) | `String` | | | [excludes](#aot.process-test-aot-goal.parameter-details.excludes) | `List` | | | [includes](#aot.process-test-aot-goal.parameter-details.includes) | `List` | | | [jvmArguments](#aot.process-test-aot-goal.parameter-details.jvm-arguments) | `String` | | | [skip](#aot.process-test-aot-goal.parameter-details.skip) | `boolean` | `false` | | [systemPropertyVariables](#aot.process-test-aot-goal.parameter-details.system-property-variables) | `Map` | | ### [](#aot.process-test-aot-goal.parameter-details)Parameter details #### [](#aot.process-test-aot-goal.parameter-details.classes-directory)`classesDirectory` Directory containing the classes and resource files that should be used to run the tests. | Name | `classesDirectory` | | ------------- | ---------------------------------- | | Type | `java.io.File` | | Default value | `${project.build.outputDirectory}` | | User property | | | Since | | #### [](#aot.process-test-aot-goal.parameter-details.compiler-arguments)`compilerArguments` Arguments that should be provided to the AOT compile process. On command line, make sure to wrap multiple values between quotes. | Name | `compilerArguments` | | ------------- | ----------------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.aot.compilerArguments` | | Since | | #### [](#aot.process-test-aot-goal.parameter-details.exclude-group-ids)`excludeGroupIds` Comma separated list of groupId names to exclude (exact match). | Name | `excludeGroupIds` | | ------------- | ----------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.excludeGroupIds` | | Since | `1.1.0` | #### [](#aot.process-test-aot-goal.parameter-details.excludes)`excludes` Collection of artifact definitions to exclude. The `Exclude` element defines mandatory `groupId` and `artifactId` components and an optional `classifier` component. When configured as a property, values should be comma-separated with colon-separated components: `groupId:artifactId,groupId:artifactId:classifier` | Name | `excludes` | | ------------- | ---------------------- | | Type | `java.util.List` | | Default value | | | User property | `spring-boot.excludes` | | Since | `1.1.0` | #### [](#aot.process-test-aot-goal.parameter-details.generated-classes)`generatedClasses` Directory containing the generated test classes. | Name | `generatedClasses` | | ------------- | ---------------------------------------------------- | | Type | `java.io.File` | | Default value | `${project.build.directory}/spring-aot/main/classes` | | User property | | | Since | | #### [](#aot.process-test-aot-goal.parameter-details.generated-resources)`generatedResources` Directory containing the generated test resources. | Name | `generatedResources` | | ------------- | ------------------------------------------------------ | | Type | `java.io.File` | | Default value | `${project.build.directory}/spring-aot/test/resources` | | User property | | | Since | | #### [](#aot.process-test-aot-goal.parameter-details.generated-sources)`generatedSources` Directory containing the generated sources. | Name | `generatedSources` | | ------------- | ---------------------------------------------------- | | Type | `java.io.File` | | Default value | `${project.build.directory}/spring-aot/test/sources` | | User property | | | Since | | #### [](#aot.process-test-aot-goal.parameter-details.generated-test-classes)`generatedTestClasses` Directory containing the generated test classes. | Name | `generatedTestClasses` | | ------------- | ---------------------------------------------------- | | Type | `java.io.File` | | Default value | `${project.build.directory}/spring-aot/test/classes` | | User property | | | Since | | #### [](#aot.process-test-aot-goal.parameter-details.includes)`includes` Collection of artifact definitions to include. The `Include` element defines mandatory `groupId` and `artifactId` components and an optional `classifier` component. When configured as a property, values should be comma-separated with colon-separated components: `groupId:artifactId,groupId:artifactId:classifier` | Name | `includes` | | ------------- | ---------------------- | | Type | `java.util.List` | | Default value | | | User property | `spring-boot.includes` | | Since | `1.2.0` | #### [](#aot.process-test-aot-goal.parameter-details.jvm-arguments)`jvmArguments` JVM arguments that should be associated with the AOT process. On command line, make sure to wrap multiple values between quotes. | Name | `jvmArguments` | | ------------- | ------------------------------ | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.aot.jvmArguments` | | Since | | #### [](#aot.process-test-aot-goal.parameter-details.skip)`skip` Skip the execution. | Name | `skip` | | ------------- | ---------------------- | | Type | `boolean` | | Default value | `false` | | User property | `spring-boot.aot.skip` | | Since | | #### [](#aot.process-test-aot-goal.parameter-details.system-property-variables)`systemPropertyVariables` List of JVM system properties to pass to the AOT process. | Name | `systemPropertyVariables` | | ------------- | ------------------------- | | Type | `java.util.Map` | | Default value | | | User property | | | Since | | #### [](#aot.process-test-aot-goal.parameter-details.test-classes-directory)`testClassesDirectory` Directory containing the classes and resource files that should be packaged into the archive. | Name | `testClassesDirectory` | | ------------- | -------------------------------------- | | Type | `java.io.File` | | Default value | `${project.build.testOutputDirectory}` | | User property | | | Since | | * [Spring Boot](../index.html) * [4.1.1](aot.html) * [4.0.8](../4.0/maven-plugin/aot.html) * [3.5.16](../3.5/maven-plugin/aot.html) * [3.4.13](../3.4/maven-plugin/aot.html) * [3.3.13](../3.3/maven-plugin/aot.html) - [4.2.0-M2](../4.2/maven-plugin/aot.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/maven-plugin/aot.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/maven-plugin/aot.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/maven-plugin/aot.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/index.html ---- # Maven Plugin The Spring Boot Maven Plugin provides Spring Boot support in [Apache Maven](https://maven.org). It allows you to package executable jar or war archives, run Spring Boot applications, generate build information and start your Spring Boot application prior to running integration tests. To use it, you must use Maven 3.6.3 or later. In addition to this user guide, [API documentation](api/java/index.html) is also available. * [Spring Boot](../index.html) * [4.1.1](index.html) * [4.0.8](../4.0/maven-plugin/index.html) * [3.5.16](../3.5/maven-plugin/index.html) * [3.4.13](../3.4/maven-plugin/index.html) * [3.3.13](../3.3/maven-plugin/index.html) - [4.2.0-M2](../4.2/maven-plugin/index.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/maven-plugin/index.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/maven-plugin/index.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/maven-plugin/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayerSpec.html ---- # Class LayeredSpec.IntoLayerSpec [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.gradle.tasks.bundling.LayeredSpec.IntoLayerSpec * All Implemented Interfaces: `Serializable` - Direct Known Subclasses: `LayeredSpec.DependenciesIntoLayerSpec` * Enclosing class: `LayeredSpec` *** public static class LayeredSpec.IntoLayerSpec extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") implements [Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io") Spec that controls the content that should be part of a particular layer. * Since: 2.3.0 * Author: Madhura Bhave, Scott Frederick, Phillip Webb * See Also: * [Serialized Form](../../../../../../serialized-form.html#org.springframework.boot.gradle.tasks.bundling.LayeredSpec.IntoLayerSpec) - ## Constructor Summary Constructors Constructor Description `IntoLayerSpec(String intoLayer)` Creates a new `IntoLayerSpec` that will control the content of the given layer. - ## Method Summary Modifier and Type Method Description `void` `exclude(String... patterns)` Adds patterns that control the content that is excluded from the layer. `void` `include(String... patterns)` Adds patterns that control the content that is included in the layer. ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### IntoLayerSpec public IntoLayerSpec​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") intoLayer) Creates a new `IntoLayerSpec` that will control the content of the given layer. * Parameters: `intoLayer` - the layer * ## Method Details * ### include public void include​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")... patterns) Adds patterns that control the content that is included in the layer. If no includes are specified then all content is included. If includes are specified then content must match an inclusion and not match any exclusions to be included. * Parameters: `patterns` - the patterns to be included * ### exclude public void exclude​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")... patterns) Adds patterns that control the content that is excluded from the layer. If no excludes a specified no content is excluded. If exclusions are specified then any content that matches an exclusion will be excluded irrespective of whether it matches an include. * Parameters: `patterns` - the patterns to be excluded ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/index-files/index-10.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ## O * [org.springframework.boot.gradle.dsl](../org/springframework/boot/gradle/dsl/package-summary.html) - package org.springframework.boot.gradle.dsl Spring Boot Gradle DSL. * [org.springframework.boot.gradle.plugin](../org/springframework/boot/gradle/plugin/package-summary.html) - package org.springframework.boot.gradle.plugin Central classes for the Spring Boot Gradle plugin. * [org.springframework.boot.gradle.tasks.aot](../org/springframework/boot/gradle/tasks/aot/package-summary.html) - package org.springframework.boot.gradle.tasks.aot Support for ahead-of-time processing of an application built with Gradle. * [org.springframework.boot.gradle.tasks.buildinfo](../org/springframework/boot/gradle/tasks/buildinfo/package-summary.html) - package org.springframework.boot.gradle.tasks.buildinfo Support for producing build info for consumption by Spring Boot's actuator. * [org.springframework.boot.gradle.tasks.bundling](../org/springframework/boot/gradle/tasks/bundling/package-summary.html) - package org.springframework.boot.gradle.tasks.bundling Support for creating executable jars and wars. * [org.springframework.boot.gradle.tasks.run](../org/springframework/boot/gradle/tasks/run/package-summary.html) - package org.springframework.boot.gradle.tasks.run Support for running Spring Boot applications. * [org.springframework.boot.gradle.util](../org/springframework/boot/gradle/util/package-summary.html) - package org.springframework.boot.gradle.util Shared utility classes. [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/TestRunMojo.html ---- # Class TestRunMojo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.plugin.AbstractMojo [org.springframework.boot.maven.AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") [org.springframework.boot.maven.AbstractRunMojo](AbstractRunMojo.html "class in org.springframework.boot.maven") org.springframework.boot.maven.TestRunMojo * All Implemented Interfaces: `org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo` *** @Mojo(name="test-run", requiresProject=true, defaultPhase=VALIDATE, requiresDependencyResolution=TEST) @Execute(phase=TEST\_COMPILE) public class TestRunMojo extends [AbstractRunMojo](AbstractRunMojo.html "class in org.springframework.boot.maven") Run an application in place using the test runtime classpath. The main class that will be used to launch the application is determined as follows: The configured main class, if any. Then the main class found in the test classes directory, if any. Then the main class found in the classes directory, if any. * Since: 3.1.0 `TestRunMojo(org.apache.maven.toolchain.ToolchainManager toolchainManager)`   - ## Method Summary Modifier and Type Method Description `protected List` `getClassesDirectories()` Returns the directories that contain the application's classes and resources. `execute, getClassPathUrls, resolveApplicationArguments, resolveEnvVariables` * ### TestRunMojo @Inject public TestRunMojo​(org.apache.maven.toolchain.ToolchainManager toolchainManager) * ## Method Details * ### getClassesDirectories protected [List](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html "class or interface in java.util")<[File](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html "class or interface in java.io")> getClassesDirectories() Description copied from class: `AbstractRunMojo` Returns the directories that contain the application's classes and resources. When the application's main class has not been configured, each directory is searched in turn for an appropriate main class. * Overrides: `getClassesDirectories` in class `AbstractRunMojo` * Returns: the directories that contain the application's classes and resources * ### isUseTestClasspath protected boolean isUseTestClasspath() * Specified by: `isUseTestClasspath` in class `AbstractRunMojo` * ### resolveJvmArguments protected org.springframework.boot.maven.RunArguments resolveJvmArguments() Description copied from class: `AbstractRunMojo` Resolve the JVM arguments to use. * Overrides: `resolveJvmArguments` in class `AbstractRunMojo` * Returns: a `RunArguments` defining the JVM arguments * ### run protected void run​(org.springframework.boot.maven.JavaProcessExecutor processExecutor, [File](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html "class or interface in java.io") workingDirectory, [List](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html "class or interface in java.util")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> args, [Map](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html "class or interface in java.util")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang"),​[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> environmentVariables) throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException Description copied from class: `AbstractRunMojo` Run the application. * Specified by: `run` in class `AbstractRunMojo` * Parameters: * `processExecutor` - the `JavaProcessExecutor` to use * `workingDirectory` - the working directory of the forked JVM * `args` - the arguments (JVM arguments and application arguments) * `environmentVariables` - the environment variables * Throws: * `org.apache.maven.plugin.MojoExecutionException` - in case of MOJO execution errors * `org.apache.maven.plugin.MojoFailureException` - in case of MOJO failures ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/CacheInfo.html ---- # Class CacheInfo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.maven.CacheInfo *** public class CacheInfo extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") Encapsulates configuration of an image building cache. `CacheInfo.BindCacheInfo` Encapsulates configuration of an image building cache stored in a bind mount. `static class ` `CacheInfo.VolumeCacheInfo` Encapsulates configuration of an image building cache stored in a volume. - ## Constructor Summary Constructors Constructor Description `CacheInfo()`   - ## Method Summary Modifier and Type Method Description `void` `setBind(CacheInfo.BindCacheInfo info)`   `void` `setVolume(CacheInfo.VolumeCacheInfo info)`   ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### CacheInfo public CacheInfo() * ## Method Details * ### setVolume public void setVolume​([CacheInfo.VolumeCacheInfo](CacheInfo.VolumeCacheInfo.html "class in org.springframework.boot.maven") info) * ### setBind public void setBind​([CacheInfo.BindCacheInfo](CacheInfo.BindCacheInfo.html "class in org.springframework.boot.maven") info) ---- url: https://docs.spring.io/spring-boot/how-to/index.html ---- # How-to Guides This section provides answers to some common ‘how do I do that…​’ questions that often arise when using Spring Boot. Its coverage is not exhaustive, but it does cover quite a lot. If you have a specific problem that we do not cover here, you might want to check [stackoverflow.com](https://stackoverflow.com/tags/spring-boot) to see if someone has already provided an answer. This is also a great place to ask new questions (please use the `spring-boot` tag). We are also more than happy to extend this section. If you want to add a ‘how-to’, send us a [pull request](https://github.com/spring-projects/spring-boot). * [Spring Boot](../index.html) * [4.1.1](index.html) * [4.0.8](../4.0/how-to/index.html) * [3.5.16](../3.5/how-to/index.html) * [3.4.13](../3.4/how-to/index.html) * [3.3.13](../3.3/how-to/index.html) - [4.2.0-M2](../4.2/how-to/index.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/index.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/index.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/how-to/build.html ---- # Build Spring Boot includes build plugins for Maven and Gradle. This section answers common questions about these plugins. ## [](#howto.build.generate-info)Generate Build Information Both the Maven plugin and the Gradle plugin allow generating build information containing the coordinates, name, and version of the project. The plugins can also be configured to add additional properties through configuration. When such a file is present, Spring Boot auto-configures a [`BuildProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/info/BuildProperties.html) bean. To generate build information with Maven, add an execution for the `build-info` goal, as shown in the following example: ```xml org.springframework.boot spring-boot-maven-plugin 4.1.1 build-info ``` | | | | -- | --------------------------------------------------------------------------------------------------- | | ** | See the [Spring Boot Maven Plugin documentation](../maven-plugin/build-info.html) for more details. | The following example does the same with Gradle: ```gradle springBoot { buildInfo() } ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------- | | ** | See the [Spring Boot Gradle Plugin documentation](../gradle-plugin/integrating-with-actuator.html) for more details. | ## [](#howto.build.generate-git-info)Generate Git Information Both Maven and Gradle allow generating a `git.properties` file containing information about the state of your `git` source code repository when the project was built. For Maven users, the `spring-boot-starter-parent` POM includes a pre-configured plugin to generate a `git.properties` file. To use it, add the following declaration for the [`Git Commit Id Plugin`](https://github.com/git-commit-id/git-commit-id-maven-plugin) to your POM: ```xml io.github.git-commit-id git-commit-id-maven-plugin ``` Gradle users can achieve the same result by using the [`gradle-git-properties`](https://plugins.gradle.org/plugin/com.gorylenko.gradle-git-properties) plugin, as shown in the following example: ```gradle plugins { id "com.gorylenko.gradle-git-properties" version "2.4.1" } ``` Both the Maven and Gradle plugins allow the properties that are included in `git.properties` to be configured. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The commit time in `git.properties` is expected to match the following format: `yyyy-MM-dd’T’HH:mm:ssZ`. This is the default format for both plugins listed above. Using this format lets the time be parsed into a [`Date`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Date.html) and its format, when serialized to JSON, to be controlled by Jackson’s date serialization configuration settings. | ## [](#howto.build.generate-cyclonedx-sbom)Generate a CycloneDX SBOM Both Maven and Gradle allow generating a CycloneDX SBOM at project build time. For Maven users, the `spring-boot-starter-parent` POM includes a pre-configured plugin to generate the SBOM. To use it, add the following declaration for the [`cyclonedx-maven-plugin`](https://github.com/CycloneDX/cyclonedx-maven-plugin) to your POM: ```xml org.cyclonedx cyclonedx-maven-plugin ``` Gradle users can achieve the same result by using the [`cyclonedx-gradle-plugin`](https://github.com/CycloneDX/cyclonedx-gradle-plugin) plugin, as shown in the following example: ```gradle plugins { id 'org.cyclonedx.bom' version '3.0.0' } ``` ## [](#howto.build.customize-dependency-versions)Customize Dependency Versions The `spring-boot-dependencies` POM manages the versions of common dependencies. The Spring Boot plugins for Maven and Gradle allow these managed dependency versions to be customized using build properties. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Each Spring Boot release is designed and tested against this specific set of third-party dependencies. Overriding versions may cause compatibility issues. | To override dependency versions with Maven, see [Using the Plugin](../maven-plugin/using.html) in the Maven plugin’s documentation. To override dependency versions in Gradle, see [Customizing Managed Versions](../gradle-plugin/managing-dependencies.html#managing-dependencies.dependency-management-plugin.customizing) in the Gradle plugin’s documentation. ## [](#howto.build.create-an-executable-jar-with-maven)Create an Executable JAR with Maven The `spring-boot-maven-plugin` can be used to create an executable “fat” JAR. If you use the `spring-boot-starter-parent` POM, you can declare the plugin and your jars are repackaged as follows: ```xml org.springframework.boot spring-boot-maven-plugin ``` If you do not use the parent POM, you can still use the plugin. However, you must additionally add an `` section, as follows: ```xml org.springframework.boot spring-boot-maven-plugin 4.1.1 repackage ``` See the [plugin documentation](../maven-plugin/packaging.html#packaging.repackage-goal) for full usage details. ## [](#howto.build.use-a-spring-boot-application-as-dependency)Use a Spring Boot Application as a Dependency Like a war file, a Spring Boot application is not intended to be used as a dependency. If your application contains classes that you want to share with other projects, the recommended approach is to move that code into a separate module. The separate module can then be depended upon by your application and other projects. If you cannot rearrange your code as recommended above, Spring Boot’s Maven and Gradle plugins must be configured to produce a separate artifact that is suitable for use as a dependency. The executable archive cannot be used as a dependency as the [executable jar format](../specification/executable-jar/nested-jars.html#appendix.executable-jar.nested-jars.jar-structure) packages application classes in `BOOT-INF/classes`. This means that they cannot be found when the executable jar is used as a dependency. To produce the two artifacts, one that can be used as a dependency and one that is executable, a classifier must be specified. This classifier is applied to the name of the executable archive, leaving the default archive for use as a dependency. To configure a classifier of `exec` in Maven, you can use the following configuration: ```xml org.springframework.boot spring-boot-maven-plugin exec ``` ## [](#howto.build.extract-specific-libraries-when-an-executable-jar-runs)Extract Specific Libraries When an Executable Jar Runs Most nested libraries in an executable jar do not need to be unpacked in order to run. However, certain libraries can have problems. For example, JRuby includes its own nested jar support, which assumes that the `jruby-complete.jar` is always directly available as a file in its own right. To deal with any problematic libraries, you can flag that specific nested jars should be automatically unpacked when the executable jar first runs. Such nested jars are written beneath the temporary directory identified by the `java.io.tmpdir` system property. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Care should be taken to ensure that your operating system is configured so that it will not delete the jars that have been unpacked to the temporary directory while the application is still running. | For example, to indicate that JRuby should be flagged for unpacking by using the Maven Plugin, you would add the following configuration: ```xml org.springframework.boot spring-boot-maven-plugin org.jruby jruby-complete ``` ## [](#howto.build.create-a-nonexecutable-jar)Create a Non-executable JAR with Exclusions Often, if you have an executable and a non-executable jar as two separate build products, the executable version has additional configuration files that are not needed in a library jar. For example, the `application.yaml` configuration file might be excluded from the non-executable JAR. In Maven, the executable jar must be the main artifact and you can add a classified jar for the library, as follows: ```xml org.springframework.boot spring-boot-maven-plugin maven-jar-plugin lib package jar lib application.yaml ``` ## [](#howto.build.remote-debug-maven)Remote Debug a Spring Boot Application Started with Maven To attach a remote debugger to a Spring Boot application that was started with Maven, you can use the `jvmArguments` property of the [maven plugin](../maven-plugin/index.html). See [this example](../maven-plugin/run.html#run.examples.debug) for more details. ## [](#howto.build.build-an-executable-archive-with-ant-without-using-spring-boot-antlib)Build an Executable Archive From Ant without Using spring-boot-antlib To build with Ant, you need to grab dependencies, compile, and then create a jar or war archive. To make it executable, you can either use the `spring-boot-antlib` module or you can follow these instructions: 1. If you are building a jar, package the application’s classes and resources in a nested `BOOT-INF/classes` directory. If you are building a war, package the application’s classes in a nested `WEB-INF/classes` directory as usual. 2. Add the runtime dependencies in a nested `BOOT-INF/lib` directory for a jar or `WEB-INF/lib` for a war. Remember **not** to compress the entries in the archive. 3. Add the `provided` (embedded container) dependencies in a nested `BOOT-INF/lib` directory for a jar or `WEB-INF/lib-provided` for a war. Remember **not** to compress the entries in the archive. 4. Add the `spring-boot-loader` classes at the root of the archive (so that the `Main-Class` is available). 5. Use the appropriate launcher (such as [`JarLauncher`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/loader/launch/JarLauncher.html) for a jar file) as a `Main-Class` attribute in the manifest and specify the other properties it needs as manifest entries — principally, by setting a `Start-Class` property. The following example shows how to build an executable archive with Ant: ```xml ``` * [Spring Boot](../index.html) * [4.1.1](build.html) * [4.0.8](../4.0/how-to/build.html) * [3.5.16](../3.5/how-to/build.html) * [3.4.13](../3.4/how-to/build.html) * [3.3.13](../3.3/how-to/build.html) - [4.2.0-M2](../4.2/how-to/build.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/build.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/build.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/build.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/packaging.html ---- # Packaging Executable Archives The plugin can create executable archives (jar files and war files) that contain all of an application’s dependencies and can then be run with `java -jar`. ## [](#packaging-executable.jars)Packaging Executable Jars Executable jars can be built using the `bootJar` task. The task is automatically created when the `java` plugin is applied and is an instance of [`BootJar`](api/java/org/springframework/boot/gradle/tasks/bundling/BootJar.html). The `assemble` task is automatically configured to depend upon the `bootJar` task so running `assemble` (or `build`) will also run the `bootJar` task. ## [](#packaging-executable.wars)Packaging Executable Wars Executable wars can be built using the `bootWar` task. The task is automatically created when the `war` plugin is applied and is an instance of [`BootWar`](api/java/org/springframework/boot/gradle/tasks/bundling/BootWar.html). The `assemble` task is automatically configured to depend upon the `bootWar` task so running `assemble` (or `build`) will also run the `bootWar` task. ### [](#packaging-executable.wars.deployable)Packaging Executable and Deployable Wars A war file can be packaged such that it can be executed using `java -jar` and deployed to an external container. To do so, the embedded servlet container runtime should be added to the `providedRuntime` configuration, for example: * Groovy * Kotlin ```groovy dependencies { implementation('org.springframework.boot:spring-boot-starter-webmvc') providedRuntime('org.springframework.boot:spring-boot-starter-tomcat-runtime') } ``` ```kotlin dependencies { implementation("org.springframework.boot:spring-boot-starter-web") providedRuntime("org.springframework.boot:spring-boot-starter-tomcat-runtime") } ``` This ensures that the runtime jars are packaged in the war file’s `WEB-INF/lib-provided` directory from where they will not conflict with the external container’s own classes. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | `providedRuntime` is preferred to Gradle’s `compileOnly` configuration as, among other limitations, `compileOnly` dependencies are not on the test classpath so any web-based integration tests will fail. | ## [](#packaging-executable.and-plain-archives)Packaging Executable and Plain Archives By default, when the `bootJar` or `bootWar` tasks are configured, the `jar` or `war` tasks are configured to use `plain` as the convention for their archive classifier. This ensures that `bootJar` and `jar` or `bootWar` and `war` have different output locations, allowing both the executable archive and the plain archive to be built at the same time. If you prefer that the executable archive, rather than the plain archive, uses a classifier, configure the classifiers as shown in the following example for the `jar` and `bootJar` tasks: * Groovy * Kotlin ```groovy tasks.named("bootJar") { archiveClassifier = 'boot' } tasks.named("jar") { archiveClassifier = '' } ``` ```kotlin tasks.named("bootJar") { archiveClassifier.set("boot") } tasks.named("jar") { archiveClassifier.set("") } ``` Alternatively, if you prefer that the plain archive isn’t built at all, disable its task as shown in the following example for the `jar` task: * Groovy * Kotlin ```groovy tasks.named("jar") { enabled = false } ``` ```kotlin tasks.named("jar") { enabled = false } ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Do not disable the `jar` task when creating native images. See [#33238](https://github.com/spring-projects/spring-boot/issues/33238) for details. | ## [](#packaging-executable.configuring)Configuring Executable Archive Packaging The [`BootJar`](api/java/org/springframework/boot/gradle/tasks/bundling/BootJar.html) and [`BootWar`](api/java/org/springframework/boot/gradle/tasks/bundling/BootWar.html) tasks are subclasses of Gradle’s `Jar` and `War` tasks respectively. As a result, all of the standard configuration options that are available when packaging a jar or war are also available when packaging an executable jar or war. A number of configuration options that are specific to executable jars and wars are also provided. ### [](#packaging-executable.configuring.main-class)Configuring the Main Class By default, the executable archive’s main class will be configured automatically by looking for a class with a `public static void main(String[])` method in the main source set’s output. The main class can also be configured explicitly using the task’s `mainClass` property: * Groovy * Kotlin ```groovy tasks.named("bootJar") { mainClass = 'com.example.ExampleApplication' } ``` ```kotlin tasks.named("bootJar") { mainClass.set("com.example.ExampleApplication") } ``` Alternatively, the main class name can be configured project-wide using the `mainClass` property of the Spring Boot DSL: * Groovy * Kotlin ```groovy springBoot { mainClass = 'com.example.ExampleApplication' } ``` ```kotlin springBoot { mainClass.set("com.example.ExampleApplication") } ``` If the [`application` plugin](https://docs.gradle.org/current/userguide/application_plugin.html) has been applied its `mainClass` property must be configured and can be used for the same purpose: * Groovy * Kotlin ```groovy application { mainClass = 'com.example.ExampleApplication' } ``` ```kotlin application { mainClass.set("com.example.ExampleApplication") } ``` Lastly, the `Start-Class` attribute can be configured on the task’s manifest: * Groovy * Kotlin ```groovy tasks.named("bootJar") { manifest { attributes 'Start-Class': 'com.example.ExampleApplication' } } ``` ```kotlin tasks.named("bootJar") { manifest { attributes("Start-Class" to "com.example.ExampleApplication") } } ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If the main class is written in Kotlin, the name of the generated Java class should be used. By default, this is the name of the Kotlin class with the `Kt` suffix added. For example, `ExampleApplication` becomes `ExampleApplicationKt`. If another name is defined using `@JvmName` then that name should be used. | ### [](#packaging-executable.configuring.including-development-only-dependencies)Including Development-only Dependencies By default all dependencies declared in the `developmentOnly` configuration will be excluded from an executable jar or war. If you want to include dependencies declared in the `developmentOnly` configuration in your archive, configure the classpath of its task to include the configuration, as shown in the following example for the `bootWar` task: * Groovy * Kotlin ```groovy tasks.named("bootWar") { classpath configurations.developmentOnly } ``` ```kotlin tasks.named("bootWar") { classpath(configurations["developmentOnly"]) } ``` ### [](#packaging-executable.configuring.unpacking)Configuring Libraries that Require Unpacking Most libraries can be used directly when nested in an executable archive, however certain libraries can have problems. For example, JRuby includes its own nested jar support which assumes that `jruby-complete.jar` is always directly available on the file system. To deal with any problematic libraries, an executable archive can be configured to unpack specific nested jars to a temporary directory when the executable archive is run. Libraries can be identified as requiring unpacking using Ant-style patterns that match against the absolute path of the source jar file: * Groovy * Kotlin ```groovy tasks.named("bootJar") { requiresUnpack '**/jruby-complete-*.jar' } ``` ```kotlin tasks.named("bootJar") { requiresUnpack("**/jruby-complete-*.jar") } ``` For more control a closure can also be used. The closure is passed a `FileTreeElement` and should return a `boolean` indicating whether or not unpacking is required. ### [](#packaging-executable.configuring.properties-launcher)Using the PropertiesLauncher To use the `PropertiesLauncher` to launch an executable jar or war, configure the task’s manifest to set the `Main-Class` attribute: * Groovy * Kotlin ```groovy tasks.named("bootWar") { manifest { attributes 'Main-Class': 'org.springframework.boot.loader.launch.PropertiesLauncher' } } ``` ```kotlin tasks.named("bootWar") { manifest { attributes("Main-Class" to "org.springframework.boot.loader.launch.PropertiesLauncher") } } ``` ### [](#packaging-executable.configuring.layered-archives)Packaging Layered Jar or War By default, the `bootJar` task builds an archive that contains the application’s classes and dependencies in `BOOT-INF/classes` and `BOOT-INF/lib` respectively. Similarly, `bootWar` builds an archive that contains the application’s classes in `WEB-INF/classes` and dependencies in `WEB-INF/lib` and `WEB-INF/lib-provided`. For cases where a docker image needs to be built from the contents of the jar, it’s useful to be able to separate these directories further so that they can be written into distinct layers. Layered jars use the same layout as regular boot packaged jars, but include an additional meta-data file that describes each layer. By default, the following layers are defined: * `dependencies` for any non-project dependency whose version does not contain `SNAPSHOT`. * `spring-boot-loader` for the jar loader classes. * `snapshot-dependencies` for any non-project dependency whose version contains `SNAPSHOT`. * `application` for project dependencies, application classes, and resources. The layers order is important as it determines how likely previous layers can be cached when part of the application changes. The default order is `dependencies`, `spring-boot-loader`, `snapshot-dependencies`, `application`. Content that is least likely to change should be added first, followed by layers that are more likely to change. To disable this feature, you can do so in the following manner: * Groovy * Kotlin ```groovy tasks.named("bootJar") { layered { enabled = false } } ``` ```kotlin tasks.named("bootJar") { layered { enabled.set(false) } } ``` When a layered jar or war is created, the `spring-boot-jarmode-tools` jar will be added as a dependency to your archive. With this jar on the classpath, you can launch your application in a special mode which allows the bootstrap code to run something entirely different from your application, for example, something that extracts the layers. If you wish to exclude this dependency, you can do so in the following manner: * Groovy * Kotlin ```groovy tasks.named("bootJar") { includeTools = false } ``` ```kotlin tasks.named("bootJar") { includeTools.set(false) } ``` #### [](#packaging-executable.configuring.layered-archives.configuration)Custom Layers Configuration Depending on your application, you may want to tune how layers are created and add new ones. This can be done using configuration that describes how the jar or war can be separated into layers, and the order of those layers. The following example shows how the default ordering described above can be defined explicitly: * Groovy * Kotlin ```groovy tasks.named("bootJar") { layered { application { intoLayer("spring-boot-loader") { include "org/springframework/boot/loader/**" } intoLayer("application") } dependencies { intoLayer("application") { includeProjectDependencies() } intoLayer("snapshot-dependencies") { include "*:*:*SNAPSHOT" } intoLayer("dependencies") } layerOrder = ["dependencies", "spring-boot-loader", "snapshot-dependencies", "application"] } } ``` ```kotlin tasks.named("bootJar") { layered { application { intoLayer("spring-boot-loader") { include("org/springframework/boot/loader/**") } intoLayer("application") } dependencies { intoLayer("application") { includeProjectDependencies() } intoLayer("snapshot-dependencies") { include("*:*:*SNAPSHOT") } intoLayer("dependencies") } layerOrder.set(listOf("dependencies", "spring-boot-loader", "snapshot-dependencies", "application")) } } ``` The `layered` DSL is defined using three parts: * The `application` closure defines how the application classes and resources should be layered. * The `dependencies` closure defines how dependencies should be layered. * The `layerOrder` method defines the order that the layers should be written. Nested `intoLayer` closures are used within `application` and `dependencies` sections to claim content for a layer. These closures are evaluated in the order that they are defined, from top to bottom. Any content not claimed by an earlier `intoLayer` closure remains available for subsequent ones to consider. The `intoLayer` closure claims content using nested `include` and `exclude` calls. The `application` closure uses Ant-style path matching for include/exclude parameters. The `dependencies` section uses `group:artifact[:version]` patterns. It also provides `includeProjectDependencies()` and `excludeProjectDependencies()` methods that can be used to include or exclude project dependencies. If no `include` call is made, then all content (not claimed by an earlier closure) is considered. If no `exclude` call is made, then no exclusions are applied. Looking at the `dependencies` closure in the example above, we can see that the first `intoLayer` will claim all project dependencies for the `application` layer. The next `intoLayer` will claim all SNAPSHOT dependencies for the `snapshot-dependencies` layer. The third and final `intoLayer` will claim anything left (in this case, any dependency that is not a project dependency or a SNAPSHOT) for the `dependencies` layer. The `application` closure has similar rules. First claiming `org/springframework/boot/loader/**` content for the `spring-boot-loader` layer. Then claiming any remaining classes and resources for the `application` layer. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The order that `intoLayer` closures are added is often different from the order that the layers are written. For this reason the `layerOrder` method must always be called and *must* cover all layers referenced by the `intoLayer` calls. | * [Spring Boot](../index.html) * [4.1.1](packaging.html) * [4.0.8](../4.0/gradle-plugin/packaging.html) * [3.5.16](../3.5/gradle-plugin/packaging.html) * [3.4.13](../3.4/gradle-plugin/packaging.html) * [3.3.13](../3.3/gradle-plugin/packaging.html) - [4.2.0-M2](../4.2/gradle-plugin/packaging.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/gradle-plugin/packaging.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/gradle-plugin/packaging.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/gradle-plugin/packaging.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/index.html ---- # Spring Boot Gradle Plugin 4.1.1 API Packages ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/plugin/ResolveMainClassName.html ---- # Class ResolveMainClassName [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.gradle.api.internal.AbstractTask [org.gradle.api.DefaultTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/DefaultTask.html "class or interface in org.gradle.api") org.springframework.boot.gradle.plugin.ResolveMainClassName * All Implemented Interfaces: `Comparable, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Task, Configurable` *** [@DisableCachingByDefault](https://docs.gradle.org/9.7.0/javadoc/org/gradle/work/DisableCachingByDefault.html "class or interface in org.gradle.work")([because](https://docs.gradle.org/9.7.0/javadoc/org/gradle/work/DisableCachingByDefault.html#because\(\) "class or interface in org.gradle.work")="Not worth caching") public class ResolveMainClassName extends [DefaultTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/DefaultTask.html "class or interface in org.gradle.api") [`Task`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") for resolving the name of the application's main class. * Since: 2.4 `ResolveMainClassName()` Creates a new instance of the `ResolveMainClassName` task. - ## Method Summary Modifier and Type Method Description `FileCollection` `getClasspath()` Returns the classpath that the task will examine when resolving the main class name. `Property` `getConfiguredMainClassName()` Returns the property for the explicitly configured main class name that should be used in favor of resolving the main class name from the classpath. `RegularFileProperty` `getOutputFile()` Returns the property for the task's output file that will contain the name of the main class. `void` `setClasspath(Object classpath)` Sets the classpath that the task will examine when resolving the main class name. `void` `setClasspath(FileCollection classpath)` Sets the classpath that the task will examine when resolving the main class name. * ### ResolveMainClassName public ResolveMainClassName() Creates a new instance of the `ResolveMainClassName` task. * ## Method Details * ### getClasspath [@Classpath](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Classpath.html "class or interface in org.gradle.api.tasks") public [FileCollection](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCollection.html "class or interface in org.gradle.api.file") getClasspath() Returns the classpath that the task will examine when resolving the main class name. * Returns: the classpath * ### setClasspath public void setClasspath​([FileCollection](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCollection.html "class or interface in org.gradle.api.file") classpath) Sets the classpath that the task will examine when resolving the main class name. * Parameters: `classpath` - the classpath * ### setClasspath public void setClasspath​([Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") classpath) Sets the classpath that the task will examine when resolving the main class name. The given `classpath` is evaluated as per [`Project.files(Object...)`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Project.html#files\(java.lang.Object...\) "class or interface in org.gradle.api"). * Parameters: `classpath` - the classpath * Since: 2.5.10 * ### getOutputFile [@OutputFile](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/OutputFile.html "class or interface in org.gradle.api.tasks") public [RegularFileProperty](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/RegularFileProperty.html "class or interface in org.gradle.api.file") getOutputFile() Returns the property for the task's output file that will contain the name of the main class. * Returns: the output file * ### getConfiguredMainClassName [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getConfiguredMainClassName() Returns the property for the explicitly configured main class name that should be used in favor of resolving the main class name from the classpath. * Returns: the configured main class name property ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/ExcludeFilter.html ---- # Class ExcludeFilter [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.shared.artifact.filter.collection.AbstractArtifactsFilter [org.springframework.boot.maven.DependencyFilter](DependencyFilter.html "class in org.springframework.boot.maven") org.springframework.boot.maven.ExcludeFilter * All Implemented Interfaces: `org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter` *** public class ExcludeFilter extends [DependencyFilter](DependencyFilter.html "class in org.springframework.boot.maven") An {DependencyFilter} that filters out any artifact matching an [`Exclude`](Exclude.html "class in org.springframework.boot.maven"). * Since: 1.1.0 * Author: Stephane Nicoll, David Turanski - ## Constructor Summary Constructors Constructor Description `ExcludeFilter(List excludes)`   `ExcludeFilter(Exclude... excludes)` * ### ExcludeFilter public ExcludeFilter​([Exclude](Exclude.html "class in org.springframework.boot.maven")... excludes) * ### ExcludeFilter public ExcludeFilter​([List](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html "class or interface in java.util")<[Exclude](Exclude.html "class in org.springframework.boot.maven")> excludes) * ## Method Details * ### filter protected boolean filter​(org.apache.maven.artifact.Artifact artifact) * Specified by: `filter` in class `DependencyFilter` ---- url: https://docs.spring.io/spring-boot/maven-plugin/using.html ---- # Using the Plugin Maven users can inherit from the `spring-boot-starter-parent` project to obtain sensible defaults. The parent project provides the following features: * Java 17 as the default compiler level. * UTF-8 source encoding. * Compilation with `-parameters`. * A dependency management section, inherited from the `spring-boot-dependencies` POM, that manages the versions of common dependencies. This dependency management lets you omit `` tags for those dependencies when used in your own POM. * An execution of the [`repackage` goal](packaging.html#packaging.repackage-goal) with a `repackage` execution id. * A `native` profile that configures the build to be able to generate a Native image. * Sensible [resource filtering](https://maven.apache.org/plugins/maven-resources-plugin/examples/filter.html). * Sensible plugin configuration ([`Git Commit Id Plugin`](https://github.com/git-commit-id/git-commit-id-maven-plugin), and [shade](https://maven.apache.org/plugins/maven-shade-plugin/)). * Sensible resource filtering for `application.properties` and `application.yml` including profile-specific files (for example, `application-dev.properties` and `application-dev.yml`) | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Since the `application.properties` and `application.yml` files accept Spring style placeholders (`${…​}`), the Maven filtering is changed to use `@..@` placeholders. (You can override that by setting a Maven property called `resource.delimiter`.) | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The `spring-boot-starter-parent` sets the `maven.compiler.release` property, which restricts the `--add-exports`, `--add-reads`, and `--patch-module` options [if they modify system modules](https://openjdk.org/jeps/247). In case you need to use those options, unset `maven.compiler.release`:```xml ```and then configure the source and the target options instead:```xml ${java.version} ${java.version} ``` | ## [](#using.parent-pom)Inheriting the Starter Parent POM To configure your project to inherit from the `spring-boot-starter-parent`, set the `parent` as follows: ```xml org.springframework.boot spring-boot-starter-parent 4.1.1 ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You should need to specify only the Spring Boot version number on this dependency. If you import additional starters, you can safely omit the version number. | With that setup, you can also override individual dependencies by overriding a property in your own project. For instance, to use a different version of the SLF4J library and the Spring Data release train, you would add the following to your `pom.xml`: ```xml 1.7.30 2024.1.10 ``` Browse the [Dependency Versions Properties](../appendix/dependency-versions/properties.html) section in the Spring Boot reference for a complete list of dependency version properties. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Each Spring Boot release is designed and tested against a specific set of third-party dependencies. Overriding versions may cause compatibility issues and should be done with care. | ## [](#using.import)Using Spring Boot without the Parent POM There may be reasons for you not to inherit from the `spring-boot-starter-parent` POM. You may have your own corporate standard parent that you need to use or you may prefer to explicitly declare all your Maven configuration. If you do not want to use the `spring-boot-starter-parent`, you can still keep the benefit of the dependency management (but not the plugin management) by using an `import` scoped dependency, as follows: ```xml org.springframework.boot spring-boot-dependencies 4.1.1 pom import ``` The preceding sample setup does not let you override individual dependencies by using properties, as explained above. To achieve the same result, you need to add entries in the `dependencyManagement` section of your project **before** the `spring-boot-dependencies` entry. For instance, to use a different version of the SLF4J library and the Spring Data release train, you could add the following elements to your `pom.xml`: ```xml org.slf4j slf4j-api 1.7.30 org.springframework.data spring-data-bom 2024.1.10 pom import org.springframework.boot spring-boot-dependencies 4.1.1 pom import ``` ## [](#using.overriding-command-line)Overriding Settings on the Command Line The plugin offers a number of user properties, starting with `spring-boot`, to let you customize the configuration from the command line. For instance, you could tune the profiles to enable when running the application as follows: ```shell $ mvn spring-boot:run -Dspring-boot.run.profiles=dev,local ``` If you want to both have a default while allowing it to be overridden on the command line, you should use a combination of a user-provided project property and MOJO configuration. ```xml local,dev org.springframework.boot spring-boot-maven-plugin ${app.profiles} ``` The above makes sure that `local` and `dev` are enabled by default. Now a dedicated property has been exposed, this can be overridden on the command line as well: ```shell $ mvn spring-boot:run -Dapp.profiles=test ``` * [Spring Boot](../index.html) * [4.1.1](using.html) * [4.0.8](../4.0/maven-plugin/using.html) * [3.5.16](../3.5/maven-plugin/using.html) * [3.4.13](../3.4/maven-plugin/using.html) * [3.3.13](../3.3/maven-plugin/using.html) - [4.2.0-M2](../4.2/maven-plugin/using.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/maven-plugin/using.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/maven-plugin/using.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/maven-plugin/using.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/actuator/auditing.html ---- # Auditing Once Spring Security is in play, Spring Boot Actuator has a flexible audit framework that publishes events (by default, “authentication success”, “failure” and “access denied” exceptions). This feature can be very useful for reporting and for implementing a lock-out policy based on authentication failures. You can enable auditing by providing a bean of type [`AuditEventRepository`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/audit/AuditEventRepository.html) in your application’s configuration. For convenience, Spring Boot offers an [`InMemoryAuditEventRepository`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/audit/InMemoryAuditEventRepository.html). [`InMemoryAuditEventRepository`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/audit/InMemoryAuditEventRepository.html) has limited capabilities, and we recommend using it only for development environments. For production environments, consider creating your own alternative [`AuditEventRepository`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/audit/AuditEventRepository.html) implementation. ## [](#actuator.auditing.custom)Custom Auditing To customize published security events, you can provide your own implementations of [`AbstractAuthenticationAuditListener`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/security/AbstractAuthenticationAuditListener.html) and [`AbstractAuthorizationAuditListener`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/security/AbstractAuthorizationAuditListener.html). You can also use the audit services for your own business events. To do so, either inject the [`AuditEventRepository`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/audit/AuditEventRepository.html) bean into your own components and use that directly or publish an [`AuditApplicationEvent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/audit/listener/AuditApplicationEvent.html) with the Spring [`ApplicationEventPublisher`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationEventPublisher.html) (by implementing [`ApplicationEventPublisherAware`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationEventPublisherAware.html)). * [Spring Boot](../../index.html) * [4.1.1](auditing.html) * [4.0.8](../../4.0/reference/actuator/auditing.html) * [3.5.16](../../3.5/reference/actuator/auditing.html) * [3.4.13](../../3.4/reference/actuator/auditing.html) * [3.3.13](../../3.3/reference/actuator/auditing.html) - [4.2.0-M2](../../4.2/reference/actuator/auditing.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/actuator/auditing.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/actuator/auditing.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/actuator/auditing.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/messaging/websockets.html ---- # WebSockets Spring Boot provides WebSockets auto-configuration for embedded Tomcat and Jetty. If you deploy a war file to a standalone container, Spring Boot assumes that the container is responsible for the configuration of its WebSocket support. Spring Framework provides [rich WebSocket support](https://docs.spring.io/spring-framework/reference/7.0/web/websocket.html) for MVC web applications that can be easily accessed through the `spring-boot-starter-websocket` module. WebSocket support is also available for [reactive web applications](https://docs.spring.io/spring-framework/reference/7.0/web/webflux-websocket.html) and requires to include the WebSocket API alongside `spring-boot-starter-webflux`: ```xml jakarta.websocket jakarta.websocket-api ``` * [Spring Boot](../../index.html) * [4.1.1](websockets.html) * [4.0.8](../../4.0/reference/messaging/websockets.html) * [3.5.16](../../3.5/reference/messaging/websockets.html) * [3.4.13](../../3.4/reference/messaging/websockets.html) * [3.3.13](../../3.3/reference/messaging/websockets.html) - [4.2.0-M2](../../4.2/reference/messaging/websockets.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/messaging/websockets.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/messaging/websockets.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/messaging/websockets.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/Exclude.html ---- # Class Exclude [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") [org.springframework.boot.maven.FilterableDependency](FilterableDependency.html "class in org.springframework.boot.maven") org.springframework.boot.maven.Exclude *** public class Exclude extends [FilterableDependency](FilterableDependency.html "class in org.springframework.boot.maven") A model for a dependency to exclude. * Since: 1.1.0 * Author: Stephane Nicoll - ## Constructor Summary Constructors Constructor Description `Exclude()`   - ## Method Summary ### Methods inherited from class [FilterableDependency](FilterableDependency.html#method-summary "class in org.springframework.boot.maven") `set` ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### Exclude public Exclude() ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-3.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## C * [CacheInfo](../org/springframework/boot/maven/CacheInfo.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Encapsulates configuration of an image building cache. * [CacheInfo()](../org/springframework/boot/maven/CacheInfo.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.maven.[CacheInfo](../org/springframework/boot/maven/CacheInfo.html "class in org.springframework.boot.maven")   * [CacheInfo.BindCacheInfo](../org/springframework/boot/maven/CacheInfo.BindCacheInfo.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Encapsulates configuration of an image building cache stored in a bind mount. * [CacheInfo.VolumeCacheInfo](../org/springframework/boot/maven/CacheInfo.VolumeCacheInfo.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Encapsulates configuration of an image building cache stored in a volume. * [canTransformResource(String)](../org/springframework/boot/maven/PropertiesMergingResourceTransformer.html#canTransformResource\(java.lang.String\)) - Method in class org.springframework.boot.maven.[PropertiesMergingResourceTransformer](../org/springframework/boot/maven/PropertiesMergingResourceTransformer.html "class in org.springframework.boot.maven")   * [compileSourceFiles(URL\[\], File, File)](../org/springframework/boot/maven/AbstractAotMojo.html#compileSourceFiles\(java.net.URL%5B%5D,java.io.File,java.io.File\)) - Method in class org.springframework.boot.maven.[AbstractAotMojo](../org/springframework/boot/maven/AbstractAotMojo.html "class in org.springframework.boot.maven")   * [copyAll(Path, Path)](../org/springframework/boot/maven/AbstractAotMojo.html#copyAll\(java.nio.file.Path,java.nio.file.Path\)) - Method in class org.springframework.boot.maven.[AbstractAotMojo](../org/springframework/boot/maven/AbstractAotMojo.html "class in org.springframework.boot.maven")   [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/how-to/batch.html ---- # Batch Applications A number of questions often arise when people use Spring Batch from within a Spring Boot application. This section addresses those questions. ## [](#howto.batch.specifying-a-data-source)Specifying a Batch Data Source Batch applications that store job details in an SQL database require a [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) bean. A single [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) bean is required by default. To have Spring Batch use a [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) other than the application’s main [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html), declare a [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) bean, annotating its [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) method with [`@BatchDataSource`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/batch/jdbc/autoconfigure/BatchDataSource.html). If you do so and want two data sources (for example by retaining the main auto-configured [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html)), set the `defaultCandidate` attribute of the [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) annotation to `false`. ## [](#howto.batch.specifying-a-transaction-manager)Specifying a Batch Transaction Manager Similar to [Specifying a Batch Data Source](#howto.batch.specifying-a-data-source), you can define a [`PlatformTransactionManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/transaction/PlatformTransactionManager.html) for use in batch processing by annotating its [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) method with [`@BatchTransactionManager`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/batch/autoconfigure/BatchTransactionManager.html). If you do so and want two transaction managers (for example by retaining the auto-configured [`PlatformTransactionManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/transaction/PlatformTransactionManager.html)), set the `defaultCandidate` attribute of the [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) annotation to `false`. ## [](#howto.batch.specifying-a-task-executor)Specifying a Batch Task Executor Similar to [Specifying a Batch Data Source](#howto.batch.specifying-a-data-source), you can define a [`TaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/TaskExecutor.html) for use in batch processing by annotating its [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) method with [`@BatchTaskExecutor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/batch/autoconfigure/BatchTaskExecutor.html). If you do so and want two task executors (for example by retaining the auto-configured [`TaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/TaskExecutor.html)), set the `defaultCandidate` attribute of the [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) annotation to `false`. ## [](#howto.batch.running-from-the-command-line)Running From the Command Line Spring Boot converts any command line argument starting with `--` to a property to add to the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html), see [accessing command line properties](../reference/features/external-config.html#features.external-config.command-line-args). This should not be used to pass arguments to batch jobs. To specify batch arguments on the command line, use the regular format (that is without `--`), as shown in the following example: ```shell $ java -jar myapp.jar someParameter=someValue anotherParameter=anotherValue ``` If you specify a property of the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) on the command line, it is ignored by the job. Consider the following command: ```shell $ java -jar myapp.jar --server.port=7070 someParameter=someValue ``` This provides only one argument to the batch job: `someParameter=someValue`. ## [](#howto.batch.restarting-a-failed-job)Restarting a Stopped or Failed Job To restart a failed [`Job`](https://docs.spring.io/spring-batch/docs/6.0.x/api/org/springframework/batch/core/job/Job.html), all parameters (identifying and non-identifying) must be re-specified on the command line. Non-identifying parameters are **not** copied from the previous execution. This allows them to be modified or removed. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | When you’re using a custom [`JobParametersIncrementer`](https://docs.spring.io/spring-batch/docs/6.0.x/api/org/springframework/batch/core/job/parameters/JobParametersIncrementer.html), you have to gather all parameters managed by the incrementer to restart a failed execution. | * [Spring Boot](../index.html) * [4.1.1](batch.html) * [4.0.8](../4.0/how-to/batch.html) * [3.5.16](../3.5/how-to/batch.html) * [3.4.13](../3.4/how-to/batch.html) * [3.3.13](../3.3/how-to/batch.html) - [4.2.0-M2](../4.2/how-to/batch.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/batch.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/batch.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/batch.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/testing/index.html ---- # Testing Spring Boot provides a number of utilities and annotations to help when testing your application. Test support is provided by two general-purpose modules – `spring-boot-test` contains core items and `spring-boot-test-autoconfigure` supports auto-configuration for tests – and several focused `-test` modules that provide testing support for a particular feature. Most developers use the `spring-boot-starter-test` starter, which imports both general-purpose Spring Boot test modules as well as JUnit Jupiter, AssertJ, Hamcrest, and a number of other useful libraries, and the focused `-test` modules that are applicable to their particular application. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you have tests that use JUnit 4, JUnit 6’s vintage engine can be used to run them. To use the vintage engine, add a dependency on `junit-vintage-engine`, as shown in the following example:```xml org.junit.vintage junit-vintage-engine test org.hamcrest hamcrest-core ``` | `hamcrest-core` is excluded in favor of `org.hamcrest:hamcrest` that is part of `spring-boot-starter-test`. * [Spring Boot](../../index.html) * [4.1.1](index.html) * [4.0.8](../../4.0/reference/testing/index.html) * [3.5.16](../../3.5/reference/testing/index.html) * [3.4.13](../../3.4/reference/testing/index.html) * [3.3.13](../../3.3/reference/testing/index.html) - [4.2.0-M2](../../4.2/reference/testing/index.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/testing/index.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/testing/index.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/testing/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) * [Spring AI](https://docs.spring.io/spring-ai/reference/) * [Spring AMQP](https://docs.spring.io/spring-amqp/reference/) * [Spring CLI](https://docs.spring.io/spring-cli/reference/) * [Spring GraphQL](https://docs.spring.io/spring-graphql/reference/) * [Spring for Apache Kafka](https://docs.spring.io/spring-kafka/reference/) * [Spring Modulith](https://docs.spring.io/spring-modulith/reference/) * [Spring for Apache Pulsar](https://docs.spring.io/spring-pulsar/reference/) * [Spring Shell](https://docs.spring.io/spring-shell/reference/) [All Docs...](../../spring-projects.html) [Search in all Spring Docs](../../search.html) [](https://www.algolia.com/) ---- url: https://docs.spring.io/spring-boot/reference/features/ssl.html ---- # SSL Spring Boot provides the ability to configure SSL trust material that can be applied to several types of connections in order to support secure communications. Configuration properties with the prefix `spring.ssl.bundle` can be used to specify named sets of trust material and associated information. ## [](#features.ssl.jks)Configuring SSL With Java KeyStore Files Configuration properties with the prefix `spring.ssl.bundle.jks` can be used to configure bundles of trust material created with the Java `keytool` utility and stored in Java KeyStore files in the JKS or PKCS12 format. Each bundle has a user-provided name that can be used to reference the bundle. When used to secure an embedded web server, a `keystore` is typically configured with a Java KeyStore containing a certificate and private key as shown in this example: * Properties * YAML ```properties spring.ssl.bundle.jks.mybundle.key.alias=application spring.ssl.bundle.jks.mybundle.keystore.location=classpath:application.p12 spring.ssl.bundle.jks.mybundle.keystore.password=secret spring.ssl.bundle.jks.mybundle.keystore.type=PKCS12 ``` ```yaml spring: ssl: bundle: jks: mybundle: key: alias: "application" keystore: location: "classpath:application.p12" password: "secret" type: "PKCS12" ``` When used to secure a client-side connection, a `truststore` is typically configured with a Java KeyStore containing the server certificate as shown in this example: * Properties * YAML ```properties spring.ssl.bundle.jks.mybundle.truststore.location=classpath:server.p12 spring.ssl.bundle.jks.mybundle.truststore.password=secret ``` ```yaml spring: ssl: bundle: jks: mybundle: truststore: location: "classpath:server.p12" password: "secret" ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Rather than the location to a file, its [Base64 encoded content](external-config.html#features.external-config.typesafe-configuration-properties.conversion.base64) can be provided. If you chose this option, the value of the property should start with `base64:`. | See [`JksSslBundleProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/ssl/JksSslBundleProperties.html) for the full set of supported properties. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you’re using environment variables to configure the bundle, the name of the bundle is [always converted to lowercase](external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.maps-from-environment-variables). | ## [](#features.ssl.pem)Configuring SSL With PEM-encoded Certificates Configuration properties with the prefix `spring.ssl.bundle.pem` can be used to configure bundles of trust material in the form of PEM-encoded text. Each bundle has a user-provided name that can be used to reference the bundle. When used to secure an embedded web server, a `keystore` is typically configured with a certificate and private key as shown in this example: * Properties * YAML ```properties spring.ssl.bundle.pem.mybundle.keystore.certificate=classpath:application.crt spring.ssl.bundle.pem.mybundle.keystore.private-key=classpath:application.key ``` ```yaml spring: ssl: bundle: pem: mybundle: keystore: certificate: "classpath:application.crt" private-key: "classpath:application.key" ``` When used to secure a client-side connection, a `truststore` is typically configured with the server certificate as shown in this example: * Properties * YAML ```properties spring.ssl.bundle.pem.mybundle.truststore.certificate=classpath:server.crt ``` ```yaml spring: ssl: bundle: pem: mybundle: truststore: certificate: "classpath:server.crt" ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Rather than the location to a file, its [Base64 encoded content](external-config.html#features.external-config.typesafe-configuration-properties.conversion.base64) can be provided. If you chose this option, the value of the property should start with `base64:`.PEM content can also be used directly for both the `certificate` and `private-key` properties. If the property values contain `BEGIN` and `END` markers then they will be treated as PEM content rather than a resource location.The following example shows how a truststore certificate can be defined:- Properties - YAML```properties spring.ssl.bundle.pem.mybundle.truststore.certificate=\ -----BEGIN CERTIFICATE-----\n\ MIID1zCCAr+gAwIBAgIUNM5QQv8IzVQsgSmmdPQNaqyzWs4wDQYJKoZIhvcNAQEL\n\ BQAwezELMAkGA1UEBhMCWFgxEjAQBgNVBAgMCVN0YXRlTmFtZTERMA8GA1UEBwwI\n\ ...\n\ V0IJjcmYjEZbTvpjFKznvaFiOUv+8L7jHQ1/Yf+9c3C8gSjdUfv88m17pqYXd+Ds\n\ HEmfmNNjht130UyjNCITmLVXyy5p35vWmdf95U3uEbJSnNVtXH8qRmN9oK9mUpDb\n\ ngX6JBJI7fw7tXoqWSLHNiBODM88fUlQSho8\n\ -----END CERTIFICATE----- ``````yaml spring: ssl: bundle: pem: mybundle: truststore: certificate: | -----BEGIN CERTIFICATE----- MIID1zCCAr+gAwIBAgIUNM5QQv8IzVQsgSmmdPQNaqyzWs4wDQYJKoZIhvcNAQEL BQAwezELMAkGA1UEBhMCWFgxEjAQBgNVBAgMCVN0YXRlTmFtZTERMA8GA1UEBwwI ... V0IJjcmYjEZbTvpjFKznvaFiOUv+8L7jHQ1/Yf+9c3C8gSjdUfv88m17pqYXd+Ds HEmfmNNjht130UyjNCITmLVXyy5p35vWmdf95U3uEbJSnNVtXH8qRmN9oK9mUpDb ngX6JBJI7fw7tXoqWSLHNiBODM88fUlQSho8 -----END CERTIFICATE----- ``` | See [`PemSslBundleProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/ssl/PemSslBundleProperties.html) for the full set of supported properties. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you’re using environment variables to configure the bundle, the name of the bundle is [always converted to lowercase](external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.maps-from-environment-variables). | ## [](#features.ssl.applying)Applying SSL Bundles Once configured using properties, SSL bundles can be referred to by name in configuration properties for various types of connections that are auto-configured by Spring Boot. See the sections on [embedded web servers](../../how-to/webserver.html#howto.webserver.configure-ssl), [data technologies](../data/index.html), and [REST clients](../io/rest-client.html) for further information. ## [](#features.ssl.bundles)Using SSL Bundles Spring Boot auto-configures a bean of type [`SslBundles`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ssl/SslBundles.html) that provides access to each of the named bundles configured using the `spring.ssl.bundle` properties. An [`SslBundle`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ssl/SslBundle.html) can be retrieved from the auto-configured [`SslBundles`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ssl/SslBundles.html) bean and used to create objects that are used to configure SSL connectivity in client libraries. The [`SslBundle`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ssl/SslBundle.html) provides a layered approach of obtaining these SSL objects: * `getStores()` provides access to the key store and trust store [`KeyStore`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/security/KeyStore.html) instances as well as any required key store password. * `getManagers()` provides access to the [`KeyManagerFactory`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/net/ssl/KeyManagerFactory.html) and [`TrustManagerFactory`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/net/ssl/TrustManagerFactory.html) instances as well as the [`KeyManager`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/net/ssl/KeyManager.html) and [`TrustManager`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/net/ssl/TrustManager.html) arrays that they create. * `createSslContext()` provides a convenient way to obtain a new [`SSLContext`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/net/ssl/SSLContext.html) instance. In addition, the [`SslBundle`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ssl/SslBundle.html) provides details about the key being used, the protocol to use and any option that should be applied to the SSL engine. The following example shows retrieving an [`SslBundle`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ssl/SslBundle.html) and using it to create an [`SSLContext`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/net/ssl/SSLContext.html): * Java * Kotlin ```java import javax.net.ssl.SSLContext; import org.springframework.boot.ssl.SslBundle; import org.springframework.boot.ssl.SslBundles; import org.springframework.stereotype.Component; @Component public class MyComponent { public MyComponent(SslBundles sslBundles) { SslBundle sslBundle = sslBundles.getBundle("mybundle"); SSLContext sslContext = sslBundle.createSslContext(); // do something with the created sslContext } } ``` ```kotlin import org.springframework.boot.ssl.SslBundles import org.springframework.stereotype.Component @Component class MyComponent(sslBundles: SslBundles) { init { val sslBundle = sslBundles.getBundle("mybundle") val sslContext = sslBundle.createSslContext() // do something with the created sslContext } } ``` ## [](#features.ssl.reloading)Reloading SSL bundles SSL bundles can be reloaded when the key material changes. The component consuming the bundle has to be compatible with reloadable SSL bundles. Currently the following components are compatible: * Tomcat web server * Netty web server To enable reloading, you need to opt-in via a configuration property as shown in this example: * Properties * YAML ```properties spring.ssl.bundle.pem.mybundle.reload-on-update=true spring.ssl.bundle.pem.mybundle.keystore.certificate=file:/some/directory/application.crt spring.ssl.bundle.pem.mybundle.keystore.private-key=file:/some/directory/application.key ``` ```yaml spring: ssl: bundle: pem: mybundle: reload-on-update: true keystore: certificate: "file:/some/directory/application.crt" private-key: "file:/some/directory/application.key" ``` A file watcher is then watching the files and if they change, the SSL bundle will be reloaded. This in turn triggers a reload in the consuming component, e.g. Tomcat rotates the certificates in the SSL enabled connectors. You can configure the quiet period (to make sure that there are no more changes) of the file watcher with the `spring.ssl.bundle.watch.file.quiet-period` property. ### [](#features.ssl.reloading.lets-encrypt)Reloading SSL Bundles With Let’s Encrypt If you use certificates issued by [Let’s Encrypt](https://letsencrypt.org/) and renewed by an external tool, such as [Certbot](https://certbot.eff.org/), you can configure a PEM bundle to use the generated files and enable reloading. Certbot typically stores these in `/etc/letsencrypt/live/` under a directory named after your domain. The following example shows how to configure a PEM bundle for `example.com`: * Properties * YAML ```properties spring.ssl.bundle.pem.webserver.reload-on-update=true spring.ssl.bundle.pem.webserver.keystore.certificate=file:/etc/letsencrypt/live/example.com/fullchain.pem spring.ssl.bundle.pem.webserver.keystore.private-key=file:/etc/letsencrypt/live/example.com/privkey.pem server.ssl.bundle=webserver ``` ```yaml spring: ssl: bundle: pem: webserver: reload-on-update: true keystore: certificate: "file:/etc/letsencrypt/live/example.com/fullchain.pem" private-key: "file:/etc/letsencrypt/live/example.com/privkey.pem" server: ssl: bundle: "webserver" ``` Spring Boot does not request or renew Let’s Encrypt certificates. When Certbot or another ACME client updates the configured files, the SSL bundle is reloaded. Compatible consumers, such as Tomcat and Netty web servers, can then use the updated certificate without restarting the application. The files in `/etc/letsencrypt/live` are typically symbolic links to files in `/etc/letsencrypt/archive`. The file watcher follows symbolic links so that updates to the target files can trigger a reload. * [Spring Boot](../../index.html) * [4.1.1](ssl.html) * [4.0.8](../../4.0/reference/features/ssl.html) * [3.5.16](../../3.5/reference/features/ssl.html) * [3.4.13](../../3.4/reference/features/ssl.html) * [3.3.13](../../3.3/reference/features/ssl.html) - [4.2.0-M2](../../4.2/reference/features/ssl.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/features/ssl.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/features/ssl.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/features/ssl.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/documentation.html ---- # Documentation Overview This section provides a brief overview of Spring Boot reference documentation. It serves as a map for the rest of the document. ## [](#documentation.first-steps)First Steps If you are getting started with Spring Boot or 'Spring' in general, start with the following topics: * **From scratch:** [Overview](index.html) | [Requirements](system-requirements.html) | [Installation](installing.html) * **Tutorial:** [Part 1](tutorial/first-application/index.html) | [Part 2](tutorial/first-application/index.html#getting-started.first-application.code) * **Running your example:** [Part 1](tutorial/first-application/index.html#getting-started.first-application.run) | [Part 2](tutorial/first-application/index.html#getting-started.first-application.executable-jar) ## [](#documentation.upgrading)Upgrading From an Earlier Version You should always ensure that you are running a [supported version](https://github.com/spring-projects/spring-boot/wiki/Supported-Versions) of Spring Boot. Depending on the version that you are upgrading to, you can find some additional tips here: * **From 1.x to 2.x:** [Upgrading from 1.x](upgrading.html#upgrading.from-1x) * **From 2.x:** [Upgrading from 2.x](upgrading.html#upgrading.from-2x) * **From 3.x:** [Upgrading from 3.x](upgrading.html#upgrading.from-3x) * **To a new feature release:** [Upgrading to New Feature Release](upgrading.html#upgrading.to-feature) * **Spring Boot CLI:** [Upgrading the Spring Boot CLI](upgrading.html#upgrading.cli) ## [](#documentation.using)Developing With Spring Boot Ready to actually start using Spring Boot? [We have you covered](reference/using/index.html): * **Build systems:** [Maven](reference/using/build-systems.html#using.build-systems.maven) | [Gradle](reference/using/build-systems.html#using.build-systems.gradle) | [Ant](reference/using/build-systems.html#using.build-systems.ant) | [Starters](reference/using/build-systems.html#using.build-systems.starters) * **Best practices:** [Code Structure](reference/using/structuring-your-code.html) | [@Configuration](reference/using/configuration-classes.html) | [@EnableAutoConfiguration](reference/using/auto-configuration.html) | [Beans and Dependency Injection](reference/using/spring-beans-and-dependency-injection.html) * **Running your code:** [IDE](reference/using/running-your-application.html#using.running-your-application.from-an-ide) | [Packaged](reference/using/running-your-application.html#using.running-your-application.as-a-packaged-application) | [Maven](reference/using/running-your-application.html#using.running-your-application.with-the-maven-plugin) | [Gradle](reference/using/running-your-application.html#using.running-your-application.with-the-gradle-plugin) * **Packaging your app:** [Production jars](reference/using/packaging-for-production.html) * **Spring Boot CLI:** [Using the CLI](cli/index.html) ## [](#documentation.features)Learning About Spring Boot Features Need more details about Spring Boot’s core features? [The following content is for you](reference/features/index.html): * **Spring Application:** [SpringApplication](reference/features/spring-application.html) * **External Configuration:** [External Configuration](reference/features/external-config.html) * **Profiles:** [Profiles](reference/features/profiles.html) * **Logging:** [Logging](reference/features/logging.html) ## [](#documentation.web)Web If you develop Spring Boot web applications, take a look at the following content: * **Servlet Web Applications:** [Spring MVC, Jersey, Embedded Servlet Containers](reference/web/servlet.html) * **Reactive Web Applications:** [Spring Webflux, Embedded Servlet Containers](reference/web/reactive.html) * **Graceful Shutdown:** [Graceful Shutdown](reference/web/graceful-shutdown.html) * **Spring Security:** [Default Security Configuration, Auto-configuration for OAuth2, SAML](reference/web/spring-security.html) * **Spring Session:** [Auto-configuration for Spring Session](reference/web/spring-session.html) * **Spring HATEOAS:** [Auto-configuration for Spring HATEOAS](reference/web/spring-hateoas.html) ## [](#documentation.data)Data If your application deals with a datastore, you can see how to configure that here: * **SQL:** [Configuring a SQL Datastore, Embedded Database support, Connection pools, and more.](reference/data/sql.html) * **NOSQL:** [Auto-configuration for NOSQL stores such as Redis, MongoDB, Neo4j, and others.](reference/data/nosql.html) ## [](#documentation.messaging)Messaging If your application uses any messaging protocol, see one or more of the following sections: * **JMS:** [Auto-configuration for ActiveMQ and Artemis, Sending and Receiving messages through JMS](reference/messaging/jms.html) * **AMQP:** [Auto-configuration for RabbitMQ](reference/messaging/amqp.html) * **Kafka:** [Auto-configuration for Spring Kafka](reference/messaging/kafka.html) * **Pulsar:** [Auto-configuration for Spring for Apache Pulsar](reference/messaging/pulsar.html) * **RSocket:** [Auto-configuration for Spring Framework’s RSocket Support](reference/messaging/rsocket.html) * **Spring Integration:** [Auto-configuration for Spring Integration](reference/messaging/spring-integration.html) ## [](#documentation.io)IO If your application needs IO capabilities, see one or more of the following sections: * **Caching:** [Caching support with EhCache, Hazelcast, Infinispan, and more](reference/io/caching.html) * **Quartz:** [Quartz Scheduling](reference/io/quartz.html) * **Mail:** [Sending Email](reference/io/email.html) * **Validation:** [JSR-303 Validation](reference/io/validation.html) * **REST Clients:** [Calling REST Services with RestTemplate and WebClient](reference/io/rest-client.html) * **Webservices:** [Auto-configuration for Spring Web Services](reference/io/webservices.html) * **JTA:** [Distributed Transactions with JTA](reference/io/jta.html) ## [](#documentation.container-images)Container Images Spring Boot provides first-class support for building efficient container images. You can read more about it here: * **Efficient Container Images:** [Tips to optimize container images such as Docker images](reference/packaging/container-images/efficient-images.html) * **Dockerfiles:** [Building container images using dockerfiles](reference/packaging/container-images/dockerfiles.html) * **Cloud Native Buildpacks:** [Support for Cloud Native Buildpacks with Maven and Gradle](reference/packaging/container-images/cloud-native-buildpacks.html) ## [](#documentation.actuator)Moving to Production When you are ready to push your Spring Boot application to production, we have [some tricks](how-to/actuator.html) that you might like: * **Management endpoints:** [Overview](reference/actuator/endpoints.html) * **Connection options:** [HTTP](reference/actuator/monitoring.html) | [JMX](reference/actuator/jmx.html) * **Monitoring:** [Metrics](reference/actuator/metrics.html) | [Auditing](reference/actuator/auditing.html) | [HTTP Exchanges](reference/actuator/http-exchanges.html) | [Process](reference/actuator/process-monitoring.html) ## [](#documentation.packaging)Optimizing for Production Spring Boot applications can be optimized for production using technologies described in these sections: * **Efficient Deployments:** [Unpacking the Executable JAR](reference/packaging/efficient.html#packaging.efficient.unpacking) * **GraalVM Native Images:** [Introduction](reference/packaging/native-image/introducing-graalvm-native-images.html) | [Advanced Topics](reference/packaging/native-image/advanced-topics.html) | [Getting Started](how-to/native-image/developing-your-first-application.html) | [Testing](how-to/native-image/testing-native-applications.html) * **AOT cache:** [Overview](reference/packaging/aot-cache.html) * **Checkpoint and Restore** [Overview](reference/packaging/checkpoint-restore.html) ## [](#documentation.advanced)Advanced Topics Finally, we have a few topics for more advanced users: * **Spring Boot Applications Deployment:** [Cloud Deployment](how-to/deployment/cloud.html) | [OS Service](how-to/deployment/installing.html) * **Build tool plugins:** [Maven](maven-plugin/index.html) | [Gradle](gradle-plugin/index.html) * **Appendix:** [Application Properties](appendix/application-properties/index.html) | [Configuration Metadata](specification/configuration-metadata/index.html) | [Auto-configuration Classes](appendix/auto-configuration-classes/index.html) | [Test Auto-configuration Annotations](appendix/test-auto-configuration/index.html) | [Executable Jars](specification/executable-jar/index.html) | [Dependency Versions](appendix/dependency-versions/index.html) - [Spring Boot](index.html) * [4.1.1](documentation.html) * [4.0.8](4.0/documentation.html) * [3.5.16](3.5/documentation.html) * [3.4.13](3.4/documentation.html) * [3.3.13](3.3/documentation.html) - [4.2.0-M2](4.2/documentation.html) * [4.2.0-SNAPSHOT](4.2-SNAPSHOT/documentation.html) * [4.1.3-SNAPSHOT](4.1-SNAPSHOT/documentation.html) * [4.0.10-SNAPSHOT](4.0-SNAPSHOT/documentation.html) * Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/package-summary.html ---- # Package org.springframework.boot.gradle.tasks.bundling *** @NullMarked package org.springframework.boot.gradle.tasks.bundling Support for creating executable jars and wars. * Class Description [BootArchive](BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") A Spring Boot "fat" archive task. [BootBuildImage](BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") A [`Task`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") for bundling an application into an OCI image using a [buildpack](https://buildpacks.io). [BootJar](BootJar.html "class in org.springframework.boot.gradle.tasks.bundling") A custom [`Jar`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/Jar.html "class or interface in org.gradle.api.tasks.bundling") task that produces a Spring Boot executable jar. [BootWar](BootWar.html "class in org.springframework.boot.gradle.tasks.bundling") A custom [`War`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/War.html "class or interface in org.gradle.api.tasks.bundling") task that produces a Spring Boot executable war. [CacheSpec](CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Configuration for an image building cache. [CacheSpec.BindCacheSpec](CacheSpec.BindCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Configuration for an image building cache stored in a bind mount. [CacheSpec.VolumeCacheSpec](CacheSpec.VolumeCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Configuration for an image building cache stored in a Docker volume. [DockerSpec](DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Encapsulates Docker configuration options. [DockerSpec.DockerRegistrySpec](DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") Encapsulates Docker registry authentication configuration options. [LayeredSpec](LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Encapsulates the configuration for a layered archive. [LayeredSpec.ApplicationSpec](LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") An [`LayeredSpec.IntoLayersSpec`](LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which application classes and resources belong. [LayeredSpec.DependenciesIntoLayerSpec](LayeredSpec.DependenciesIntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Spec that controls the dependencies that should be part of a particular layer. [LayeredSpec.DependenciesSpec](LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") An [`LayeredSpec.IntoLayersSpec`](LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which dependencies belong. [LayeredSpec.IntoLayerSpec](LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Spec that controls the content that should be part of a particular layer. [LayeredSpec.IntoLayersSpec](LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling")\ Base class for specs that control the layers to which a category of content should belong. [ZipCompression](ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") An enumeration of supported compression options for an entry in a ZIP archive. ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/run/package-tree.html ---- # Hierarchy For Package org.springframework.boot.gradle.tasks.run Package Hierarchies: * [All Packages](../../../../../../overview-tree.html) ## Class Hierarchy * java.lang.[Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") * org.gradle.api.internal.AbstractTask (implements org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal) * org.gradle.api.[DefaultTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/DefaultTask.html "class or interface in org.gradle.api") (implements org.gradle.api.[Task](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api")) * org.gradle.api.internal.ConventionTask (implements org.gradle.api.internal.IConventionAware) * org.gradle.api.tasks.[JavaExec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") (implements org.gradle.process.[JavaExecSpec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/process/JavaExecSpec.html "class or interface in org.gradle.process")) * org.springframework.boot.gradle.tasks.run.[BootRun](BootRun.html "class in org.springframework.boot.gradle.tasks.run") ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/buildinfo/package-tree.html ---- # Hierarchy For Package org.springframework.boot.gradle.tasks.buildinfo Package Hierarchies: * [All Packages](../../../../../../overview-tree.html) ## Class Hierarchy * java.lang.[Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") * org.gradle.api.internal.AbstractTask (implements org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal) * org.gradle.api.[DefaultTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/DefaultTask.html "class or interface in org.gradle.api") (implements org.gradle.api.[Task](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api")) * org.springframework.boot.gradle.tasks.buildinfo.[BuildInfo](BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") * org.springframework.boot.gradle.tasks.buildinfo.[BuildInfoProperties](BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") (implements java.io.[Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io")) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/BuildImageForkMojo.html ---- # Class BuildImageForkMojo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.plugin.AbstractMojo [org.springframework.boot.maven.AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") [org.springframework.boot.maven.AbstractPackagerMojo](AbstractPackagerMojo.html "class in org.springframework.boot.maven") [org.springframework.boot.maven.BuildImageMojo](BuildImageMojo.html "class in org.springframework.boot.maven") org.springframework.boot.maven.BuildImageForkMojo * All Implemented Interfaces: `org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo` *** @Mojo(name="build-image", defaultPhase=PACKAGE, requiresProject=true, threadSafe=true, requiresDependencyResolution=COMPILE\_PLUS\_RUNTIME, requiresDependencyCollection=COMPILE\_PLUS\_RUNTIME) @Execute(phase=PACKAGE) public class BuildImageForkMojo extends [BuildImageMojo](BuildImageMojo.html "class in org.springframework.boot.maven") Package an application into an OCI image using a buildpack, forking the lifecycle to make sure that `package` ran. This goal is suitable for command-line invocation. If you need to configure a goal `execution` in your build, use `build-image-no-fork` instead. `BuildImageForkMojo(org.apache.maven.project.MavenProjectHelper projectHelper)` * ### BuildImageForkMojo @Inject public BuildImageForkMojo​(org.apache.maven.project.MavenProjectHelper projectHelper) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/plugin/package-use.html ---- Uses of Package\ org.springframework.boot.gradle.plugin ====================================== No usage of org.springframework.boot.gradle.plugin ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-17.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## S * [session](../org/springframework/boot/maven/AbstractPackagerMojo.html#session) - Variable in class org.springframework.boot.maven.[AbstractPackagerMojo](../org/springframework/boot/maven/AbstractPackagerMojo.html "class in org.springframework.boot.maven") The Maven session. * [set(String)](../org/springframework/boot/maven/FilterableDependency.html#set\(java.lang.String\)) - Method in class org.springframework.boot.maven.[FilterableDependency](../org/springframework/boot/maven/FilterableDependency.html "class in org.springframework.boot.maven") Configures the include or exclude using a user-provided property in the form `groupId:artifactId` or `groupId:artifactId:classifier`. * [setApplicationDirectory(String)](../org/springframework/boot/maven/Image.html#setApplicationDirectory\(java.lang.String\)) - Method in class org.springframework.boot.maven.[Image](../org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven")   * [setBind(CacheInfo.BindCacheInfo)](../org/springframework/boot/maven/CacheInfo.html#setBind\(org.springframework.boot.maven.CacheInfo.BindCacheInfo\)) - Method in class org.springframework.boot.maven.[CacheInfo](../org/springframework/boot/maven/CacheInfo.html "class in org.springframework.boot.maven")   * [setConfiguration(File)](../org/springframework/boot/maven/Layers.html#setConfiguration\(java.io.File\)) - Method in class org.springframework.boot.maven.[Layers](../org/springframework/boot/maven/Layers.html "class in org.springframework.boot.maven")   * [setConfigurationName(String)](../org/springframework/boot/maven/Layers.html#setConfigurationName\(java.lang.String\)) - Method in class org.springframework.boot.maven.[Layers](../org/springframework/boot/maven/Layers.html "class in org.springframework.boot.maven")   * [setContext(String)](../org/springframework/boot/maven/Docker.html#setContext\(java.lang.String\)) - Method in class org.springframework.boot.maven.[Docker](../org/springframework/boot/maven/Docker.html "class in org.springframework.boot.maven")   * [setCreatedDate(String)](../org/springframework/boot/maven/Image.html#setCreatedDate\(java.lang.String\)) - Method in class org.springframework.boot.maven.[Image](../org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven")   * [setExcludeGroupIds(String)](../org/springframework/boot/maven/AbstractDependencyFilterMojo.html#setExcludeGroupIds\(java.lang.String\)) - Method in class org.springframework.boot.maven.[AbstractDependencyFilterMojo](../org/springframework/boot/maven/AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven")   * [setExcludes(List)](../org/springframework/boot/maven/AbstractDependencyFilterMojo.html#setExcludes\(java.util.List\)) - Method in class org.springframework.boot.maven.[AbstractDependencyFilterMojo](../org/springframework/boot/maven/AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven")   * [setImagePlatform(String)](../org/springframework/boot/maven/Image.html#setImagePlatform\(java.lang.String\)) - Method in class org.springframework.boot.maven.[Image](../org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven")   * [setIncludes(List)](../org/springframework/boot/maven/AbstractDependencyFilterMojo.html#setIncludes\(java.util.List\)) - Method in class org.springframework.boot.maven.[AbstractDependencyFilterMojo](../org/springframework/boot/maven/AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven")   * [setNetwork(String)](../org/springframework/boot/maven/Image.html#setNetwork\(java.lang.String\)) - Method in class org.springframework.boot.maven.[Image](../org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven")   * [setResource(String)](../org/springframework/boot/maven/PropertiesMergingResourceTransformer.html#setResource\(java.lang.String\)) - Method in class org.springframework.boot.maven.[PropertiesMergingResourceTransformer](../org/springframework/boot/maven/PropertiesMergingResourceTransformer.html "class in org.springframework.boot.maven")   * [setVolume(CacheInfo.VolumeCacheInfo)](../org/springframework/boot/maven/CacheInfo.html#setVolume\(org.springframework.boot.maven.CacheInfo.VolumeCacheInfo\)) - Method in class org.springframework.boot.maven.[CacheInfo](../org/springframework/boot/maven/CacheInfo.html "class in org.springframework.boot.maven")   * [StartMojo](../org/springframework/boot/maven/StartMojo.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Start a spring application. * [StartMojo(ToolchainManager)](../org/springframework/boot/maven/StartMojo.html#%3Cinit%3E\(org.apache.maven.toolchain.ToolchainManager\)) - Constructor for class org.springframework.boot.maven.[StartMojo](../org/springframework/boot/maven/StartMojo.html "class in org.springframework.boot.maven")   * [StopMojo](../org/springframework/boot/maven/StopMojo.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Stop an application that has been started by the "start" goal. * [StopMojo()](../org/springframework/boot/maven/StopMojo.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.maven.[StopMojo](../org/springframework/boot/maven/StopMojo.html "class in org.springframework.boot.maven")   [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/reference/using/spring-beans-and-dependency-injection.html ---- # Spring Beans and Dependency Injection You are free to use any of the standard Spring Framework techniques to define your beans and their injected dependencies. We generally recommend using constructor injection to wire up dependencies and [`@ComponentScan`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/ComponentScan.html) to find beans. If you structure your code as suggested above (locating your application class in a top package), you can add [`@ComponentScan`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/ComponentScan.html) without any arguments or use the [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html) annotation which implicitly includes it. All of your application components ([`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html), [`@Service`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Service.html), [`@Repository`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Repository.html), [`@Controller`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Controller.html), and others) are automatically registered as Spring Beans. The following example shows a [`@Service`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Service.html) Bean that uses constructor injection to obtain a required `RiskAssessor` bean: * Java * Kotlin ```java import org.springframework.stereotype.Service; @Service public class MyAccountService implements AccountService { private final RiskAssessor riskAssessor; public MyAccountService(RiskAssessor riskAssessor) { this.riskAssessor = riskAssessor; } // ... } ``` ```kotlin import org.springframework.stereotype.Service @Service class MyAccountService(private val riskAssessor: RiskAssessor) : AccountService ``` If a bean has more than one constructor, you will need to mark the one you want Spring to use with [`@Autowired`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Autowired.html): * Java * Kotlin ```java import java.io.PrintStream; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; @Service public class MyAccountService implements AccountService { private final RiskAssessor riskAssessor; private final PrintStream out; @Autowired public MyAccountService(RiskAssessor riskAssessor) { this.riskAssessor = riskAssessor; this.out = System.out; } public MyAccountService(RiskAssessor riskAssessor, PrintStream out) { this.riskAssessor = riskAssessor; this.out = out; } // ... } ``` ```kotlin import org.springframework.beans.factory.annotation.Autowired import org.springframework.stereotype.Service import java.io.PrintStream @Service class MyAccountService : AccountService { private val riskAssessor: RiskAssessor private val out: PrintStream @Autowired constructor(riskAssessor: RiskAssessor) { this.riskAssessor = riskAssessor out = System.out } constructor(riskAssessor: RiskAssessor, out: PrintStream) { this.riskAssessor = riskAssessor this.out = out } // ... } ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Notice how using constructor injection lets the `riskAssessor` field be marked as `final`, indicating that it cannot be subsequently changed. | * [Spring Boot](../../index.html) * [4.1.1](spring-beans-and-dependency-injection.html) * [4.0.8](../../4.0/reference/using/spring-beans-and-dependency-injection.html) * [3.5.16](../../3.5/reference/using/spring-beans-and-dependency-injection.html) * [3.4.13](../../3.4/reference/using/spring-beans-and-dependency-injection.html) * [3.3.13](../../3.3/reference/using/spring-beans-and-dependency-injection.html) - [4.2.0-M2](../../4.2/reference/using/spring-beans-and-dependency-injection.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/using/spring-beans-and-dependency-injection.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/using/spring-beans-and-dependency-injection.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/using/spring-beans-and-dependency-injection.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/features/dev-services.html ---- # Development-time Services Development-time services provide external dependencies needed to run the application while developing it. They are only supposed to be used while developing and are disabled when the application is deployed. Spring Boot offers support for two development time services, Docker Compose and Testcontainers. The next sections will provide more details about them. ## [](#features.dev-services.docker-compose)Docker Compose Support Docker Compose is a popular technology that can be used to define and manage multiple containers for services that your application needs. A `compose.yml` file is typically created next to your application which defines and configures service containers. A typical workflow with Docker Compose is to run `docker compose up`, work on your application with it connecting to started services, then run `docker compose down` when you are finished. The `spring-boot-docker-compose` module can be included in a project to provide support for working with containers using Docker Compose. Add the module dependency to your build, as shown in the following listings for Maven and Gradle: Maven ```xml org.springframework.boot spring-boot-docker-compose true ``` Gradle ```gradle dependencies { developmentOnly("org.springframework.boot:spring-boot-docker-compose") } ``` When this module is included as a dependency Spring Boot will do the following: * Search for a `compose.yml` and other common compose filenames in your working directory * Call `docker compose up` with the discovered `compose.yml` * Create service connection beans for each supported container * Call `docker compose stop` when the application is shutdown If the Docker Compose services are already running when starting the application, Spring Boot will only create the service connection beans for each supported container. It will not call `docker compose up` again and it will not call `docker compose stop` when the application is shutdown. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Repackaged archives do not contain Spring Boot’s Docker Compose by default. If you want to use this support, you need to include it. When using the Maven plugin, set the `excludeDockerCompose` property to `false`. When using the Gradle plugin, [configure the task’s classpath to include the `developmentOnly` configuration](../../gradle-plugin/packaging.html#packaging-executable.configuring.including-development-only-dependencies). | ### [](#features.dev-services.docker-compose.prerequisites)Prerequisites You need to have the `docker` and `docker compose` (or `docker-compose`) CLI applications on your path. The minimum supported Docker Compose version is 2.2.0. ### [](#features.dev-services.docker-compose.service-connections)Service Connections A service connection is a connection to any remote service. Spring Boot’s auto-configuration can consume the details of a service connection and use them to establish a connection to a remote service. When doing so, the connection details take precedence over any connection-related configuration properties. When using Spring Boot’s Docker Compose support, service connections are established to the port mapped by the container. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Docker compose is usually used in such a way that the ports inside the container are mapped to ephemeral ports on your computer. For example, a Postgres server may run inside the container using port 5432 but be mapped to a totally different port locally. The service connection will always discover and use the locally mapped port. | Service connections are established by using the image name of the container. The following service connections are currently supported: | Connection Details | Matched on | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | [`ActiveMQConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/activemq/autoconfigure/ActiveMQConnectionDetails.html) | Containers named "symptoma/activemq", "apache/activemq-classic" or "apache/activemq" | | [`ArtemisConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/artemis/autoconfigure/ArtemisConnectionDetails.html) | Containers named "apache/activemq-artemis" or "apache/artemis" | | [`CassandraConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/cassandra/autoconfigure/CassandraConnectionDetails.html) | Containers named "cassandra" | | [`ElasticsearchConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/elasticsearch/autoconfigure/ElasticsearchConnectionDetails.html) | Containers named "elasticsearch" or "elasticsearch/elasticsearch" | | [`HazelcastConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/hazelcast/autoconfigure/HazelcastConnectionDetails.html) | Containers named "hazelcast/hazelcast". | | [`JdbcConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/autoconfigure/JdbcConnectionDetails.html) | Containers named "clickhouse/clickhouse-server", "gvenzl/oracle-free", "gvenzl/oracle-xe", "mariadb", "mssql/server", "mysql", or "postgres" | | [`LdapConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ldap/autoconfigure/LdapConnectionDetails.html) | Containers named "osixia/openldap", "lldap/lldap" | | [`MongoConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/mongodb/autoconfigure/MongoConnectionDetails.html) | Containers named "mongo" | | [`Neo4jConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/neo4j/autoconfigure/Neo4jConnectionDetails.html) | Containers named "neo4j" | | [`OtlpLoggingConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/opentelemetry/autoconfigure/logging/otlp/OtlpLoggingConnectionDetails.html) | Containers named "otel/opentelemetry-collector-contrib", "grafana/otel-lgtm" | | [`OtlpMetricsConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/metrics/autoconfigure/export/otlp/OtlpMetricsConnectionDetails.html) | Containers named "otel/opentelemetry-collector-contrib", "grafana/otel-lgtm" | | [`OtlpTracingConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/tracing/opentelemetry/autoconfigure/otlp/OtlpTracingConnectionDetails.html) | Containers named "otel/opentelemetry-collector-contrib", "grafana/otel-lgtm" | | [`PulsarConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/pulsar/autoconfigure/PulsarConnectionDetails.html) | Containers named "apachepulsar/pulsar" | | [`R2dbcConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/r2dbc/autoconfigure/R2dbcConnectionDetails.html) | Containers named "clickhouse/clickhouse-server", "gvenzl/oracle-free", "gvenzl/oracle-xe", "mariadb", "mssql/server", "mysql", or "postgres" | | [`RabbitConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/amqp/autoconfigure/RabbitConnectionDetails.html) | Containers named "rabbitmq" with container port 5672 mapped | | [`RabbitStreamConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/amqp/autoconfigure/RabbitStreamConnectionDetails.html) | Containers named "rabbitmq" with container port 5552 mapped, or port 5551 mapped when SSL is configured | | [`DataRedisConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/redis/autoconfigure/DataRedisConnectionDetails.html) | Containers named "redis", "redis/redis-stack" or "redis/redis-stack-server" | | [`ZipkinConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/zipkin/autoconfigure/ZipkinConnectionDetails.html) | Containers named "openzipkin/zipkin". | ### [](#features.dev-services.docker-compose.ssl)SSL support Some images come with SSL enabled out of the box, or maybe you want to enable SSL for the container to mirror your production setup. Spring Boot supports SSL configuration for supported service connections. Please note that you still have to enable SSL on the service which is running inside the container yourself, this feature only configures SSL on the client side in your application. SSL is supported for the following service connections: * Cassandra * Elasticsearch * MongoDB * OpenTelemetry (OTLP logging, metrics, and tracing) * RabbitMQ * RabbitMQ Streams * Redis To enable SSL support for a service, you can use [service labels](https://docs.docker.com/reference/compose-file/services/#labels). For JKS based keystores and truststores, you can use the following container labels: * `org.springframework.boot.sslbundle.jks.key.alias` * `org.springframework.boot.sslbundle.jks.key.password` * `org.springframework.boot.sslbundle.jks.options.ciphers` * `org.springframework.boot.sslbundle.jks.options.enabled-protocols` * `org.springframework.boot.sslbundle.jks.protocol` * `org.springframework.boot.sslbundle.jks.keystore.type` * `org.springframework.boot.sslbundle.jks.keystore.provider` * `org.springframework.boot.sslbundle.jks.keystore.location` * `org.springframework.boot.sslbundle.jks.keystore.password` * `org.springframework.boot.sslbundle.jks.truststore.type` * `org.springframework.boot.sslbundle.jks.truststore.provider` * `org.springframework.boot.sslbundle.jks.truststore.location` * `org.springframework.boot.sslbundle.jks.truststore.password` These labels mirror the properties available for [SSL bundles](ssl.html#features.ssl.jks). For PEM based keystores and truststores, you can use the following container labels: * `org.springframework.boot.sslbundle.pem.key.alias` * `org.springframework.boot.sslbundle.pem.key.password` * `org.springframework.boot.sslbundle.pem.options.ciphers` * `org.springframework.boot.sslbundle.pem.options.enabled-protocols` * `org.springframework.boot.sslbundle.pem.protocol` * `org.springframework.boot.sslbundle.pem.keystore.type` * `org.springframework.boot.sslbundle.pem.keystore.certificate` * `org.springframework.boot.sslbundle.pem.keystore.private-key` * `org.springframework.boot.sslbundle.pem.keystore.private-key-password` * `org.springframework.boot.sslbundle.pem.truststore.type` * `org.springframework.boot.sslbundle.pem.truststore.certificate` * `org.springframework.boot.sslbundle.pem.truststore.private-key` * `org.springframework.boot.sslbundle.pem.truststore.private-key-password` These labels mirror the properties available for [SSL bundles](ssl.html#features.ssl.pem). The following example enables SSL for a redis container: ```yaml services: redis: image: 'redis:latest' ports: - '6379' secrets: - ssl-ca - ssl-key - ssl-cert command: 'redis-server --tls-port 6379 --port 0 --tls-cert-file /run/secrets/ssl-cert --tls-key-file /run/secrets/ssl-key --tls-ca-cert-file /run/secrets/ssl-ca' labels: - 'org.springframework.boot.sslbundle.pem.keystore.certificate=client.crt' - 'org.springframework.boot.sslbundle.pem.keystore.private-key=client.key' - 'org.springframework.boot.sslbundle.pem.truststore.certificate=ca.crt' secrets: ssl-ca: file: 'ca.crt' ssl-key: file: 'server.key' ssl-cert: file: 'server.crt' ``` ### [](#features.dev-services.docker-compose.custom-images)Custom Images Sometimes you may need to use your own version of an image to provide a service. You can use any custom image as long as it behaves in the same way as the standard image. Specifically, any environment variables that the standard image supports must also be used in your custom image. If your image uses a different name, you can use a label in your `compose.yml` file so that Spring Boot can provide a service connection. Use a label named `org.springframework.boot.service-connection` to provide the service name. For example: ```yaml services: redis: image: 'mycompany/mycustomredis:7.0' ports: - '6379' labels: org.springframework.boot.service-connection: redis ``` ### [](#features.dev-services.docker-compose.skipping)Skipping Specific Containers If you have a container image defined in your `compose.yml` that you don’t want connected to your application you can use a label to ignore it. Any container with labeled with `org.springframework.boot.ignore` will be ignored by Spring Boot. For example: ```yaml services: redis: image: 'redis:7.0' ports: - '6379' labels: org.springframework.boot.ignore: true ``` ### [](#features.dev-services.docker-compose.specific-file)Using a Specific Compose File If your compose file is not in the same directory as your application, or if it’s named differently, you can use `spring.docker.compose.file` in your `application.properties` or `application.yaml` to point to a different file. Properties can be defined as an exact path or a path that’s relative to your application. For example: * Properties * YAML ```properties spring.docker.compose.file=../my-compose.yml ``` ```yaml spring: docker: compose: file: "../my-compose.yml" ``` ### [](#features.dev-services.docker-compose.readiness)Waiting for Container Readiness Containers started by Docker Compose may take some time to become fully ready. The recommended way of checking for readiness is to add a `healthcheck` section under the service definition in your `compose.yml` file. Since it’s not uncommon for `healthcheck` configuration to be omitted from `compose.yml` files, Spring Boot also checks directly for service readiness. By default, a container is considered ready when a TCP/IP connection can be established to its mapped port. You can disable this on a per-container basis by adding a `org.springframework.boot.readiness-check.tcp.disable` label in your `compose.yml` file. For example: ```yaml services: redis: image: 'redis:7.0' ports: - '6379' labels: org.springframework.boot.readiness-check.tcp.disable: true ``` You can also change timeout values in your `application.properties` or `application.yaml` file: * Properties * YAML ```properties spring.docker.compose.readiness.tcp.connect-timeout=10s spring.docker.compose.readiness.tcp.read-timeout=5s ``` ```yaml spring: docker: compose: readiness: tcp: connect-timeout: 10s read-timeout: 5s ``` The overall timeout can be configured using `spring.docker.compose.readiness.timeout`. ### [](#features.dev-services.docker-compose.lifecycle)Controlling the Docker Compose Lifecycle By default Spring Boot calls `docker compose up` when your application starts and `docker compose stop` when it’s shut down. If you prefer to have different lifecycle management you can use the `spring.docker.compose.lifecycle-management` property. The following values are supported: * `none` - Do not start or stop Docker Compose * `start-only` - Start Docker Compose when the application starts and leave it running * `start-and-stop` - Start Docker Compose when the application starts and stop it when the JVM exits In addition you can use the `spring.docker.compose.start.command` property to change whether `docker compose up` or `docker compose start` is used. The `spring.docker.compose.stop.command` allows you to configure if `docker compose down` or `docker compose stop` is used. You can also pass additional arguments to Docker Compose commands. The `spring.docker.compose.arguments` property allows you to specify arguments that are passed to all Docker Compose commands. The `spring.docker.compose.start.arguments` property allows you to specify arguments that are passed only to the up (or start) command, while the `spring.docker.compose.stop.arguments` property allows you to specify arguments that are passed only to the down (or stop) command. The following example shows how lifecycle management can be configured: * Properties * YAML ```properties spring.docker.compose.lifecycle-management=start-and-stop spring.docker.compose.arguments[0]=--project-name=myapp spring.docker.compose.arguments[1]=--progress=auto spring.docker.compose.start.command=up spring.docker.compose.start.arguments[0]=--build spring.docker.compose.start.arguments[1]=--force-recreate spring.docker.compose.stop.command=down spring.docker.compose.stop.timeout=1m spring.docker.compose.stop.arguments[0]=--volumes spring.docker.compose.stop.arguments[1]=--remove-orphans ``` ```yaml spring: docker: compose: lifecycle-management: start-and-stop arguments: - "--project-name=myapp" - "--progress=auto" start: command: up arguments: - "--build" - "--force-recreate" stop: command: down timeout: 1m arguments: - "--volumes" - "--remove-orphans" ``` ### [](#features.dev-services.docker-compose.profiles)Activating Docker Compose Profiles Docker Compose profiles are similar to Spring profiles in that they let you adjust your Docker Compose configuration for specific environments. If you want to activate a specific Docker Compose profile you can use the `spring.docker.compose.profiles.active` property in your `application.properties` or `application.yaml` file: * Properties * YAML ```properties spring.docker.compose.profiles.active=myprofile ``` ```yaml spring: docker: compose: profiles: active: "myprofile" ``` ### [](#features.dev-services.docker-compose.tests)Using Docker Compose in Tests By default, Spring Boot’s Docker Compose support is disabled when running tests. To enable Docker Compose support in tests, set `spring.docker.compose.skip.in-tests` to `false`. When using Gradle, you also need to change the configuration of the `spring-boot-docker-compose` dependency from `developmentOnly` to `testAndDevelopmentOnly`: Gradle ```gradle dependencies { testAndDevelopmentOnly("org.springframework.boot:spring-boot-docker-compose") } ``` ## [](#features.dev-services.testcontainers)Testcontainers Support As well as [using Testcontainers for integration testing](../testing/testcontainers.html#testing.testcontainers), it’s also possible to use them at development time. The next sections will provide more details about that. ### [](#features.dev-services.testcontainers.at-development-time)Using Testcontainers at Development Time This approach allows developers to quickly start containers for the services that the application depends on, removing the need to manually provision things like database servers. Using Testcontainers in this way provides functionality similar to Docker Compose, except that your container configuration is in Java rather than YAML. To use Testcontainers at development time you need to launch your application using your “test” classpath rather than “main”. This will allow you to access all declared test dependencies and give you a natural place to write your test configuration. To create a test launchable version of your application you should create an “Application” class in the `src/test` directory. For example, if your main application is in `src/main/java/com/example/MyApplication.java`, you should create `src/test/java/com/example/TestMyApplication.java` The `TestMyApplication` class can use the `SpringApplication.from(…​)` method to launch the real application: * Java * Kotlin ```java import org.springframework.boot.SpringApplication; public class TestMyApplication { public static void main(String[] args) { SpringApplication.from(MyApplication::main).run(args); } } ``` ```kotlin import org.springframework.boot.fromApplication fun main(args: Array) { fromApplication().run(*args) } ``` You’ll also need to define the [`Container`](https://javadoc.io/doc/org.testcontainers/testcontainers/2.0.5/org/testcontainers/containers/Container.html) instances that you want to start along with your application. To do this, you need to make sure that the `spring-boot-testcontainers` module has been added as a `test` dependency. Once that has been done, you can create a [`@TestConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/TestConfiguration.html) class that declares [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) methods for the containers you want to start. You can also annotate your [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) methods with [`@ServiceConnection`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/service/connection/ServiceConnection.html) in order to create [`ConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/service/connection/ConnectionDetails.html) beans. See [the service connections](../testing/testcontainers.html#testing.testcontainers.service-connections) section for details of the supported technologies. A typical Testcontainers configuration would look like this: * Java * Kotlin ```java import org.testcontainers.neo4j.Neo4jContainer; import org.springframework.boot.test.context.TestConfiguration; import org.springframework.boot.testcontainers.service.connection.ServiceConnection; import org.springframework.context.annotation.Bean; @TestConfiguration(proxyBeanMethods = false) public class MyContainersConfiguration { @Bean @ServiceConnection public Neo4jContainer neo4jContainer() { return new Neo4jContainer("neo4j:5"); } } ``` ```kotlin import org.springframework.boot.test.context.TestConfiguration import org.springframework.boot.testcontainers.service.connection.ServiceConnection import org.springframework.context.annotation.Bean import org.testcontainers.neo4j.Neo4jContainer @TestConfiguration(proxyBeanMethods = false) class MyContainersConfiguration { @Bean @ServiceConnection fun neo4jContainer(): Neo4jContainer { return Neo4jContainer("neo4j:5") } } ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | The lifecycle of [`Container`](https://javadoc.io/doc/org.testcontainers/testcontainers/2.0.5/org/testcontainers/containers/Container.html) beans is automatically managed by Spring Boot. Containers will be started and stopped automatically. | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can use the `spring.testcontainers.beans.startup` property to change how containers are started. By default `sequential` startup is used, but you may also choose `parallel` if you wish to start multiple containers in parallel. | Once you have defined your test configuration, you can use the `with(…​)` method to attach it to your test launcher: * Java * Kotlin ```java import org.springframework.boot.SpringApplication; public class TestMyApplication { public static void main(String[] args) { SpringApplication.from(MyApplication::main).with(MyContainersConfiguration.class).run(args); } } ``` ```kotlin import org.springframework.boot.fromApplication import org.springframework.boot.with fun main(args: Array) { fromApplication().with(MyContainersConfiguration::class).run(*args) } ``` You can now launch `TestMyApplication` as you would any regular Java `main` method application to start your application and the containers that it needs to run. | | | | -- | -------------------------------------------------------------------------------------------------------------------- | | ** | You can use the Maven goal `spring-boot:test-run` or the Gradle task `bootTestRun` to do this from the command line. | #### [](#features.dev-services.testcontainers.at-development-time.dynamic-properties)Contributing Dynamic Properties at Development Time If you want to contribute dynamic properties at development time from your [`Container`](https://javadoc.io/doc/org.testcontainers/testcontainers/2.0.5/org/testcontainers/containers/Container.html) [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) methods, define an additional [`DynamicPropertyRegistrar`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/context/DynamicPropertyRegistrar.html) bean. The registrar should be defined using a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) method that injects the container from which the properties will be sourced as a parameter. This arrangement ensures that container has been started before the properties are used. A typical configuration would look like this: * Java * Kotlin ```java import org.testcontainers.mongodb.MongoDBContainer; import org.springframework.boot.test.context.TestConfiguration; import org.springframework.context.annotation.Bean; import org.springframework.test.context.DynamicPropertyRegistrar; @TestConfiguration(proxyBeanMethods = false) public class MyContainersConfiguration { @Bean public MongoDBContainer mongoDbContainer() { return new MongoDBContainer("mongo:5.0"); } @Bean public DynamicPropertyRegistrar mongoDbProperties(MongoDBContainer container) { return (properties) -> { properties.add("spring.mongodb.host", container::getHost); properties.add("spring.mongodb.port", container::getFirstMappedPort); }; } } ``` ```kotlin import org.springframework.boot.test.context.TestConfiguration import org.springframework.context.annotation.Bean import org.springframework.test.context.DynamicPropertyRegistrar; import org.testcontainers.mongodb.MongoDBContainer @TestConfiguration(proxyBeanMethods = false) class MyContainersConfiguration { @Bean fun mongoDbContainer(): MongoDBContainer { return MongoDBContainer("mongo:5.0") } @Bean fun mongoDbProperties(container: MongoDBContainer): DynamicPropertyRegistrar { return DynamicPropertyRegistrar { properties -> properties.add("spring.mongodb.host") { container.host } properties.add("spring.mongodb.port") { container.firstMappedPort } } } } ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Using a [`@ServiceConnection`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/service/connection/ServiceConnection.html) is recommended whenever possible, however, dynamic properties can be a useful fallback for technologies that don’t yet have [`@ServiceConnection`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/service/connection/ServiceConnection.html) support. | #### [](#features.dev-services.testcontainers.at-development-time.importing-container-declarations)Importing Testcontainers Declaration Classes A common pattern when using Testcontainers is to declare [`Container`](https://javadoc.io/doc/org.testcontainers/testcontainers/2.0.5/org/testcontainers/containers/Container.html) instances as static fields. Often these fields are defined directly on the test class. They can also be declared on a parent class or on an interface that the test implements. For example, the following `MyContainers` interface declares `mongo` and `neo4j` containers: * Java * Kotlin ```java import org.testcontainers.junit.jupiter.Container; import org.testcontainers.mongodb.MongoDBContainer; import org.testcontainers.neo4j.Neo4jContainer; import org.springframework.boot.testcontainers.service.connection.ServiceConnection; public interface MyContainers { @Container @ServiceConnection MongoDBContainer mongoContainer = new MongoDBContainer("mongo:5.0"); @Container @ServiceConnection Neo4jContainer neo4jContainer = new Neo4jContainer("neo4j:5"); } ``` ```kotlin import org.springframework.boot.testcontainers.service.connection.ServiceConnection import org.testcontainers.junit.jupiter.Container import org.testcontainers.mongodb.MongoDBContainer import org.testcontainers.neo4j.Neo4jContainer interface MyContainers { companion object { @Container @ServiceConnection @JvmField val mongoContainer = MongoDBContainer("mongo:5.0") @Container @ServiceConnection @JvmField val neo4jContainer = Neo4jContainer("neo4j:5") } } ``` If you already have containers defined in this way, or you just prefer this style, you can import these declaration classes rather than defining your containers as [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) methods. To do so, add the [`@ImportTestcontainers`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/context/ImportTestcontainers.html) annotation to your test configuration class: * Java * Kotlin ```java import org.springframework.boot.test.context.TestConfiguration; import org.springframework.boot.testcontainers.context.ImportTestcontainers; @TestConfiguration(proxyBeanMethods = false) @ImportTestcontainers(MyContainers.class) public class MyContainersConfiguration { } ``` ```kotlin import org.springframework.boot.test.context.TestConfiguration import org.springframework.boot.testcontainers.context.ImportTestcontainers @TestConfiguration(proxyBeanMethods = false) @ImportTestcontainers(MyContainers::class) class MyContainersConfiguration ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | If you don’t intend to use the [service connections feature](../testing/testcontainers.html#testing.testcontainers.service-connections) but want to use [`@DynamicPropertySource`](../testing/testcontainers.html#testing.testcontainers.dynamic-properties) instead, remove the [`@ServiceConnection`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/service/connection/ServiceConnection.html) annotation from the [`Container`](https://javadoc.io/doc/org.testcontainers/testcontainers/2.0.5/org/testcontainers/containers/Container.html) fields. You can also add [`@DynamicPropertySource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/context/DynamicPropertySource.html) annotated methods to your declaration class. | #### [](#features.dev-services.testcontainers.at-development-time.devtools)Using DevTools with Testcontainers at Development Time When using devtools, you can annotate beans and bean methods with [`@RestartScope`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/devtools/restart/RestartScope.html). Such beans won’t be recreated when the devtools restart the application. This is especially useful for [`Container`](https://javadoc.io/doc/org.testcontainers/testcontainers/2.0.5/org/testcontainers/containers/Container.html) beans, as they keep their state despite the application restart. * Java * Kotlin ```java import org.testcontainers.mongodb.MongoDBContainer; import org.springframework.boot.devtools.restart.RestartScope; import org.springframework.boot.test.context.TestConfiguration; import org.springframework.boot.testcontainers.service.connection.ServiceConnection; import org.springframework.context.annotation.Bean; @TestConfiguration(proxyBeanMethods = false) public class MyContainersConfiguration { @Bean @RestartScope @ServiceConnection public MongoDBContainer mongoDbContainer() { return new MongoDBContainer("mongo:5.0"); } } ``` ```kotlin import org.springframework.boot.devtools.restart.RestartScope import org.springframework.boot.test.context.TestConfiguration import org.springframework.boot.testcontainers.service.connection.ServiceConnection import org.springframework.context.annotation.Bean import org.testcontainers.mongodb.MongoDBContainer @TestConfiguration(proxyBeanMethods = false) class MyContainersConfiguration { @Bean @RestartScope @ServiceConnection fun mongoDbContainer(): MongoDBContainer { return MongoDBContainer("mongo:5.0") } } ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you’re using Gradle and want to use this feature, you need to change the configuration of the `spring-boot-devtools` dependency from `developmentOnly` to `testAndDevelopmentOnly`. With the default scope of `developmentOnly`, the `bootTestRun` task will not pick up changes in your code, as the devtools are not active. | * [Spring Boot](../../index.html) * [4.1.1](dev-services.html) * [4.0.8](../../4.0/reference/features/dev-services.html) * [3.5.16](../../3.5/reference/features/dev-services.html) * [3.4.13](../../3.4/reference/features/dev-services.html) * [3.3.13](../../3.3/reference/features/dev-services.html) - [4.2.0-M2](../../4.2/reference/features/dev-services.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/features/dev-services.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/features/dev-services.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/features/dev-services.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/packaging/native-image/introducing-graalvm-native-images.html ---- # Introducing GraalVM Native Images GraalVM Native Images provide a new way to deploy and run Java applications. Compared to the Java Virtual Machine, native images can run with a smaller memory footprint and with much faster startup times. They are well suited to applications that are deployed using container images and are especially interesting when combined with "Function as a service" (FaaS) platforms. Unlike traditional applications written for the JVM, GraalVM Native Image applications require ahead-of-time processing in order to create an executable. This ahead-of-time processing involves statically analyzing your application code from its main entry point. A GraalVM Native Image is a complete, platform-specific executable. You do not need to ship a Java Virtual Machine in order to run a native image. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you just want to get started and experiment with GraalVM you can jump to the [Developing Your First GraalVM Native Application](../../../how-to/native-image/developing-your-first-application.html) section and return to this section later. | ## [](#packaging.native-image.introducing-graalvm-native-images.key-differences-with-jvm-deployments)Key Differences with JVM Deployments The fact that GraalVM Native Images are produced ahead-of-time means that there are some key differences between native and JVM based applications. The main differences are: * Static analysis of your application is performed at build-time from the `main` entry point. * Code that cannot be reached when the native image is created will be removed and won’t be part of the executable. * GraalVM is not directly aware of dynamic elements of your code and must be told about reflection, resources, serialization, and dynamic proxies. * The application classpath is fixed at build time and cannot change. * There is no lazy class loading, everything shipped in the executables will be loaded in memory on startup. * There are some limitations around some aspects of Java applications that are not fully supported. On top of those differences, Spring uses a process called [Spring Ahead-of-Time processing](#packaging.native-image.introducing-graalvm-native-images.understanding-aot-processing), which imposes further limitations. Please make sure to read at least the beginning of the next section to learn about those. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | The [Native Image Compatibility Guide](https://www.graalvm.org/25/reference-manual/native-image/metadata/Compatibility/) section of the GraalVM reference documentation provides more details about GraalVM limitations. | ## [](#packaging.native-image.introducing-graalvm-native-images.understanding-aot-processing)Understanding Spring Ahead-of-Time Processing Typical Spring Boot applications are quite dynamic and configuration is performed at runtime. In fact, the concept of Spring Boot auto-configuration depends heavily on reacting to the state of the runtime in order to configure things correctly. Although it would be possible to tell GraalVM about these dynamic aspects of the application, doing so would undo most of the benefit of static analysis. So instead, when using Spring Boot to create native images, a closed-world is assumed and the dynamic aspects of the application are restricted. A closed-world assumption implies, besides [the limitations created by GraalVM itself](#packaging.native-image.introducing-graalvm-native-images.key-differences-with-jvm-deployments), the following restrictions: * The beans defined in your application cannot change at runtime, meaning: * The Spring [`@Profile`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Profile.html) annotation and profile-specific configuration [have limitations](../../../how-to/aot.html#howto.aot.conditions). * Properties that change if a bean is created are not supported (for example, [`@ConditionalOnProperty`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnProperty.html) and `.enabled` properties). When these restrictions are in place, it becomes possible for Spring to perform ahead-of-time processing during build-time and generate additional assets that GraalVM can use. A Spring AOT processed application will typically generate: * Java source code * Bytecode (for dynamic proxies, etc.) * GraalVM JSON hint files in `META-INF/native-image/{groupId}/{artifactId}/`: * Resource hints (`resource-config.json`) * Reflection hints (`reflect-config.json`) * Serialization hints (`serialization-config.json`) * Java Proxy Hints (`proxy-config.json`) * JNI Hints (`jni-config.json`) If the generated hints are not sufficient, you can also [provide your own](advanced-topics.html#packaging.native-image.advanced.custom-hints). ### [](#packaging.native-image.introducing-graalvm-native-images.understanding-aot-processing.source-code-generation)Source Code Generation Spring applications are composed of Spring Beans. Internally, Spring Framework uses two distinct concepts to manage beans. There are bean instances, which are the actual instances that have been created and can be injected into other beans. There are also bean definitions which are used to define attributes of a bean and how its instance should be created. If we take a typical [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class: ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyConfiguration { @Bean public MyBean myBean() { return new MyBean(); } } ``` The bean definition is created by parsing the [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class and finding the [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) methods. In the above example, we’re defining a [`BeanDefinition`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/config/BeanDefinition.html) for a singleton bean named `myBean`. We’re also creating a [`BeanDefinition`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/config/BeanDefinition.html) for the `MyConfiguration` class itself. When the `myBean` instance is required, Spring knows that it must invoke the `myBean()` method and use the result. When running on the JVM, [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class parsing happens when your application starts and [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) methods are invoked using reflection. When creating a native image, Spring operates in a different way. Rather than parsing [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) classes and generating bean definitions at runtime, it does it at build-time. Once the bean definitions have been discovered, they are processed and converted into source code that can be analyzed by the GraalVM compiler. The Spring AOT process would convert the configuration class above to code like this: ```java import org.springframework.beans.factory.aot.BeanInstanceSupplier; import org.springframework.beans.factory.config.BeanDefinition; import org.springframework.beans.factory.support.RootBeanDefinition; /** * Bean definitions for {@link MyConfiguration}. */ public class MyConfiguration__BeanDefinitions { /** * Get the bean definition for 'myConfiguration'. */ public static BeanDefinition getMyConfigurationBeanDefinition() { Class beanType = MyConfiguration.class; RootBeanDefinition beanDefinition = new RootBeanDefinition(beanType); beanDefinition.setInstanceSupplier(MyConfiguration::new); return beanDefinition; } /** * Get the bean instance supplier for 'myBean'. */ private static BeanInstanceSupplier getMyBeanInstanceSupplier() { return BeanInstanceSupplier.forFactoryMethod(MyConfiguration.class, "myBean") .withGenerator((registeredBean) -> registeredBean.getBeanFactory().getBean(MyConfiguration.class).myBean()); } /** * Get the bean definition for 'myBean'. */ public static BeanDefinition getMyBeanBeanDefinition() { Class beanType = MyBean.class; RootBeanDefinition beanDefinition = new RootBeanDefinition(beanType); beanDefinition.setInstanceSupplier(getMyBeanInstanceSupplier()); return beanDefinition; } } ``` | | | | -- | ------------------------------------------------------------------------------------- | | ** | The exact code generated may differ depending on the nature of your bean definitions. | You can see above that the generated code creates equivalent bean definitions to the [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class, but in a direct way that can be understood by GraalVM. There is a bean definition for the `myConfiguration` bean, and one for `myBean`. When a `myBean` instance is required, a [`BeanInstanceSupplier`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/aot/BeanInstanceSupplier.html) is called. This supplier will invoke the `myBean()` method on the `myConfiguration` bean. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | During Spring AOT processing, your application is started up to the point that bean definitions are available. Bean instances are not created during the AOT processing phase. | Spring AOT will generate code like this for all your bean definitions. It will also generate code when bean post-processing is required (for example, to call [`@Autowired`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Autowired.html) methods). An [`ApplicationContextInitializer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContextInitializer.html) will also be generated which will be used by Spring Boot to initialize the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) when an AOT processed application is actually run. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Although AOT generated source code can be verbose, it is quite readable and can be helpful when debugging an application. Generated source files can be found in `target/spring-aot/main/sources` when using Maven and `build/generated/aotSources` with Gradle. | ### [](#packaging.native-image.introducing-graalvm-native-images.understanding-aot-processing.hint-file-generation)Hint File Generation In addition to generating source files, the Spring AOT engine will also generate hint files that are used by GraalVM. Hint files contain JSON data that describes how GraalVM should deal with things that it can’t understand by directly inspecting the code. For example, you might be using a Spring annotation on a private method. Spring will need to use reflection in order to invoke private methods, even on GraalVM. When such situations arise, Spring can write a reflection hint so that GraalVM knows that even though the private method isn’t called directly, it still needs to be available in the native image. Hint files are generated under `META-INF/native-image` where they are automatically picked up by GraalVM. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------- | | ** | Generated hint files can be found in `target/spring-aot/main/resources` when using Maven and `build/generated/aotResources` with Gradle. | ### [](#packaging.native-image.introducing-graalvm-native-images.understanding-aot-processing.proxy-class-generation)Proxy Class Generation Spring sometimes needs to generate proxy classes to enhance the code you’ve written with additional features. To do this, it uses the cglib library which directly generates bytecode. When an application is running on the JVM, proxy classes are generated dynamically as the application runs. When creating a native image, these proxies need to be created at build-time so that they can be included by GraalVM. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Unlike source code generation, generated bytecode isn’t particularly helpful when debugging an application. However, if you need to inspect the contents of the `.class` files using a tool such as `javap` you can find them in `target/spring-aot/main/classes` for Maven and `build/generated/aotClasses` for Gradle. | * [Spring Boot](../../../index.html) * [4.1.1](introducing-graalvm-native-images.html) * [4.0.8](../../../4.0/reference/packaging/native-image/introducing-graalvm-native-images.html) * [3.5.16](../../../3.5/reference/packaging/native-image/introducing-graalvm-native-images.html) * [3.4.13](../../../3.4/reference/packaging/native-image/introducing-graalvm-native-images.html) * [3.3.13](../../../3.3/reference/packaging/native-image/introducing-graalvm-native-images.html) - [4.2.0-M2](../../../4.2/reference/packaging/native-image/introducing-graalvm-native-images.html) * [4.2.0-SNAPSHOT](../../../4.2-SNAPSHOT/reference/packaging/native-image/introducing-graalvm-native-images.html) * [4.1.3-SNAPSHOT](../../../4.1-SNAPSHOT/reference/packaging/native-image/introducing-graalvm-native-images.html) * [4.0.10-SNAPSHOT](../../../4.0-SNAPSHOT/reference/packaging/native-image/introducing-graalvm-native-images.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html ---- # Class BuildInfo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.gradle.api.internal.AbstractTask [org.gradle.api.DefaultTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/DefaultTask.html "class or interface in org.gradle.api") org.springframework.boot.gradle.tasks.buildinfo.BuildInfo * All Implemented Interfaces: `Comparable, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Task, Configurable` *** [@DisableCachingByDefault](https://docs.gradle.org/9.7.0/javadoc/org/gradle/work/DisableCachingByDefault.html "class or interface in org.gradle.work")([because](https://docs.gradle.org/9.7.0/javadoc/org/gradle/work/DisableCachingByDefault.html#because\(\) "class or interface in org.gradle.work")="Not worth caching") public abstract class BuildInfo extends [DefaultTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/DefaultTask.html "class or interface in org.gradle.api") [`Task`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") for generating a build info properties file from [`BuildInfoProperties`](BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo"). `BuildInfo()`   - ## Method Summary Modifier and Type Method Description `void` `generateBuildProperties()` Generates the build info properties file in the configured [`destination dir`](#getDestinationDir\(\)). `abstract DirectoryProperty` `getDestinationDir()` Returns the directory to which the build info file will be written. `abstract SetProperty` `getExcludes()` Returns the names of the properties to exclude from the output. `abstract Property` `getFilename()` Returns the name of the file that is written to the [`destination dir`](#getDestinationDir\(\)). `BuildInfoProperties` `getProperties()` Returns the [`properties`](BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") that will be included in the written file. `void` `properties(Action action)` Executes the given `action` on the [`getProperties()`](#getProperties\(\)) properties. * ### BuildInfo public BuildInfo() * ## Method Details * ### getExcludes [@Internal](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Internal.html "class or interface in org.gradle.api.tasks") public abstract [SetProperty](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/SetProperty.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getExcludes() Returns the names of the properties to exclude from the output. * Returns: names of the properties to exclude * Since: 3.0.0 * ### getFilename [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getFilename() Returns the name of the file that is written to the [`destination dir`](#getDestinationDir\(\)). Convention is `META-INF/build-info.properties`. * Returns: the name of the written file * Since: 4.1.0 * ### generateBuildProperties public void generateBuildProperties() Generates the build info properties file in the configured [`destination dir`](#getDestinationDir\(\)). * ### getDestinationDir [@OutputDirectory](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/OutputDirectory.html "class or interface in org.gradle.api.tasks") public abstract [DirectoryProperty](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/DirectoryProperty.html "class or interface in org.gradle.api.file") getDestinationDir() Returns the directory to which the build info file will be written. Convention is `build/${taskName}`. * Returns: the destination directory * ### getProperties public [BuildInfoProperties](BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") getProperties() Returns the [`properties`](BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") that will be included in the written file. * Returns: the properties * ### properties public void properties​([Action](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Action.html "class or interface in org.gradle.api")<[BuildInfoProperties](BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo")> action) Executes the given `action` on the [`getProperties()`](#getProperties\(\)) properties. * Parameters: `action` - the action ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/Image.html ---- Uses of Class\ org.springframework.boot.maven.Image ==================================== No usage of org.springframework.boot.maven.Image ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/ProcessTestAotMojo.html ---- # Class ProcessTestAotMojo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.plugin.AbstractMojo [org.springframework.boot.maven.AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") [org.springframework.boot.maven.AbstractAotMojo](AbstractAotMojo.html "class in org.springframework.boot.maven") org.springframework.boot.maven.ProcessTestAotMojo * All Implemented Interfaces: `org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo` *** @Mojo(name="process-test-aot", defaultPhase=PROCESS\_TEST\_CLASSES, threadSafe=true, requiresDependencyResolution=TEST, requiresDependencyCollection=TEST) public class ProcessTestAotMojo extends [AbstractAotMojo](AbstractAotMojo.html "class in org.springframework.boot.maven") Invoke the AOT engine on tests. * Since: 3.0.0 * Author: Phillip Webb `ProcessTestAotMojo(org.apache.maven.toolchain.ToolchainManager toolchainManager, org.eclipse.aether.RepositorySystem repositorySystem)`   - ## Method Summary Modifier and Type Method Description `protected void` `executeAot()`   `protected URL[]` `getClassPath(boolean includeJUnitPlatformLauncher)` * ### ProcessTestAotMojo @Inject public ProcessTestAotMojo​(org.apache.maven.toolchain.ToolchainManager toolchainManager, org.eclipse.aether.RepositorySystem repositorySystem) * ## Method Details * ### executeAot protected void executeAot() throws [Exception](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html "class or interface in java.lang") * Specified by: `executeAot` in class `AbstractAotMojo` * Throws: `Exception` * ### getClassPath protected [URL](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html "class or interface in java.net")\[] getClassPath​(boolean includeJUnitPlatformLauncher) throws [Exception](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html "class or interface in java.lang") * Throws: `Exception` ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/util/class-use/VersionExtractor.html ---- Uses of Class\ org.springframework.boot.gradle.util.VersionExtractor ===================================================== No usage of org.springframework.boot.gradle.util.VersionExtractor ---- url: https://docs.spring.io/spring-boot/installing.html ---- # Installing Spring Boot Spring Boot can be used with “classic” Java development tools or installed as a command line tool. Either way, you need [Java SDK v17](https://www.java.com) or higher. Before you begin, you should check your current Java installation by using the following command: ```shell $ java -version ``` If you are new to Java development or if you want to experiment with Spring Boot, you might want to try the [Spring Boot CLI](#getting-started.installing.cli) (Command Line Interface) first. Otherwise, read on for “classic” installation instructions. ## [](#getting-started.installing.java)Installation Instructions for the Java Developer You can use Spring Boot in the same way as any standard Java library. To do so, include the appropriate `spring-boot-*.jar` files on your classpath. Spring Boot does not require any special tools integration, so you can use any IDE or text editor. Also, there is nothing special about a Spring Boot application, so you can run and debug a Spring Boot application as you would any other Java program. Although you *could* copy Spring Boot jars, we generally recommend that you use a build tool that supports dependency management (such as Maven or Gradle). ### [](#getting-started.installing.java.maven)Maven Installation Spring Boot is compatible with Apache Maven 3.6.3 or later. If you do not already have Maven installed, you can follow the instructions at [maven.apache.org](https://maven.apache.org). | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | On many operating systems, Maven can be installed with a package manager. If you use OSX Homebrew, try `brew install maven`. Ubuntu users can run `sudo apt-get install maven`. Windows users with [Chocolatey](https://chocolatey.org/) can run `choco install maven` from an elevated (administrator) prompt. | Spring Boot dependencies use the `org.springframework.boot` group id. Typically, your Maven POM file inherits from the `spring-boot-starter-parent` project and declares dependencies to one or more [starters](reference/using/build-systems.html#using.build-systems.starters). Spring Boot also provides an optional [Maven plugin](maven-plugin/index.html) to create executable jars. More details on getting started with Spring Boot and Maven can be found in the [Getting Started](maven-plugin/getting-started.html) section of the Maven plugin’s reference guide. ### [](#getting-started.installing.java.gradle)Gradle Installation Spring Boot is compatible with Gradle 8.x (8.14 or later) or 9.x. If you do not already have Gradle installed, you can follow the instructions at [gradle.org](https://gradle.org). Spring Boot dependencies can be declared by using the `org.springframework.boot` `group`. Typically, your project declares dependencies to one or more [starters](reference/using/build-systems.html#using.build-systems.starters). Spring Boot provides a useful [Gradle plugin](gradle-plugin/index.html) that can be used to simplify dependency declarations and to create executable jars. Gradle Wrapper The Gradle Wrapper provides a nice way of “obtaining” Gradle when you need to build a project. It is a small script and library that you commit alongside your code to bootstrap the build process. See [docs.gradle.org/current/userguide/gradle\_wrapper.html](https://docs.gradle.org/current/userguide/gradle_wrapper.html) for details. More details on getting started with Spring Boot and Gradle can be found in the [Getting Started](gradle-plugin/getting-started.html) section of the Gradle plugin’s reference guide. ## [](#getting-started.installing.cli)Installing the Spring Boot CLI The Spring Boot CLI (Command Line Interface) is a command line tool that you can use to quickly prototype with Spring. You do not need to use the CLI to work with Spring Boot, but it is a quick way to get a Spring application off the ground without an IDE. ### [](#getting-started.installing.cli.manual-installation)Manual Installation You can download the Spring CLI distribution from one of the following locations: * [spring-boot-cli-4.1.1-bin.zip](https://repo.maven.apache.org/maven2/org/springframework/boot/spring-boot-cli/4.1.1/spring-boot-cli-4.1.1-bin.zip) * [spring-boot-cli-4.1.1-bin.tar.gz](https://repo.maven.apache.org/maven2/org/springframework/boot/spring-boot-cli/4.1.1/spring-boot-cli-4.1.1-bin.tar.gz) Once downloaded, follow the [INSTALL.txt](https://raw.githubusercontent.com/spring-projects/spring-boot/v4.1.1/cli/spring-boot-cli/src/main/content/INSTALL.txt) instructions from the unpacked archive. In summary, there is a `spring` script (`spring.bat` for Windows) in a `bin/` directory in the `.zip` file. Alternatively, you can use `java -jar` with the `.jar` file (the script helps you to be sure that the classpath is set correctly). ### [](#getting-started.installing.cli.sdkman)Installation with SDKMAN! SDKMAN! (The Software Development Kit Manager) can be used for managing multiple versions of various binary SDKs, including Groovy and the Spring Boot CLI. Get SDKMAN! from [sdkman.io](https://sdkman.io) and install Spring Boot by using the following commands: ```shell $ sdk install springboot $ spring --version Spring CLI v4.1.1 ``` If you develop features for the CLI and want access to the version you built, use the following commands: ```shell $ sdk install springboot dev /path/to/spring-boot/spring-boot-cli/target/spring-boot-cli-4.1.1-bin/spring-4.1.1/ $ sdk default springboot dev $ spring --version Spring CLI v4.1.1 ``` The preceding instructions install a local instance of `spring` called the `dev` instance. It points at your target build location, so every time you rebuild Spring Boot, `spring` is up-to-date. You can see it by running the following command: ```shell $ sdk ls springboot ================================================================================ Available Springboot Versions ================================================================================ > + dev * 4.1.1 ================================================================================ + - local version * - installed > - currently in use ================================================================================ ``` ### [](#getting-started.installing.cli.homebrew)OSX Homebrew Installation If you are on a Mac and use [Homebrew](https://brew.sh/), you can install the Spring Boot CLI by using the following commands: ```shell $ brew tap spring-io/tap $ brew install spring-boot ``` Homebrew installs `spring` to `/usr/local/bin`. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------- | | ** | If you do not see the formula, your installation of brew might be out-of-date. In that case, run `brew update` and try again. | ### [](#getting-started.installing.cli.macports)MacPorts Installation If you are on a Mac and use [MacPorts](https://www.macports.org/), you can install the Spring Boot CLI by using the following command: ```shell $ sudo port install spring-boot-cli ``` ### [](#getting-started.installing.cli.completion)Command-line Completion The Spring Boot CLI includes scripts that provide command completion for the [BASH](https://en.wikipedia.org/wiki/Bash_%28Unix_shell%29) and [zsh](https://en.wikipedia.org/wiki/Z_shell) shells. You can `source` the script named `spring` (`_spring` for zsh) or put it in your personal or system-wide bash completion initialization. On a Debian system, the system-wide scripts are in `/shell-completion/` and all scripts in that directory are executed when a new shell starts. For example, to run the script manually if you have installed by using SDKMAN!, use the following commands: ```shell $ . ~/.sdkman/candidates/springboot/current/shell-completion/bash/spring $ spring encodepassword help init shell version ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you install the Spring Boot CLI by using Homebrew or MacPorts, the command-line completion scripts are automatically registered with your shell. | ### [](#getting-started.installing.cli.scoop)Windows Scoop Installation If you are on a Windows and use [Scoop](https://scoop.sh/), you can install the Spring Boot CLI by using the following commands: ```shell $ scoop bucket add extras $ scoop install springboot ``` Scoop installs `spring` to `~/scoop/apps/springboot/current/bin`. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------ | | ** | If you do not see the app manifest, your installation of scoop might be out-of-date. In that case, run `scoop update` and try again. | * [Spring Boot](index.html) * [4.1.1](installing.html) * [4.0.8](4.0/installing.html) * [3.5.16](3.5/installing.html) * [3.4.13](3.4/installing.html) * [3.3.13](3.3/installing.html) - [4.2.0-M2](4.2/installing.html) * [4.2.0-SNAPSHOT](4.2-SNAPSHOT/installing.html) * [4.1.3-SNAPSHOT](4.1-SNAPSHOT/installing.html) * [4.0.10-SNAPSHOT](4.0-SNAPSHOT/installing.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/using/devtools.html ---- # Developer Tools Spring Boot includes an additional set of tools that can make the application development experience a little more pleasant. The `spring-boot-devtools` module can be included in any project to provide additional development-time features. To include devtools support, add the module dependency to your build, as shown in the following listings for Maven and Gradle: Maven ```xml org.springframework.boot spring-boot-devtools true ``` Gradle ```gradle dependencies { developmentOnly("org.springframework.boot:spring-boot-devtools") } ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Devtools might cause classloading issues, in particular in multi-module projects. [Diagnosing Classloading Issues](#using.devtools.diagnosing-classloading-issues) explains how to diagnose and solve them. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Developer tools are automatically disabled when running a fully packaged application. If your application is launched from `java -jar` or if it is started from a special classloader, then it is considered a “production application”. You can control this behavior by using the `spring.devtools.restart.enabled` system property. To enable devtools, irrespective of the classloader used to launch your application, set the `-Dspring.devtools.restart.enabled=true` system property. This must not be done in a production environment where running devtools is a security risk. To disable devtools, exclude the dependency or set the `-Dspring.devtools.restart.enabled=false` system property. | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Flagging the dependency as optional in Maven or using the `developmentOnly` configuration in Gradle (as shown above) prevents devtools from being transitively applied to other modules that use your project. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Repackaged archives do not contain devtools by default. If you want to use a [certain remote devtools feature](#using.devtools.remote-applications), you need to include it. When using the Maven plugin, opt-in for optional dependencies by setting the `includeOptional` property to `true`. You also need to set the `excludeDevtools` property to `false`. When using the Gradle plugin, [configure the task’s classpath to include the `developmentOnly` configuration](../../gradle-plugin/packaging.html#packaging-executable.configuring.including-development-only-dependencies). | ## [](#using.devtools.diagnosing-classloading-issues)Diagnosing Classloading Issues As described in the [Restart vs Reload](#using.devtools.restart.restart-vs-reload) section, restart functionality is implemented by using two classloaders. For most applications, this approach works well. However, it can sometimes cause classloading issues, in particular in multi-module projects. To diagnose whether the classloading issues are indeed caused by devtools and its two classloaders, [try disabling restart](#using.devtools.restart.disable). If this solves your problems, [customize the restart classloader](#using.devtools.restart.customizing-the-classload) to include your entire project. ## [](#using.devtools.property-defaults)Property Defaults Several of the libraries supported by Spring Boot use caches to improve performance. For example, [template engines](../web/servlet.html#web.servlet.spring-mvc.template-engines) cache compiled templates to avoid repeatedly parsing template files. Also, Spring MVC can add HTTP caching headers to responses when serving static resources. While caching is very beneficial in production, it can be counter-productive during development, preventing you from seeing the changes you just made in your application. For this reason, spring-boot-devtools disables the caching options by default. Cache options are usually configured by settings in your `application.properties` file. For example, Thymeleaf offers the `spring.thymeleaf.cache` property. The same applies for tracing probability that’s set to 100% as the default may not log all traces used for testing. Rather than needing to set these properties manually, the `spring-boot-devtools` module automatically applies sensible development-time configuration. The following table lists all the properties that are applied: | Name | Default Value | | ------------------------------------------------ | ----------------- | | `management.tracing.sampling.probability` | `1.0` | | `server.servlet.jsp.init-parameters.development` | `true` | | `server.servlet.session.persistent` | `true` | | `spring.docker.compose.readiness.wait` | `only-if-started` | | `spring.freemarker.cache` | `false` | | `spring.graphql.graphiql.enabled` | `true` | | `spring.groovy.template.cache` | `false` | | `spring.h2.console.enabled` | `true` | | `spring.mustache.servlet.cache` | `false` | | `spring.mvc.log-resolved-exception` | `true` | | `spring.reactor.netty.shutdown-quiet-period` | `0s` | | `spring.template.provider.cache` | `false` | | `spring.thymeleaf.cache` | `false` | | `spring.web.error.include-binding-errors` | `always` | | `spring.web.error.include-message` | `always` | | `spring.web.error.include-stacktrace` | `always` | | `spring.web.resources.cache.period` | `0` | | `spring.web.resources.chain.cache` | `false` | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you do not want property defaults to be applied you can set `spring.devtools.add-properties` to `false` in your `application.properties`. | Because you need more information about web requests while developing Spring MVC and Spring WebFlux applications, developer tools suggests you to enable `DEBUG` logging for the `web` logging group. This will give you information about the incoming request, which handler is processing it, the response outcome, and other details. If you wish to log all request details (including potentially sensitive information), you can turn on the `spring.mvc.log-request-details` or `spring.http.codecs.log-request-details` configuration properties. ## [](#using.devtools.restart)Automatic Restart Applications that use `spring-boot-devtools` automatically restart whenever files on the classpath change. This can be a useful feature when working in an IDE, as it gives a very fast feedback loop for code changes. By default, any entry on the classpath that points to a directory is monitored for changes. Note that certain resources, such as static assets and view templates, [do not need to restart the application](#using.devtools.restart.excluding-resources). Triggering a restart As DevTools monitors classpath resources, the only way to trigger a restart is to update the classpath. Whether you’re using an IDE or one of the build plugins, the modified files have to be recompiled to trigger a restart. The way in which you cause the classpath to be updated depends on the tool that you are using: * In Eclipse, saving a modified file causes the classpath to be updated and triggers a restart. * In IntelliJ IDEA, building the project (`Build -> Build Project`) has the same effect. * If using a build plugin, running `mvn compile` for Maven or `gradle build` for Gradle will trigger a restart. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you are restarting with Maven or Gradle using the build plugin you must leave the `forking` set to `enabled`. If you disable forking, the isolated application classloader used by devtools will not be created and restarts will not operate properly. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you use JRebel, automatic restarts are disabled in favor of dynamic class reloading. Other devtools features (such as property overrides) can still be used. | | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | DevTools relies on the application context’s shutdown hook to close it during a restart. It does not work correctly if you have disabled the shutdown hook (`SpringApplication.setRegisterShutdownHook(false)`). | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | DevTools needs to customize the [`ResourceLoader`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/io/ResourceLoader.html) used by the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html). If your application provides one already, it is going to be wrapped. Direct override of the `getResource` method on the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) is not supported. | | | | | -- | -------------------------------------------------------------- | | ** | Automatic restart is not supported when using AspectJ weaving. | Restart vs Reload The restart technology provided by Spring Boot works by using two classloaders. Classes that do not change (for example, those from third-party jars) are loaded into a *base* classloader. Classes that you are actively developing are loaded into a *restart* classloader. When the application is restarted, the *restart* classloader is thrown away and a new one is created. This approach means that application restarts are typically much faster than “cold starts”, since the *base* classloader is already available and populated. If you find that restarts are not quick enough for your applications or you encounter classloading issues, you could consider reloading technologies such as [JRebel](https://jrebel.com/software/jrebel/) from ZeroTurnaround. These work by rewriting classes as they are loaded to make them more amenable to reloading. ### [](#using.devtools.restart.logging-condition-delta)Logging Changes in Condition Evaluation By default, each time your application restarts, a report showing the condition evaluation delta is logged. The report shows the changes to your application’s auto-configuration as you make changes such as adding or removing beans and setting configuration properties. To disable the logging of the report, set the following property: * Properties * YAML ```properties spring.devtools.restart.log-condition-evaluation-delta=false ``` ```yaml spring: devtools: restart: log-condition-evaluation-delta: false ``` ### [](#using.devtools.restart.excluding-resources)Excluding Resources Certain resources do not necessarily need to trigger a restart when they are changed. For example, Thymeleaf templates can be edited in-place. By default, changing resources in `/META-INF/maven`, `/META-INF/resources`, `/resources`, `/static`, `/public`, or `/templates` does not trigger a restart but does trigger a [live reload](#using.devtools.livereload). If you want to customize these exclusions, you can use the `spring.devtools.restart.exclude` property. For example, to exclude only `/static` and `/public` you would set the following property: * Properties * YAML ```properties spring.devtools.restart.exclude=static/**,public/** ``` ```yaml spring: devtools: restart: exclude: "static/**,public/**" ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------ | | ** | If you want to keep those defaults and *add* additional exclusions, use the `spring.devtools.restart.additional-exclude` property instead. | ### [](#using.devtools.restart.watching-additional-paths)Watching Additional Paths You may want your application to be restarted or reloaded when you make changes to files that are not on the classpath. To do so, use the `spring.devtools.restart.additional-paths` property to configure additional paths to watch for changes. You can use the `spring.devtools.restart.exclude` property [described earlier](#using.devtools.restart.excluding-resources) to control whether changes beneath the additional paths trigger a full restart or a [live reload](#using.devtools.livereload). ### [](#using.devtools.restart.disable)Disabling Restart If you do not want to use the restart feature, you can disable it by using the `spring.devtools.restart.enabled` property. In most cases, you can set this property in your `application.properties` (doing so still initializes the restart classloader, but it does not watch for file changes). If you need to *completely* disable restart support (for example, because it does not work with a specific library), you need to set the `spring.devtools.restart.enabled` [`System`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/System.html) property to `false` before calling `SpringApplication.run(…​)`, as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class MyApplication { public static void main(String[] args) { System.setProperty("spring.devtools.restart.enabled", "false"); SpringApplication.run(MyApplication.class, args); } } ``` ```kotlin import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.runApplication @SpringBootApplication class MyApplication fun main(args: Array) { System.setProperty("spring.devtools.restart.enabled", "false") runApplication(*args) } ``` ### [](#using.devtools.restart.triggerfile)Using a Trigger File If you work with an IDE that continuously compiles changed files, you might prefer to trigger restarts only at specific times. To do so, you can use a “trigger file”, which is a special file that must be modified when you want to actually trigger a restart check. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------ | | ** | Any update to the file will trigger a check, but restart only actually occurs if Devtools has detected it has something to do. | To use a trigger file, set the `spring.devtools.restart.trigger-file` property to the name (excluding any path) of your trigger file. The trigger file must appear somewhere on your classpath. For example, if you have a project with the following structure: ```none src +- main +- resources +- .reloadtrigger ``` Then your `trigger-file` property would be: * Properties * YAML ```properties spring.devtools.restart.trigger-file=.reloadtrigger ``` ```yaml spring: devtools: restart: trigger-file: ".reloadtrigger" ``` Restarts will now only happen when the `src/main/resources/.reloadtrigger` is updated. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You might want to set `spring.devtools.restart.trigger-file` as a [global setting](#using.devtools.globalsettings), so that all your projects behave in the same way. | Some IDEs have features that save you from needing to update your trigger file manually. [Spring Tools for Eclipse](https://spring.io/tools) and [IntelliJ IDEA (Ultimate Edition)](https://www.jetbrains.com/idea/) both have such support. With Spring Tools, you can use the “reload” button from the console view (as long as your `trigger-file` is named `.reloadtrigger`). For IntelliJ IDEA, you can follow the [instructions in their documentation](https://www.jetbrains.com/help/idea/spring-boot.html#application-update-policies). ### [](#using.devtools.restart.customizing-the-classload)Customizing the Restart Classloader As described earlier in the [Restart vs Reload](#using.devtools.restart.restart-vs-reload) section, restart functionality is implemented by using two classloaders. If this causes issues, you can diagnose the problem by using the `spring.devtools.restart.enabled` system property, and if the app works with restart switched off, you might need to customize what gets loaded by which classloader. By default, any open project in your IDE is loaded with the “restart” classloader, and any regular `.jar` file is loaded with the “base” classloader. The same is true if you use `mvn spring-boot:run` or `gradle bootRun`: the project containing your [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html) is loaded with the “restart” classloader, and everything else with the “base” classloader. The classpath is printed on the console when you start the app, which can help to identify any problematic entries. Classes used reflectively, especially annotations, can be loaded into the parent (fixed) classloader on startup before the application classes which use them, and this might lead to them not being detected by Spring in the application. You can instruct Spring Boot to load parts of your project with a different classloader by creating a `META-INF/spring-devtools.properties` file. The `spring-devtools.properties` file can contain properties prefixed with `restart.exclude` and `restart.include`. The `include` elements are items that should be pulled up into the “restart” classloader, and the `exclude` elements are items that should be pushed down into the “base” classloader. The value of the property is a regex pattern that is applied to the classpath passed to the JVM on startup. Here is an example where some local class files are excluded and some extra libraries are included in the restart class loader: ```properties restart.exclude.companycommonlibs="/mycorp-common-[\\w\\d-\\.]/(build|bin|out|target)/" restart.include.projectcommon="/mycorp-myproj-[\\w\\d-\\.]+\\.jar" ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------ | | ** | All property keys must be unique. As long as a property starts with `restart.include.` or `restart.exclude.` it is considered. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | All `META-INF/spring-devtools.properties` from the classpath are loaded. You can package files inside your project, or in the libraries that the project consumes. System properties can not be used, only the properties file. | ### [](#using.devtools.restart.limitations)Known Limitations Restart functionality does not work well with objects that are deserialized by using a standard [`ObjectInputStream`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/ObjectInputStream.html). If you need to deserialize data, you may need to use Spring’s [`ConfigurableObjectInputStream`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/ConfigurableObjectInputStream.html) in combination with `Thread.currentThread().getContextClassLoader()`. Unfortunately, several third-party libraries deserialize without considering the context classloader. If you find such a problem, you need to request a fix with the original authors. ## [](#using.devtools.livereload)LiveReload | | | | -- | ------------------------------------------------------------------------------------------------------------------------------- | | ** | Given its decrease in popularity and support, the LiveReload feature is deprecated as of Spring Boot 4.1.0 with no replacement. | The `spring-boot-devtools` module includes an embedded LiveReload server that can be used to trigger a browser refresh when a resource is changed. LiveReload browser extensions are freely available for Chrome, Firefox and Safari. You can find these extensions by searching 'LiveReload' in the marketplace or store of your chosen browser. If you want to start the LiveReload server when your application runs, you can set the `spring.devtools.livereload.enabled` property to `true`. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can only run one LiveReload server at a time. Before starting your application, ensure that no other LiveReload servers are running. If you start multiple applications from your IDE, only the first has LiveReload support. | | | | | -- | -------------------------------------------------------------------------------------------------------- | | ** | To trigger LiveReload when a file changes, [Automatic Restart](#using.devtools.restart) must be enabled. | ## [](#using.devtools.globalsettings)Global Settings You can configure global devtools settings by adding any of the following files to the `$HOME/.config/spring-boot` directory: 1. `spring-boot-devtools.properties` 2. `spring-boot-devtools.yaml` 3. `spring-boot-devtools.yml` Any properties added to these files apply to *all* Spring Boot applications on your machine that use devtools. For example, to configure restart to always use a [trigger file](#using.devtools.restart.triggerfile), you would add the following property to your `spring-boot-devtools` file: * Properties * YAML ```properties spring.devtools.restart.trigger-file=.reloadtrigger ``` ```yaml spring: devtools: restart: trigger-file: ".reloadtrigger" ``` By default, `$HOME` is the user’s home directory. To customize this location, set the `SPRING_DEVTOOLS_HOME` environment variable or the `spring.devtools.home` system property. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If devtools configuration files are not found in `$HOME/.config/spring-boot`, the root of the `$HOME` directory is searched for the presence of a `.spring-boot-devtools.properties` file. This allows you to share the devtools global configuration with applications that are on an older version of Spring Boot that does not support the `$HOME/.config/spring-boot` location. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Profiles are not supported in devtools properties/yaml files.Any profiles activated in `.spring-boot-devtools.properties` will not affect the loading of [profile-specific configuration files](../features/external-config.html#features.external-config.files.profile-specific). Profile specific filenames (of the form `spring-boot-devtools-.properties`) and `spring.config.activate.on-profile` documents in both YAML and Properties files are not supported. | ### [](#using.devtools.globalsettings.configuring-file-system-watcher)Configuring File System Watcher [`FileSystemWatcher`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/devtools/filewatch/FileSystemWatcher.html) works by polling the class changes with a certain time interval, and then waiting for a predefined quiet period to make sure there are no more changes. Since Spring Boot relies entirely on the IDE to compile and copy files into the location from where Spring Boot can read them, you might find that there are times when certain changes are not reflected when devtools restarts the application. If you observe such problems constantly, try increasing the `spring.devtools.restart.poll-interval` and `spring.devtools.restart.quiet-period` parameters to the values that fit your development environment: * Properties * YAML ```properties spring.devtools.restart.poll-interval=2s spring.devtools.restart.quiet-period=1s ``` ```yaml spring: devtools: restart: poll-interval: "2s" quiet-period: "1s" ``` The monitored classpath directories are now polled every 2 seconds for changes, and a 1 second quiet period is maintained to make sure there are no additional class changes. ## [](#using.devtools.remote-applications)Remote Applications The Spring Boot developer tools are not limited to local development. You can also use several features when running applications remotely. Remote support is opt-in as enabling it can be a security risk. It should only be enabled when running on a trusted network or when secured with SSL. If neither of these options is available to you, you should not use DevTools' remote support. You should never enable support on a production deployment. To enable it, you need to make sure that `devtools` is included in the repackaged archive, as shown in the following listing: ```xml org.springframework.boot spring-boot-maven-plugin true false ``` | | | | -- | -------------------------------------------------------------------------------------------------------- | | ** | Optional dependencies are not included by default, which explains why `includeOptional` is also present. | Then you need to set the `spring.devtools.remote.secret` property. Like any important password or secret, the value should be unique and strong such that it cannot be guessed or brute-forced. Remote devtools support is provided in two parts: a server-side endpoint that accepts connections and a client application that you run in your IDE. The server component is automatically enabled when the `spring.devtools.remote.secret` property is set. The client component must be launched manually. | | | | -- | ----------------------------------------------------------------- | | ** | Remote devtools is not supported for Spring WebFlux applications. | ### [](#using.devtools.remote-applications.client)Running the Remote Client Application The remote client application is designed to be run from within your IDE. You need to run [`RemoteSpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/devtools/RemoteSpringApplication.html) with the same classpath as the remote project that you connect to. The application’s single required argument is the remote URL to which it connects. For example, if you are using Eclipse or Spring Tools and you have a project named `my-app` that you have deployed to Cloud Foundry, you would do the following: * Select `Run Configurations…​` from the `Run` menu. * Create a new `Java Application` “launch configuration”. * Browse for the `my-app` project. * Use [`RemoteSpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/devtools/RemoteSpringApplication.html) as the main class. * Add `https://myapp.cfapps.io` to the `Program arguments` (or whatever your remote URL is). A running remote client might resemble the following listing: ```none . ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ ___ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | | _ \___ _ __ ___| |_ ___ \ \ \ \ \\/ ___)| |_)| | | | | || (_| []::::::[] / -_) ' \/ _ \ _/ -_) ) ) ) ) ' |____| .__|_| |_|_| |_\__, | |_|_\___|_|_|_\___/\__\___|/ / / / =========|_|==============|___/===================================/_/_/_/ :: Spring Boot Remote :: (v4.1.1) 2026-08-17T10:51:38.751Z INFO 11457 --- [ main] o.s.b.devtools.RemoteSpringApplication : Starting RemoteSpringApplication v4.1.1 using Java 25.0.4 with PID 11457 (/Users/myuser/.m2/repository/org/springframework/boot/spring-boot-devtools/4.1.1/spring-boot-devtools-4.1.1.jar started by myuser in /opt/apps/) 2026-08-17T10:51:38.769Z INFO 11457 --- [ main] o.s.b.devtools.RemoteSpringApplication : No active profile set, falling back to 1 default profile: "default" 2026-08-17T10:51:40.221Z INFO 11457 --- [ main] o.s.b.d.a.OptionalLiveReloadServer : LiveReload server is running on port 35729 2026-08-17T10:51:40.337Z INFO 11457 --- [ main] o.s.b.devtools.RemoteSpringApplication : Started RemoteSpringApplication in 3.297 seconds (process running for 4.891) ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Because the remote client is using the same classpath as the real application it can directly read application properties. This is how the `spring.devtools.remote.secret` property is read and passed to the server for authentication. | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------- | | ** | It is always advisable to use `https://` as the connection protocol, so that traffic is encrypted and passwords cannot be intercepted. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | If you need to use a proxy to access the remote application, configure the `spring.devtools.remote.proxy.host` and `spring.devtools.remote.proxy.port` properties. | ### [](#using.devtools.remote-applications.update)Remote Update The remote client monitors your application classpath for changes in the same way as the [local restart](#using.devtools.restart). Any updated resource is pushed to the remote application and (*if required*) triggers a restart. This can be helpful if you iterate on a feature that uses a cloud service that you do not have locally. Generally, remote updates and restarts are much quicker than a full rebuild and deploy cycle. On a slower development environment, it may happen that the quiet period is not enough, and the changes in the classes may be split into batches. The server is restarted after the first batch of class changes is uploaded. The next batch can’t be sent to the application, since the server is restarting. This is typically manifested by a warning in the [`RemoteSpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/devtools/RemoteSpringApplication.html) logs about failing to upload some of the classes, and a consequent retry. But it may also lead to application code inconsistency and failure to restart after the first batch of changes is uploaded. If you observe such problems constantly, try increasing the `spring.devtools.restart.poll-interval` and `spring.devtools.restart.quiet-period` parameters to the values that fit your development environment. See the [Configuring File System Watcher](#using.devtools.globalsettings.configuring-file-system-watcher) section for configuring these properties. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Files are only monitored when the remote client is running. If you change a file before starting the remote client, it is not pushed to the remote server. | * [Spring Boot](../../index.html) * [4.1.1](devtools.html) * [4.0.8](../../4.0/reference/using/devtools.html) * [3.5.16](../../3.5/reference/using/devtools.html) * [3.4.13](../../3.4/reference/using/devtools.html) * [3.3.13](../../3.3/reference/using/devtools.html) - [4.2.0-M2](../../4.2/reference/using/devtools.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/using/devtools.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/using/devtools.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/using/devtools.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/class-use/BootWar.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.bundling.BootWar ====================================================== No usage of org.springframework.boot.gradle.tasks.bundling.BootWar ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/MatchingGroupIdFilter.html ---- # Class MatchingGroupIdFilter [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.shared.artifact.filter.collection.AbstractArtifactsFilter org.apache.maven.shared.artifact.filter.collection.AbstractArtifactFeatureFilter org.springframework.boot.maven.MatchingGroupIdFilter * All Implemented Interfaces: `org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter` *** public class MatchingGroupIdFilter extends org.apache.maven.shared.artifact.filter.collection.AbstractArtifactFeatureFilter An `ArtifactsFilter` that filters by matching groupId. Preferred over the `GroupIdFilter` due to that classes use of [`String.startsWith(String, int)`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html#startsWith\(java.lang.String,int\) "class or interface in java.lang") to match on prefix. * Since: 1.1.0 * Author: Mark Ingram - ## Constructor Summary Constructors Constructor Description `MatchingGroupIdFilter(String exclude)` Create a new instance with the CSV groupId values that should be excluded. * ## Constructor Details * ### MatchingGroupIdFilter public MatchingGroupIdFilter​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") exclude) Create a new instance with the CSV groupId values that should be excluded. * Parameters: `exclude` - the group values to exclude * ## Method Details * ### getArtifactFeature protected [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getArtifactFeature​(org.apache.maven.artifact.Artifact artifact) * Specified by: `getArtifactFeature` in class `org.apache.maven.shared.artifact.filter.collection.AbstractArtifactFeatureFilter` ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/index-files/index-8.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ## I * [include(String...)](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayerSpec.html#include\(java.lang.String...\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.IntoLayerSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Adds patterns that control the content that is included in the layer. * [includeProjectDependencies()](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesIntoLayerSpec.html#includeProjectDependencies\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.DependenciesIntoLayerSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesIntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Configures the layer to include project dependencies. * [intoLayer(String)](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayersSpec.html#intoLayer\(java.lang.String\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.IntoLayersSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling")   * [intoLayer(String, Action)](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayersSpec.html#intoLayer\(java.lang.String,org.gradle.api.Action\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.IntoLayersSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling")   * [IntoLayerSpec(String)](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayerSpec.html#%3Cinit%3E\(java.lang.String\)) - Constructor for class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.IntoLayerSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Creates a new `IntoLayerSpec` that will control the content of the given layer. * [isLibrary(FileCopyDetails)](../org/springframework/boot/gradle/tasks/bundling/BootJar.html#isLibrary\(org.gradle.api.file.FileCopyDetails\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootJar](../org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling") Return if the [`FileCopyDetails`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCopyDetails.html "class or interface in org.gradle.api.file") are for a library. * [isLibrary(FileCopyDetails)](../org/springframework/boot/gradle/tasks/bundling/BootWar.html#isLibrary\(org.gradle.api.file.FileCopyDetails\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootWar](../org/springframework/boot/gradle/tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling") Return if the [`FileCopyDetails`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCopyDetails.html "class or interface in org.gradle.api.file") are for a library. [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/Docker.DockerRegistry.html ---- Uses of Class\ org.springframework.boot.maven.Docker.DockerRegistry ==================================================== No usage of org.springframework.boot.maven.Docker.DockerRegistry ---- url: https://docs.spring.io/spring-boot/reference/using/running-your-application.html ---- # Running Your Application One of the biggest advantages of packaging your application as a jar and using an embedded HTTP server is that you can run your application as you would any other. The same applies to debugging Spring Boot applications. You do not need any special IDE plugins or extensions. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | The options below are best suited for running an application locally for development. For production deployment, see [Packaging Your Application for Production](packaging-for-production.html). | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------- | | ** | This section only covers jar-based packaging. If you choose to package your application as a war file, see your server and IDE documentation. | ## [](#using.running-your-application.from-an-ide)Running From an IDE You can run a Spring Boot application from your IDE as a Java application. However, you first need to import your project. Import steps vary depending on your IDE and build system. Most IDEs can import Maven projects directly. For example, Eclipse users can select `Import…​` → `Existing Maven Projects` from the `File` menu. If you cannot directly import your project into your IDE, you may be able to generate IDE metadata by using a build plugin. Maven includes plugins for [Eclipse](https://maven.apache.org/plugins/maven-eclipse-plugin/) and [IntelliJ IDEA](https://maven.apache.org/plugins/maven-idea-plugin/). Gradle offers plugins for [various IDEs](https://docs.gradle.org/current/userguide/userguide.html). | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you accidentally run a web application twice, you see a “Port already in use” error. Spring Tools users can use the `Relaunch` button rather than the `Run` button to ensure that any existing instance is closed. | ## [](#using.running-your-application.as-a-packaged-application)Running as a Packaged Application If you use the Spring Boot Maven or Gradle plugins to create an executable jar, you can run your application using `java -jar`, as shown in the following example: ```shell $ java -jar target/myapplication-0.0.1-SNAPSHOT.jar ``` It is also possible to run a packaged application with remote debugging support enabled. Doing so lets you attach a debugger to your packaged application, as shown in the following example: ```shell $ java -agentlib:jdwp=server=y,transport=dt_socket,address=8000,suspend=n \ -jar target/myapplication-0.0.1-SNAPSHOT.jar ``` ## [](#using.running-your-application.with-the-maven-plugin)Using the Maven Plugin The Spring Boot Maven plugin includes a `run` goal that can be used to quickly compile and run your application. Applications run in an exploded form, as they do in your IDE. The following example shows a typical Maven command to run a Spring Boot application: ```shell $ mvn spring-boot:run ``` You might also want to use the `MAVEN_OPTS` operating system environment variable, as shown in the following example: ```shell $ export MAVEN_OPTS=-Xmx1024m ``` ## [](#using.running-your-application.with-the-gradle-plugin)Using the Gradle Plugin The Spring Boot Gradle plugin also includes a `bootRun` task that can be used to run your application in an exploded form. The `bootRun` task is added whenever you apply the `org.springframework.boot` and `java` plugins and is shown in the following example: ```shell $ gradle bootRun ``` You might also want to use the `JAVA_OPTS` operating system environment variable, as shown in the following example: ```shell $ export JAVA_OPTS=-Xmx1024m ``` ## [](#using.running-your-application.hot-swapping)Hot Swapping Since Spring Boot applications are plain Java applications, JVM hot-swapping should work out of the box. JVM hot swapping is somewhat limited with the bytecode that it can replace. For a more complete solution, [JRebel](https://www.jrebel.com/products/jrebel) can be used. The `spring-boot-devtools` module also includes support for quick application restarts. See the [Hot Swapping](../../how-to/hotswapping.html) section in “How-to Guides” for details. * [Spring Boot](../../index.html) * [4.1.1](running-your-application.html) * [4.0.8](../../4.0/reference/using/running-your-application.html) * [3.5.16](../../3.5/reference/using/running-your-application.html) * [3.4.13](../../3.4/reference/using/running-your-application.html) * [3.3.13](../../3.3/reference/using/running-your-application.html) - [4.2.0-M2](../../4.2/reference/using/running-your-application.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/using/running-your-application.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/using/running-your-application.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/using/running-your-application.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/io/jta.html ---- # Distributed Transactions With JTA Spring Boot supports distributed JTA transactions across multiple XA resources by using a transaction manager retrieved from JNDI. When a JTA environment is detected, Spring’s [`JtaTransactionManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/transaction/jta/JtaTransactionManager.html) is used to manage transactions. Auto-configured JMS, DataSource, and JPA beans are upgraded to support XA transactions. You can use standard Spring idioms, such as [`@Transactional`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/transaction/annotation/Transactional.html), to participate in a distributed transaction. If you are within a JTA environment and still want to use local transactions, you can set the `spring.jta.enabled` property to `false` to disable the JTA auto-configuration. ## [](#io.jta.jakartaee)Using a Jakarta EE Managed Transaction Manager If you package your Spring Boot application as a `war` or `ear` file and deploy it to a Jakarta EE application server, you can use your application server’s built-in transaction manager. Spring Boot tries to auto-configure a transaction manager by looking at common JNDI locations (`java:comp/UserTransaction`, `java:comp/TransactionManager`, and so on). When using a transaction service provided by your application server, you generally also want to ensure that all resources are managed by the server and exposed over JNDI. Spring Boot tries to auto-configure JMS by looking for a [`ConnectionFactory`](https://jakarta.ee/specifications/messaging/3.1/apidocs/jakarta.messaging/jakarta/jms/ConnectionFactory.html) at the JNDI path (`java:/JmsXA` or `java:/XAConnectionFactory`), and you can use the [`spring.datasource.jndi-name` property](../data/sql.html#data.sql.datasource.jndi) to configure your [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html). ## [](#io.jta.mixing-xa-and-non-xa-connections)Mixing XA and Non-XA JMS Connections When using JTA, the primary JMS [`ConnectionFactory`](https://jakarta.ee/specifications/messaging/3.1/apidocs/jakarta.messaging/jakarta/jms/ConnectionFactory.html) bean is XA-aware and participates in distributed transactions. You can inject into your bean without needing to use any [`@Qualifier`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Qualifier.html): * Java * Kotlin ```java import jakarta.jms.ConnectionFactory; public class MyBean { public MyBean(ConnectionFactory connectionFactory) { // ... } } ``` ```kotlin import jakarta.jms.ConnectionFactory class MyBean(connectionFactory: ConnectionFactory?) ``` In some situations, you might want to process certain JMS messages by using a non-XA [`ConnectionFactory`](https://jakarta.ee/specifications/messaging/3.1/apidocs/jakarta.messaging/jakarta/jms/ConnectionFactory.html). For example, your JMS processing logic might take longer than the XA timeout. If you want to use a non-XA [`ConnectionFactory`](https://jakarta.ee/specifications/messaging/3.1/apidocs/jakarta.messaging/jakarta/jms/ConnectionFactory.html), you can the `nonXaJmsConnectionFactory` bean: * Java * Kotlin ```java import jakarta.jms.ConnectionFactory; import org.springframework.beans.factory.annotation.Qualifier; public class MyBean { public MyBean(@Qualifier("nonXaJmsConnectionFactory") ConnectionFactory connectionFactory) { // ... } } ``` ```kotlin import jakarta.jms.ConnectionFactory import org.springframework.beans.factory.annotation.Qualifier class MyBean(@Qualifier("nonXaJmsConnectionFactory") connectionFactory: ConnectionFactory?) ``` For consistency, the `jmsConnectionFactory` bean is also provided by using the bean alias `xaJmsConnectionFactory`: * Java * Kotlin ```java import jakarta.jms.ConnectionFactory; import org.springframework.beans.factory.annotation.Qualifier; public class MyBean { public MyBean(@Qualifier("xaJmsConnectionFactory") ConnectionFactory connectionFactory) { // ... } } ``` ```kotlin import jakarta.jms.ConnectionFactory import org.springframework.beans.factory.annotation.Qualifier class MyBean(@Qualifier("xaJmsConnectionFactory") connectionFactory: ConnectionFactory?) ``` ## [](#io.jta.supporting-embedded-transaction-manager)Supporting an Embedded Transaction Manager The [`XAConnectionFactoryWrapper`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jms/XAConnectionFactoryWrapper.html) and [`XADataSourceWrapper`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/XADataSourceWrapper.html) interfaces can be used to support embedded transaction managers. The interfaces are responsible for wrapping [`XAConnectionFactory`](https://jakarta.ee/specifications/messaging/3.1/apidocs/jakarta.messaging/jakarta/jms/XAConnectionFactory.html) and [`XADataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/XADataSource.html) beans and exposing them as regular [`ConnectionFactory`](https://jakarta.ee/specifications/messaging/3.1/apidocs/jakarta.messaging/jakarta/jms/ConnectionFactory.html) and [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) beans, which transparently enroll in the distributed transaction. DataSource and JMS auto-configuration use JTA variants, provided you have a [`JtaTransactionManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/transaction/jta/JtaTransactionManager.html) bean and appropriate XA wrapper beans registered within your [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html). * [Spring Boot](../../index.html) * [4.1.1](jta.html) * [4.0.8](../../4.0/reference/io/jta.html) * [3.5.16](../../3.5/reference/io/jta.html) * [3.4.13](../../3.4/reference/io/jta.html) * [3.3.13](../../3.3/reference/io/jta.html) - [4.2.0-M2](../../4.2/reference/io/jta.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/io/jta.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/io/jta.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/io/jta.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/index-files/index-1.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ## A * [AbstractAot](../org/springframework/boot/gradle/tasks/aot/AbstractAot.html "class in org.springframework.boot.gradle.tasks.aot") - Class in [org.springframework.boot.gradle.tasks.aot](../org/springframework/boot/gradle/tasks/aot/package-summary.html) Specialization of [`JavaExec`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") to be used as a base class for tasks that perform ahead-of-time processing. * [AbstractAot()](../org/springframework/boot/gradle/tasks/aot/AbstractAot.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.gradle.tasks.aot.[AbstractAot](../org/springframework/boot/gradle/tasks/aot/AbstractAot.html "class in org.springframework.boot.gradle.tasks.aot")   * [AOT\_SOURCE\_SET\_NAME](../org/springframework/boot/gradle/plugin/SpringBootAotPlugin.html#AOT_SOURCE_SET_NAME) - Static variable in class org.springframework.boot.gradle.plugin.[SpringBootAotPlugin](../org/springframework/boot/gradle/plugin/SpringBootAotPlugin.html "class in org.springframework.boot.gradle.plugin") Name of the main `aot` [`source set`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html "class or interface in org.gradle.api.tasks"). * [AOT\_TEST\_SOURCE\_SET\_NAME](../org/springframework/boot/gradle/plugin/SpringBootAotPlugin.html#AOT_TEST_SOURCE_SET_NAME) - Static variable in class org.springframework.boot.gradle.plugin.[SpringBootAotPlugin](../org/springframework/boot/gradle/plugin/SpringBootAotPlugin.html "class in org.springframework.boot.gradle.plugin") Name of the `aotTest` [`source set`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html "class or interface in org.gradle.api.tasks"). * [application(Action)](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html#application\(org.gradle.api.Action\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Customizes the [`LayeredSpec.ApplicationSpec`](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") using the given `action`. * [ApplicationSpec()](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.ApplicationSpec.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.ApplicationSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling")   * [ApplicationSpec(LayeredSpec.IntoLayerSpec...)](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.ApplicationSpec.html#%3Cinit%3E\(org.springframework.boot.gradle.tasks.bundling.LayeredSpec.IntoLayerSpec...\)) - Constructor for class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.ApplicationSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Creates a new `ApplicationSpec` with the given `contents`. * [apply(Project)](../org/springframework/boot/gradle/plugin/SpringBootAotPlugin.html#apply\(org.gradle.api.Project\)) - Method in class org.springframework.boot.gradle.plugin.[SpringBootAotPlugin](../org/springframework/boot/gradle/plugin/SpringBootAotPlugin.html "class in org.springframework.boot.gradle.plugin")   * [apply(Project)](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html#apply\(org.gradle.api.Project\)) - Method in class org.springframework.boot.gradle.plugin.[SpringBootPlugin](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html "class in org.springframework.boot.gradle.plugin")   * [asCache()](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.html#asCache\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[CacheSpec](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling")   [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/util/package-use.html ---- Uses of Package\ org.springframework.boot.gradle.util ==================================== No usage of org.springframework.boot.gradle.util ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/index-files/index-7.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ## G * [generateBuildProperties()](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html#generateBuildProperties\(\)) - Method in class org.springframework.boot.gradle.tasks.buildinfo.[BuildInfo](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") Generates the build info properties file in the configured [`destination dir`](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html#getDestinationDir\(\)). * [getAdditional()](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html#getAdditional\(\)) - Method in class org.springframework.boot.gradle.tasks.buildinfo.[BuildInfoProperties](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") Returns the additional properties that will be included. * [getApplication()](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html#getApplication\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the [`LayeredSpec.ApplicationSpec`](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which application classes and resources belong. * [getApplicationDirectory()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getApplicationDirectory\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the directory that contains application content in the image. * [getApplicationMainClass()](../org/springframework/boot/gradle/tasks/aot/ProcessAot.html#getApplicationMainClass\(\)) - Method in class org.springframework.boot.gradle.tasks.aot.[ProcessAot](../org/springframework/boot/gradle/tasks/aot/ProcessAot.html "class in org.springframework.boot.gradle.tasks.aot") Returns the main class of the application that is to be processed ahead-of-time. * [getArchiveFile()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getArchiveFile\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the property for the archive file from which the image will be built. * [getArtifact()](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html#getArtifact\(\)) - Method in class org.springframework.boot.gradle.tasks.buildinfo.[BuildInfoProperties](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") Returns the `build.artifact` property. * [getArtifactId()](../org/springframework/boot/gradle/tasks/aot/AbstractAot.html#getArtifactId\(\)) - Method in class org.springframework.boot.gradle.tasks.aot.[AbstractAot](../org/springframework/boot/gradle/tasks/aot/AbstractAot.html "class in org.springframework.boot.gradle.tasks.aot") The artifact ID of the application that is to be processed ahead-of-time. * [getBindHostToBuilder()](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html#getBindHostToBuilder\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[DockerSpec](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling")   * [getBindings()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getBindings\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the volume bindings that will be mounted to the container when building the image. * [getBootInf()](../org/springframework/boot/gradle/tasks/bundling/BootJar.html#getBootInf\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootJar](../org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling") Returns a `CopySpec` that can be used to add content to the `BOOT-INF` directory of the jar. * [getBuildCache()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getBuildCache\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the build cache that will be used when building the image. * [getBuilder()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getBuilder\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the builder that will be used to build the image. * [getBuilderRegistry()](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html#getBuilderRegistry\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[DockerSpec](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the [`DockerSpec.DockerRegistrySpec`](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") that configures authentication to the builder registry. * [getBuildpacks()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getBuildpacks\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the buildpacks that will be used when building the image. * [getBuildWorkspace()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getBuildWorkspace\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the build temporary workspace that will be used when building the image. * [getCertPath()](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html#getCertPath\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[DockerSpec](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling")   * [getClassesOutput()](../org/springframework/boot/gradle/tasks/aot/AbstractAot.html#getClassesOutput\(\)) - Method in class org.springframework.boot.gradle.tasks.aot.[AbstractAot](../org/springframework/boot/gradle/tasks/aot/AbstractAot.html "class in org.springframework.boot.gradle.tasks.aot") The directory to which AOT-generated classes should be written. * [getClasspath()](../org/springframework/boot/gradle/plugin/ResolveMainClassName.html#getClasspath\(\)) - Method in class org.springframework.boot.gradle.plugin.[ResolveMainClassName](../org/springframework/boot/gradle/plugin/ResolveMainClassName.html "class in org.springframework.boot.gradle.plugin") Returns the classpath that the task will examine when resolving the main class name. * [getClasspath()](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html#getClasspath\(\)) - Method in interface org.springframework.boot.gradle.tasks.bundling.[BootArchive](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") Returns the classpath that will be included in the archive. * [getClasspath()](../org/springframework/boot/gradle/tasks/bundling/BootJar.html#getClasspath\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootJar](../org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling")   * [getClasspathRoots()](../org/springframework/boot/gradle/tasks/aot/ProcessTestAot.html#getClasspathRoots\(\)) - Method in class org.springframework.boot.gradle.tasks.aot.[ProcessTestAot](../org/springframework/boot/gradle/tasks/aot/ProcessTestAot.html "class in org.springframework.boot.gradle.tasks.aot") Returns the classpath roots that should be scanned for test classes to process. * [getCleanCache()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getCleanCache\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Returns whether caches should be cleaned before packaging. * [getConfiguredMainClassName()](../org/springframework/boot/gradle/plugin/ResolveMainClassName.html#getConfiguredMainClassName\(\)) - Method in class org.springframework.boot.gradle.plugin.[ResolveMainClassName](../org/springframework/boot/gradle/plugin/ResolveMainClassName.html "class in org.springframework.boot.gradle.plugin") Returns the property for the explicitly configured main class name that should be used in favor of resolving the main class name from the classpath. * [getContext()](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html#getContext\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[DockerSpec](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling")   * [getCreatedDate()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getCreatedDate\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the date that will be used as the `Created` date of the image. * [getDependencies()](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html#getDependencies\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the [`LayeredSpec.DependenciesSpec`](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which dependencies belong. * [getDestinationDir()](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html#getDestinationDir\(\)) - Method in class org.springframework.boot.gradle.tasks.buildinfo.[BuildInfo](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") Returns the directory to which the build info file will be written. * [getDocker()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getDocker\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the Docker configuration the builder will use. * [getEmail()](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html#getEmail\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[DockerSpec.DockerRegistrySpec](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the email address associated with the Docker registry username. * [getEnabled()](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html#getEnabled\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Returns whether the layers.idx should be included in the archive. * [getEnvironment()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getEnvironment\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the environment that will be used when building the image. * [getExcludes()](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html#getExcludes\(\)) - Method in class org.springframework.boot.gradle.tasks.buildinfo.[BuildInfo](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") Returns the names of the properties to exclude from the output. * [getFilename()](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html#getFilename\(\)) - Method in class org.springframework.boot.gradle.tasks.buildinfo.[BuildInfo](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") Returns the name of the file that is written to the [`destination dir`](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html#getDestinationDir\(\)). * [getGroup()](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html#getGroup\(\)) - Method in class org.springframework.boot.gradle.tasks.buildinfo.[BuildInfoProperties](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") Returns the `build.group` property. * [getGroupId()](../org/springframework/boot/gradle/tasks/aot/AbstractAot.html#getGroupId\(\)) - Method in class org.springframework.boot.gradle.tasks.aot.[AbstractAot](../org/springframework/boot/gradle/tasks/aot/AbstractAot.html "class in org.springframework.boot.gradle.tasks.aot") The group ID of the application that is to be processed ahead-of-time. * [getHost()](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html#getHost\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[DockerSpec](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling")   * [getImageName()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getImageName\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the name of the image that will be built. * [getImagePlatform()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getImagePlatform\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the platform (os/architecture/variant) that will be used for all pulled images. * [getIncludeTools()](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html#getIncludeTools\(\)) - Method in interface org.springframework.boot.gradle.tasks.bundling.[BootArchive](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") Returns whether the JAR tools should be included as a dependency in the layered archive. * [getLaunchCache()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getLaunchCache\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the launch cache that will be used when building the image. * [getLayered()](../org/springframework/boot/gradle/tasks/bundling/BootJar.html#getLayered\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootJar](../org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the spec that describes the layers in a layered jar. * [getLayered()](../org/springframework/boot/gradle/tasks/bundling/BootWar.html#getLayered\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootWar](../org/springframework/boot/gradle/tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the spec that describes the layers in a layered jar. * [getLayerOrder()](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html#getLayerOrder\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the order of the layers in the archive from least to most frequently changing. * [getMainClass()](../org/springframework/boot/gradle/dsl/SpringBootExtension.html#getMainClass\(\)) - Method in class org.springframework.boot.gradle.dsl.[SpringBootExtension](../org/springframework/boot/gradle/dsl/SpringBootExtension.html "class in org.springframework.boot.gradle.dsl") Returns the fully-qualified name of the application's main class. * [getMainClass()](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html#getMainClass\(\)) - Method in interface org.springframework.boot.gradle.tasks.bundling.[BootArchive](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") Returns the fully-qualified name of the application's main class. * [getName()](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html#getName\(\)) - Method in class org.springframework.boot.gradle.tasks.buildinfo.[BuildInfoProperties](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") Returns the `build.name` property. * [getName()](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.VolumeCacheSpec.html#getName\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[CacheSpec.VolumeCacheSpec](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.VolumeCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the name of the cache. * [getNetwork()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getNetwork\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the network the build container will connect to. * [getOptimizedLaunch()](../org/springframework/boot/gradle/tasks/run/BootRun.html#getOptimizedLaunch\(\)) - Method in class org.springframework.boot.gradle.tasks.run.[BootRun](../org/springframework/boot/gradle/tasks/run/BootRun.html "class in org.springframework.boot.gradle.tasks.run") Returns the property for whether the JVM's launch should be optimized. * [getOutputFile()](../org/springframework/boot/gradle/plugin/ResolveMainClassName.html#getOutputFile\(\)) - Method in class org.springframework.boot.gradle.plugin.[ResolveMainClassName](../org/springframework/boot/gradle/plugin/ResolveMainClassName.html "class in org.springframework.boot.gradle.plugin") Returns the property for the task's output file that will contain the name of the main class. * [getPassword()](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html#getPassword\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[DockerSpec.DockerRegistrySpec](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the password to use when authenticating to the Docker registry. * [getProperties()](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html#getProperties\(\)) - Method in class org.springframework.boot.gradle.tasks.buildinfo.[BuildInfo](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") Returns the [`properties`](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") that will be included in the written file. * [getProvidedClasspath()](../org/springframework/boot/gradle/tasks/bundling/BootWar.html#getProvidedClasspath\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootWar](../org/springframework/boot/gradle/tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the provided classpath, the contents of which will be included in the `WEB-INF/lib-provided` directory of the war. * [getPublish()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getPublish\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Whether the built image should be pushed to a registry. * [getPublishRegistry()](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html#getPublishRegistry\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[DockerSpec](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the [`DockerSpec.DockerRegistrySpec`](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") that configures authentication to the publishing registry. * [getPullPolicy()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getPullPolicy\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Returns image pull policy that will be used when building the image. * [getResourcesOutput()](../org/springframework/boot/gradle/tasks/aot/AbstractAot.html#getResourcesOutput\(\)) - Method in class org.springframework.boot.gradle.tasks.aot.[AbstractAot](../org/springframework/boot/gradle/tasks/aot/AbstractAot.html "class in org.springframework.boot.gradle.tasks.aot") The directory to which AOT-generated resources should be written. * [getRunImage()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getRunImage\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the run image that will be included in the built image. * [getSecurityOptions()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getSecurityOptions\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the security options that will be applied to the builder container. * [getSource()](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.BindCacheSpec.html#getSource\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[CacheSpec.BindCacheSpec](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.BindCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the source of the cache. * [getSourcesOutput()](../org/springframework/boot/gradle/tasks/aot/AbstractAot.html#getSourcesOutput\(\)) - Method in class org.springframework.boot.gradle.tasks.aot.[AbstractAot](../org/springframework/boot/gradle/tasks/aot/AbstractAot.html "class in org.springframework.boot.gradle.tasks.aot") The directory to which AOT-generated sources should be written. * [getTags()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getTags\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the tags that will be created for the built image. * [getTargetJavaVersion()](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html#getTargetJavaVersion\(\)) - Method in interface org.springframework.boot.gradle.tasks.bundling.[BootArchive](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") Returns the target Java version of the project (e.g. * [getTime()](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html#getTime\(\)) - Method in class org.springframework.boot.gradle.tasks.buildinfo.[BuildInfoProperties](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") Returns the `build.time` property. * [getTlsVerify()](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html#getTlsVerify\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[DockerSpec](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling")   * [getToken()](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html#getToken\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[DockerSpec.DockerRegistrySpec](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the identity token to use when authenticating to the Docker registry. * [getTrustBuilder()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getTrustBuilder\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Whether to treat the builder as trusted. * [getUrl()](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html#getUrl\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[DockerSpec.DockerRegistrySpec](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the Docker registry URL. * [getUsername()](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html#getUsername\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[DockerSpec.DockerRegistrySpec](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") Returns the username to use when authenticating to the Docker registry. * [getVerboseLogging()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#getVerboseLogging\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Whether verbose logging should be enabled while building the image. * [getVersion()](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html#getVersion\(\)) - Method in class org.springframework.boot.gradle.tasks.buildinfo.[BuildInfoProperties](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") Returns the `build.version` property. [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ---- url: https://docs.spring.io/spring-boot/maven-plugin/build-info.html ---- # Integrating with Actuator Spring Boot Actuator displays build-related information if a `META-INF/build-info.properties` file is present. The `build-info` goal generates such file with the coordinates of the project and the build time. It also allows you to add an arbitrary number of additional properties, as shown in the following example: ```xml 4.0.0 build-info org.springframework.boot spring-boot-maven-plugin build-info UTF-8 UTF-8 ${java.version} ``` This configuration will generate a `build-info.properties` at the expected location with three additional keys. | | | | -- | -------------------------------------------------------------------------------------------------------------------------- | | ** | `java.version` is expected to be a regular property available in the project. It will be interpolated as you would expect. | ## [](#build-info.build-info-goal)`spring-boot:build-info` `org.springframework.boot:spring-boot-maven-plugin:4.1.1` Generate a `build-info.properties` file based on the content of the current `MavenProject`. ### [](#build-info.build-info-goal.optional-parameters)Optional parameters | Name | Type | Default | | ---------------------------------------------------------------------------------------------- | --------- | ----------------------------------------------------------------- | | [additionalProperties](#build-info.build-info-goal.parameter-details.additional-properties) | `Map` | | | [excludeInfoProperties](#build-info.build-info-goal.parameter-details.exclude-info-properties) | `List` | | | [outputFile](#build-info.build-info-goal.parameter-details.output-file) | `File` | `${project.build.outputDirectory}/META-INF/build-info.properties` | | [skip](#build-info.build-info-goal.parameter-details.skip) | `boolean` | `false` | | [time](#build-info.build-info-goal.parameter-details.time) | `String` | `${project.build.outputTimestamp}` | ### [](#build-info.build-info-goal.parameter-details)Parameter details #### [](#build-info.build-info-goal.parameter-details.additional-properties)`additionalProperties` Additional properties to store in the `build-info.properties` file. Each entry is prefixed by `build.` in the generated `build-info.properties`. | Name | `additionalProperties` | | ------------- | ---------------------- | | Type | `java.util.Map` | | Default value | | | User property | | | Since | | #### [](#build-info.build-info-goal.parameter-details.exclude-info-properties)`excludeInfoProperties` Properties that should be excluded `build-info.properties` file. Can be used to exclude the standard `group`, `artifact`, `name`, `version` or `time` properties as well as items from `additionalProperties`. | Name | `excludeInfoProperties` | | ------------- | ----------------------- | | Type | `java.util.List` | | Default value | | | User property | | | Since | | #### [](#build-info.build-info-goal.parameter-details.output-file)`outputFile` The location of the generated `build-info.properties` file. | Name | `outputFile` | | ------------- | ----------------------------------------------------------------- | | Type | `java.io.File` | | Default value | `${project.build.outputDirectory}/META-INF/build-info.properties` | | User property | | | Since | | #### [](#build-info.build-info-goal.parameter-details.skip)`skip` Skip the execution. | Name | `skip` | | ------------- | ----------------------------- | | Type | `boolean` | | Default value | `false` | | User property | `spring-boot.build-info.skip` | | Since | `3.1.0` | #### [](#build-info.build-info-goal.parameter-details.time)`time` The value used for the `build.time` property in a form suitable for `Instant#parse(CharSequence)`. Defaults to `project.build.outputTimestamp` or `session.request.startTime` if the former is not set. To disable the `build.time` property entirely, use `'off'` or add it to `excludeInfoProperties`. | Name | `time` | | ------------- | ---------------------------------- | | Type | `java.lang.String` | | Default value | `${project.build.outputTimestamp}` | | User property | | | Since | `2.2.0` | * [Spring Boot](../index.html) * [4.1.1](build-info.html) * [4.0.8](../4.0/maven-plugin/build-info.html) * [3.5.16](../3.5/maven-plugin/build-info.html) * [3.4.13](../3.4/maven-plugin/build-info.html) * [3.3.13](../3.3/maven-plugin/build-info.html) - [4.2.0-M2](../4.2/maven-plugin/build-info.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/maven-plugin/build-info.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/maven-plugin/build-info.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/maven-plugin/build-info.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/Image.html ---- # Class Image [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.maven.Image *** public class Image extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") Image configuration options. * Since: 2.3.0 * Author: Phillip Webb, Scott Frederick, Jeroen Meijer, Rafael Ceccone, Julian Liebig - ## Constructor Summary Constructors Constructor Description `Image()`   - ## Method Summary Modifier and Type Method Description `@Nullable String` `getApplicationDirectory()` Returns the application content directory for the image. `@Nullable String` `getBuilder()` The name of the builder image to use to create the image. `@Nullable Boolean` `getCleanCache()` If the cache should be cleaned before building. `@Nullable String` `getCreatedDate()` Returns the created date for the image. `@Nullable Map` `getEnv()` Environment properties that should be passed to the builder. `@Nullable String` `getImagePlatform()` Returns the platform (os/architecture/variant) that will be used for all pulled images. `@Nullable String` `getName()` The name of the created image. `@Nullable String` `getNetwork()` Returns the network the build container will connect to. `@Nullable Boolean` `getPublish()` If the built image should be pushed to a registry. `@Nullable org.springframework.boot.buildpack.platform.build.PullPolicy` `getPullPolicy()` If images should be pulled from a remote repository during image build. `@Nullable String` `getRunImage()` The name of the run image to use to create the image. `@Nullable Boolean` `getTrustBuilder()` If the builder should be treated as trusted. `boolean` `isVerboseLogging()` If verbose logging is required. `void` `setApplicationDirectory(@Nullable String applicationDirectory)`   `void` `setCreatedDate(@Nullable String createdDate)`   `void` `setImagePlatform(@Nullable String imagePlatform)`   `void` `setNetwork(@Nullable String network)`   ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### Image public Image() * ## Method Details * ### getName public @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getName() The name of the created image. * Returns: the image name * ### getBuilder public @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getBuilder() The name of the builder image to use to create the image. * Returns: the builder image name * ### getTrustBuilder public @Nullable [Boolean](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html "class or interface in java.lang") getTrustBuilder() If the builder should be treated as trusted. * Returns: `true` if the builder should be treated as trusted * ### getRunImage public @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getRunImage() The name of the run image to use to create the image. * Returns: the builder image name * ### getEnv public @Nullable [Map](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html "class or interface in java.util")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang"),​[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getEnv() Environment properties that should be passed to the builder. * Returns: the environment properties * ### getCleanCache public @Nullable [Boolean](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html "class or interface in java.lang") getCleanCache() If the cache should be cleaned before building. * Returns: `true` if the cache should be cleaned * ### isVerboseLogging public boolean isVerboseLogging() If verbose logging is required. * Returns: `true` for verbose logging * ### getPullPolicy public @Nullable org.springframework.boot.buildpack.platform.build.PullPolicy getPullPolicy() If images should be pulled from a remote repository during image build. * Returns: the pull policy * ### getPublish public @Nullable [Boolean](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html "class or interface in java.lang") getPublish() If the built image should be pushed to a registry. * Returns: `true` if the image should be published * ### getNetwork public @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getNetwork() Returns the network the build container will connect to. * Returns: the network * ### setNetwork public void setNetwork​(@Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") network) * ### getCreatedDate public @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getCreatedDate() Returns the created date for the image. * Returns: the created date * ### setCreatedDate public void setCreatedDate​(@Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") createdDate) * ### getApplicationDirectory public @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getApplicationDirectory() Returns the application content directory for the image. * Returns: the application directory * ### setApplicationDirectory public void setApplicationDirectory​(@Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") applicationDirectory) * ### getImagePlatform public @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getImagePlatform() Returns the platform (os/architecture/variant) that will be used for all pulled images. When `null`, the system will choose a platform based on the host operating system and architecture. * Returns: the image platform * ### setImagePlatform public void setImagePlatform​(@Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") imagePlatform) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/buildinfo/package-summary.html ---- # Package org.springframework.boot.gradle.tasks.buildinfo *** @NullMarked package org.springframework.boot.gradle.tasks.buildinfo Support for producing build info for consumption by Spring Boot's actuator. * Classes Class Description [BuildInfo](BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") [`Task`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") for generating a build info properties file from [`BuildInfoProperties`](BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo"). [BuildInfoProperties](BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") The properties that are written into the `META-INF/build-info.properties` file. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/package-summary.html ---- # Package org.springframework.boot.maven *** @NullMarked package org.springframework.boot.maven Maven plugin for Spring Boot. * Class Description [AbstractAotMojo](AbstractAotMojo.html "class in org.springframework.boot.maven") Abstract base class for AOT processing MOJOs. [AbstractAotMojo.Errors](AbstractAotMojo.Errors.html "class in org.springframework.boot.maven") [`DiagnosticListener`](https://docs.oracle.com/en/java/javase/17/docs/api/java.compiler/javax/tools/DiagnosticListener.html "class or interface in javax.tools") used to collect errors. [AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") A base mojo filtering the dependencies of the project. [AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter](AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter.html "class in org.springframework.boot.maven") `ArtifactFilter` to exclude test scope dependencies. [AbstractPackagerMojo](AbstractPackagerMojo.html "class in org.springframework.boot.maven") Abstract base class for classes that work with an `Packager`. [AbstractPackagerMojo.LayoutType](AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") Archive layout types. [AbstractRunMojo](AbstractRunMojo.html "class in org.springframework.boot.maven") Base class to run a Spring Boot application. [ArtifactsLibraries](ArtifactsLibraries.html "class in org.springframework.boot.maven") `Libraries` backed by Maven `Artifact`s. [BuildImageForkMojo](BuildImageForkMojo.html "class in org.springframework.boot.maven") Package an application into an OCI image using a buildpack, forking the lifecycle to make sure that `package` ran. [BuildImageMojo](BuildImageMojo.html "class in org.springframework.boot.maven") Package an application into an OCI image using a buildpack. [BuildImageNoForkMojo](BuildImageNoForkMojo.html "class in org.springframework.boot.maven") Package an application into an OCI image using a buildpack, but without forking the lifecycle. [BuildInfoMojo](BuildInfoMojo.html "class in org.springframework.boot.maven") Generate a `build-info.properties` file based on the content of the current `MavenProject`. [CacheInfo](CacheInfo.html "class in org.springframework.boot.maven") Encapsulates configuration of an image building cache. [CacheInfo.BindCacheInfo](CacheInfo.BindCacheInfo.html "class in org.springframework.boot.maven") Encapsulates configuration of an image building cache stored in a bind mount. [CacheInfo.VolumeCacheInfo](CacheInfo.VolumeCacheInfo.html "class in org.springframework.boot.maven") Encapsulates configuration of an image building cache stored in a volume. [DependencyFilter](DependencyFilter.html "class in org.springframework.boot.maven") Base class for `ArtifactsFilter` based on a [`FilterableDependency`](FilterableDependency.html "class in org.springframework.boot.maven") list. [Docker](Docker.html "class in org.springframework.boot.maven") Docker configuration options. [Docker.DockerRegistry](Docker.DockerRegistry.html "class in org.springframework.boot.maven") Encapsulates Docker registry authentication configuration options. [Exclude](Exclude.html "class in org.springframework.boot.maven") A model for a dependency to exclude. [ExcludeFilter](ExcludeFilter.html "class in org.springframework.boot.maven") An {DependencyFilter} that filters out any artifact matching an [`Exclude`](Exclude.html "class in org.springframework.boot.maven"). [FilterableDependency](FilterableDependency.html "class in org.springframework.boot.maven") A model for a dependency to include or exclude. [HelpMojo](HelpMojo.html "class in org.springframework.boot.maven") Display help information on spring-boot-maven-plugin.\ Call `mvn spring-boot:help -Ddetail=true -Dgoal=` to display parameter details. [Image](Image.html "class in org.springframework.boot.maven") Image configuration options. [Include](Include.html "class in org.springframework.boot.maven") A model for a dependency to include. [IncludeFilter](IncludeFilter.html "class in org.springframework.boot.maven") An `ArtifactsFilter` that filters out any artifact not matching an [`Include`](Include.html "class in org.springframework.boot.maven"). [Layers](Layers.html "class in org.springframework.boot.maven") Layer configuration options. [MatchingGroupIdFilter](MatchingGroupIdFilter.html "class in org.springframework.boot.maven") An `ArtifactsFilter` that filters by matching groupId. [ProcessAotMojo](ProcessAotMojo.html "class in org.springframework.boot.maven") Invoke the AOT engine on the application. [ProcessTestAotMojo](ProcessTestAotMojo.html "class in org.springframework.boot.maven") Invoke the AOT engine on tests. [PropertiesMergingResourceTransformer](PropertiesMergingResourceTransformer.html "class in org.springframework.boot.maven") Extension for the [Maven shade plugin](https://maven.apache.org/plugins/maven-shade-plugin/) to allow properties files (e.g. [RepackageMojo](RepackageMojo.html "class in org.springframework.boot.maven") Repackage existing JAR and WAR archives so that they can be executed from the command line using java -jar. [RunMojo](RunMojo.html "class in org.springframework.boot.maven") Run an application in place. [StartMojo](StartMojo.html "class in org.springframework.boot.maven") Start a spring application. [StopMojo](StopMojo.html "class in org.springframework.boot.maven") Stop an application that has been started by the "start" goal. [TestRunMojo](TestRunMojo.html "class in org.springframework.boot.maven") Run an application in place using the test runtime classpath. ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html ---- # Class BuildInfoProperties [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.gradle.tasks.buildinfo.BuildInfoProperties * All Implemented Interfaces: `Serializable` *** public abstract class BuildInfoProperties extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") implements [Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io") The properties that are written into the `META-INF/build-info.properties` file. * Since: 2.0.0 * Author: Andy Wilkinson * See Also: * [Serialized Form](../../../../../../serialized-form.html#org.springframework.boot.gradle.tasks.buildinfo.BuildInfoProperties) - ## Constructor Summary Constructors Constructor Description `BuildInfoProperties(Project project, SetProperty excludes)`   - ## Method Summary Modifier and Type Method Description `abstract MapProperty` `getAdditional()` Returns the additional properties that will be included. `abstract Property` `getArtifact()` Returns the `build.artifact` property. `abstract Property` `getGroup()` Returns the `build.group` property. `abstract Property` `getName()` Returns the `build.name` property. `abstract Property` `getTime()` Returns the `build.time` property. `abstract Property` `getVersion()` Returns the `build.version` property. ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### BuildInfoProperties @Inject public BuildInfoProperties​([Project](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Project.html "class or interface in org.gradle.api") project, [SetProperty](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/SetProperty.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> excludes) * ## Method Details * ### getGroup [@Internal](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Internal.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getGroup() Returns the `build.group` property. Defaults to the [`Project's group`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Project.html#getGroup\(\) "class or interface in org.gradle.api"). * Returns: the group property * ### getArtifact [@Internal](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Internal.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getArtifact() Returns the `build.artifact` property. * Returns: the artifact property * ### getVersion [@Internal](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Internal.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getVersion() Returns the `build.version` property. Defaults to the [`Project's version`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Project.html#getVersion\(\) "class or interface in org.gradle.api"). * Returns: the version * ### getName [@Internal](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Internal.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getName() Returns the `build.name` property. Defaults to the [`Project's name`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Project.html#getName\(\) "class or interface in org.gradle.api"). * Returns: the name * ### getTime [@Internal](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Internal.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getTime() Returns the `build.time` property. * Returns: the time * ### getAdditional [@Internal](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Internal.html "class or interface in org.gradle.api.tasks") public abstract [MapProperty](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/MapProperty.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang"),​[Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang")> getAdditional() Returns the additional properties that will be included. When written, the name of each additional property is prefixed with `build.`. * Returns: the additional properties ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/index-files/index-16.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ## Z * [ZipCompression](../org/springframework/boot/gradle/tasks/bundling/ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") - Enum Class in [org.springframework.boot.gradle.tasks.bundling](../org/springframework/boot/gradle/tasks/bundling/package-summary.html) An enumeration of supported compression options for an entry in a ZIP archive. [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/class-use/ZipCompression.html ---- Uses of Enum Class\ org.springframework.boot.gradle.tasks.bundling.ZipCompression ============================================================= Packages that use [ZipCompression](../ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") Package Description [org.springframework.boot.gradle.tasks.bundling](#org.springframework.boot.gradle.tasks.bundling) Support for creating executable jars and wars. * ## Uses of [ZipCompression](../ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) Subclasses with type arguments of type [ZipCompression](../ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) Modifier and Type Class Description `enum ` `ZipCompression` An enumeration of supported compression options for an entry in a ZIP archive. Methods in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) that return [ZipCompression](../ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") Modifier and Type Method Description `protected ZipCompression` BootJar.`resolveZipCompression(FileCopyDetails details)` Return the [`ZipCompression`](../ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") that should be used when adding the file represented by the given `details` to the jar. `protected ZipCompression` BootWar.`resolveZipCompression(FileCopyDetails details)` Return the [`ZipCompression`](../ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") that should be used when adding the file represented by the given `details` to the jar. `static ZipCompression` ZipCompression.`valueOf(String name)` Returns the enum constant of this class with the specified name. `static ZipCompression[]` ZipCompression.`values()` Returns an array containing the constants of this enum class, in the order they are declared. ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/aot/class-use/ProcessTestAot.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.aot.ProcessTestAot ======================================================== No usage of org.springframework.boot.gradle.tasks.aot.ProcessTestAot ---- url: https://docs.spring.io/spring-boot/cli/index.html ---- # Spring Boot CLI The Spring Boot CLI is a command line tool that you can use to bootstrap a new project from [start.spring.io](https://start.spring.io) or encode a password. * [Spring Boot](../index.html) * [4.1.1](index.html) * [4.0.8](../4.0/cli/index.html) * [3.5.16](../3.5/cli/index.html) * [3.4.13](../3.4/cli/index.html) * [3.3.13](../3.3/cli/index.html) - [4.2.0-M2](../4.2/cli/index.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/cli/index.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/cli/index.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/cli/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/index.html ---- # Gradle Plugin The Spring Boot Gradle Plugin provides Spring Boot support in [Gradle](https://gradle.org). It allows you to package executable jar or war archives, run Spring Boot applications, and use the dependency management provided by `spring-boot-dependencies`. Spring Boot’s Gradle plugin requires Gradle 8.x (8.14 or later) or 9.x and can be used with Gradle’s [configuration cache](https://docs.gradle.org/current/userguide/configuration_cache.html). In addition to this user guide, [API documentation](api/java/index.html) is also available. * [Spring Boot](../index.html) * [4.1.1](index.html) * [4.0.8](../4.0/gradle-plugin/index.html) * [3.5.16](../3.5/gradle-plugin/index.html) * [3.4.13](../3.4/gradle-plugin/index.html) * [3.3.13](../3.3/gradle-plugin/index.html) - [4.2.0-M2](../4.2/gradle-plugin/index.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/gradle-plugin/index.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/gradle-plugin/index.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/gradle-plugin/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/how-to/deployment/traditional-deployment.html ---- # Traditional Deployment Spring Boot supports traditional deployment as well as more modern forms of deployment. This section answers common questions about traditional deployment. ## [](#howto.traditional-deployment.war)Create a Deployable War File | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Because Spring WebFlux does not strictly depend on the servlet API and applications are deployed by default on an embedded Reactor Netty server, War deployment is not supported for WebFlux applications. | The first step in producing a deployable war file is to provide a [`SpringBootServletInitializer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/support/SpringBootServletInitializer.html) subclass and override its `configure` method. Doing so makes use of Spring Framework’s servlet 3.0 support and lets you configure your application when it is launched by the servlet container. Typically, you should update your application’s main class to extend [`SpringBootServletInitializer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/support/SpringBootServletInitializer.html), as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.builder.SpringApplicationBuilder; import org.springframework.boot.web.servlet.support.SpringBootServletInitializer; @SpringBootApplication public class MyApplication extends SpringBootServletInitializer { @Override protected SpringApplicationBuilder configure(SpringApplicationBuilder application) { return application.sources(MyApplication.class); } public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } ``` ```kotlin import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.builder.SpringApplicationBuilder import org.springframework.boot.runApplication import org.springframework.boot.web.servlet.support.SpringBootServletInitializer @SpringBootApplication class MyApplication : SpringBootServletInitializer() { override fun configure(application: SpringApplicationBuilder): SpringApplicationBuilder { return application.sources(MyApplication::class.java) } } fun main(args: Array) { runApplication(*args) } ``` The next step is to update your build configuration such that your project produces a war file rather than a jar file. If you use Maven and `spring-boot-starter-parent` (which configures Maven’s war plugin for you), all you need to do is to modify `pom.xml` to change the packaging to war, as follows: ```xml war ``` If you use Gradle, you need to modify `build.gradle` to apply the war plugin to the project, as follows: ```gradle apply plugin: 'war' ``` The final step in the process is to ensure that the embedded servlet container does not interfere with the servlet container to which the war file is deployed. For Maven, you need to mark the embedded servlet container dependency as being `provided`. For example: ```xml org.springframework.boot spring-boot-starter-tomcat provided ``` If you use Gradle, you need to move only the runtime dependencies into the `providedRuntime` configuration. For example: ```gradle dependencies { // ... providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat-runtime' // ... } ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | `providedRuntime` is preferred to Gradle’s `compileOnly` configuration. Among other limitations, `compileOnly` dependencies are not on the test classpath, so any web-based integration tests fail. | If you use the Spring Boot [Build Tool Plugins](../../build-tool-plugin/index.html), marking the embedded servlet container dependency as provided produces an executable war file with the provided dependencies packaged in a `lib-provided` directory. This means that, in addition to being deployable to a servlet container, you can also run your application by using `java -jar` on the command line. ## [](#howto.traditional-deployment.convert-existing-application)Convert an Existing Application to Spring Boot To convert an existing non-web Spring application to a Spring Boot application, replace the code that creates your [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) and replace it with calls to [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) or [`SpringApplicationBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/builder/SpringApplicationBuilder.html). Spring MVC web applications are generally amenable to first creating a deployable war application and then migrating it later to an executable war or jar. To create a deployable war by extending [`SpringBootServletInitializer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/support/SpringBootServletInitializer.html) (for example, in a class called `Application`) and adding the Spring Boot [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html) annotation, use code similar to that shown in the following example: * Java * Kotlin ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.builder.SpringApplicationBuilder; import org.springframework.boot.web.servlet.support.SpringBootServletInitializer; @SpringBootApplication public class MyApplication extends SpringBootServletInitializer { @Override protected SpringApplicationBuilder configure(SpringApplicationBuilder application) { // Customize the application or call application.sources(...) to add sources // Since our example is itself a @Configuration class (through // @SpringBootApplication) // we actually do not need to override this method. return application; } } ``` ```kotlin import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.builder.SpringApplicationBuilder import org.springframework.boot.runApplication import org.springframework.boot.web.servlet.support.SpringBootServletInitializer @SpringBootApplication class MyApplication : SpringBootServletInitializer() { override fun configure(application: SpringApplicationBuilder): SpringApplicationBuilder { // Customize the application or call application.sources(...) to add sources // Since our example is itself a @Configuration class (through @SpringBootApplication) // we actually do not need to override this method. return application } } ``` Remember that, whatever you put in the `sources` is merely a Spring [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html). Normally, anything that already works should work here. There might be some beans you can remove later and let Spring Boot provide its own defaults for them, but it should be possible to get something working before you need to do that. Static resources can be moved to `/public` (or `/static` or `/resources` or `/META-INF/resources`) in the classpath root. The same applies to `messages.properties` (which Spring Boot automatically detects in the root of the classpath). Vanilla usage of Spring [`DispatcherServlet`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/DispatcherServlet.html) and Spring Security should require no further changes. If you have other features in your application (for instance, using other servlets or filters), you may need to add some configuration to your `Application` context, by replacing those elements from the `web.xml`, as follows: * A [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) of type [`Servlet`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Servlet.html) or [`ServletRegistrationBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/ServletRegistrationBean.html) installs that bean in the container as if it were a `` and `` in `web.xml`. * A [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) of type [`Filter`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Filter.html) or [`FilterRegistrationBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/FilterRegistrationBean.html) behaves similarly (as a `` and ``). * An [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) in an XML file can be added through an [`@ImportResource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/ImportResource.html) in your `Application`. Alternatively, cases where annotation configuration is heavily used already can be recreated in a few lines as [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) definitions. Once the war file is working, you can make it executable by adding a `main` method to your `Application`, as shown in the following example: * Java * Kotlin ```java public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } ``` ```kotlin fun main(args: Array) { runApplication(*args) } ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you intend to start your application as a war or as an executable application, you need to share the customizations of the builder in a method that is both available to the [`SpringBootServletInitializer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/support/SpringBootServletInitializer.html) callback and in the `main` method in a class similar to the following:- Java - Kotlin```java import org.springframework.boot.Banner; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.builder.SpringApplicationBuilder; import org.springframework.boot.web.servlet.support.SpringBootServletInitializer; @SpringBootApplication public class MyApplication extends SpringBootServletInitializer { @Override protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) { return customizerBuilder(builder); } public static void main(String[] args) { customizerBuilder(new SpringApplicationBuilder()).run(args); } private static SpringApplicationBuilder customizerBuilder(SpringApplicationBuilder builder) { return builder.sources(MyApplication.class).bannerMode(Banner.Mode.OFF); } } ``````kotlin import org.springframework.boot.Banner import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.builder.SpringApplicationBuilder import org.springframework.boot.web.servlet.support.SpringBootServletInitializer @SpringBootApplication class MyApplication : SpringBootServletInitializer() { override fun configure(builder: SpringApplicationBuilder): SpringApplicationBuilder { return customizerBuilder(builder) } companion object { @JvmStatic fun main(args: Array) { customizerBuilder(SpringApplicationBuilder()).run(*args) } private fun customizerBuilder(builder: SpringApplicationBuilder): SpringApplicationBuilder { return builder.sources(MyApplication::class.java).bannerMode(Banner.Mode.OFF) } } } ``` | Applications can fall into more than one category: * Servlet 3.0+ applications with no `web.xml`. * Applications with a `web.xml`. * Applications with a context hierarchy. * Applications without a context hierarchy. All of these should be amenable to translation, but each might require slightly different techniques. Servlet 3.0+ applications might translate pretty easily if they already use the Spring Servlet 3.0+ initializer support classes. Normally, all the code from an existing [`WebApplicationInitializer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/WebApplicationInitializer.html) can be moved into a [`SpringBootServletInitializer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/support/SpringBootServletInitializer.html). If your existing application has more than one [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) (for example, if it uses [`AbstractDispatcherServletInitializer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/support/AbstractDispatcherServletInitializer.html)) then you might be able to combine all your context sources into a single [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html). The main complication you might encounter is if combining does not work and you need to maintain the context hierarchy. See the [entry on building a hierarchy](../application.html#howto.application.context-hierarchy) for examples. An existing parent context that contains web-specific features usually needs to be broken up so that all the [`ServletContextAware`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/context/ServletContextAware.html) components are in the child context. Applications that are not already Spring applications might be convertible to Spring Boot applications, and the previously mentioned guidance may help. However, you may yet encounter problems. In that case, we suggest [asking questions on Stack Overflow with a tag of `spring-boot`](https://stackoverflow.com/questions/tagged/spring-boot). ## [](#howto.traditional-deployment.weblogic)Deploying a WAR to WebLogic To deploy a Spring Boot application to WebLogic, you must ensure that your servlet initializer **directly** implements [`WebApplicationInitializer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/WebApplicationInitializer.html) (even if you extend from a base class that already implements it). A typical initializer for WebLogic should resemble the following example: * Java * Kotlin ```java import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.web.servlet.support.SpringBootServletInitializer; import org.springframework.web.WebApplicationInitializer; @SpringBootApplication public class MyApplication extends SpringBootServletInitializer implements WebApplicationInitializer { } ``` ```kotlin import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.web.servlet.support.SpringBootServletInitializer import org.springframework.web.WebApplicationInitializer @SpringBootApplication class MyApplication : SpringBootServletInitializer(), WebApplicationInitializer ``` If you use Logback, you also need to tell WebLogic to prefer the packaged version rather than the version that was pre-installed with the server. You can do so by adding a `WEB-INF/weblogic.xml` file with the following contents: ```xml org.slf4j ``` * [Spring Boot](../../index.html) * [4.1.1](traditional-deployment.html) * [4.0.8](../../4.0/how-to/deployment/traditional-deployment.html) * [3.5.16](../../3.5/how-to/deployment/traditional-deployment.html) * [3.4.13](../../3.4/how-to/deployment/traditional-deployment.html) * [3.3.13](../../3.3/how-to/deployment/traditional-deployment.html) - [4.2.0-M2](../../4.2/how-to/deployment/traditional-deployment.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/how-to/deployment/traditional-deployment.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/how-to/deployment/traditional-deployment.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/how-to/deployment/traditional-deployment.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html ---- # Class LayeredSpec [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.gradle.tasks.bundling.LayeredSpec *** public abstract class LayeredSpec extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") Encapsulates the configuration for a layered archive. * Since: 2.3.0 * Author: Madhura Bhave, Scott Frederick, Phillip Webb - ## Nested Class Summary Nested Classes Modifier and Type Class Description `static class ` `LayeredSpec.ApplicationSpec` An [`LayeredSpec.IntoLayersSpec`](LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which application classes and resources belong. `static class ` `LayeredSpec.DependenciesIntoLayerSpec` Spec that controls the dependencies that should be part of a particular layer. `static class ` `LayeredSpec.DependenciesSpec` An [`LayeredSpec.IntoLayersSpec`](LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which dependencies belong. `static class ` `LayeredSpec.IntoLayerSpec` Spec that controls the content that should be part of a particular layer. `static class ` `LayeredSpec.IntoLayersSpec` Base class for specs that control the layers to which a category of content should belong. - ## Constructor Summary Constructors Constructor Description `LayeredSpec(ObjectFactory objects)`   - ## Method Summary Modifier and Type Method Description `void` `application(Action action)` Customizes the [`LayeredSpec.ApplicationSpec`](LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") using the given `action`. `void` `dependencies(Action action)` Customizes the [`LayeredSpec.DependenciesSpec`](LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") using the given `action`. `LayeredSpec.ApplicationSpec` `getApplication()` Returns the [`LayeredSpec.ApplicationSpec`](LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which application classes and resources belong. `LayeredSpec.DependenciesSpec` `getDependencies()` Returns the [`LayeredSpec.DependenciesSpec`](LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which dependencies belong. `abstract Property` `getEnabled()` Returns whether the layers.idx should be included in the archive. `abstract ListProperty` `getLayerOrder()` Returns the order of the layers in the archive from least to most frequently changing. `void` `setApplication(LayeredSpec.ApplicationSpec spec)` Sets the [`LayeredSpec.ApplicationSpec`](LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which application classes are resources belong. `void` `setDependencies(LayeredSpec.DependenciesSpec spec)` Sets the [`LayeredSpec.DependenciesSpec`](LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which dependencies belong. ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### LayeredSpec @Inject public LayeredSpec​([ObjectFactory](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/model/ObjectFactory.html "class or interface in org.gradle.api.model") objects) * ## Method Details * ### getEnabled [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[Boolean](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html "class or interface in java.lang")> getEnabled() Returns whether the layers.idx should be included in the archive. * Returns: whether the layers.idx should be included * Since: 3.0.0 * ### getApplication [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") public [LayeredSpec.ApplicationSpec](LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") getApplication() Returns the [`LayeredSpec.ApplicationSpec`](LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which application classes and resources belong. * Returns: the application spec * ### setApplication public void setApplication​([LayeredSpec.ApplicationSpec](LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") spec) Sets the [`LayeredSpec.ApplicationSpec`](LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which application classes are resources belong. * Parameters: `spec` - the application spec * ### application public void application​([Action](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Action.html "class or interface in org.gradle.api")<[LayeredSpec.ApplicationSpec](LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling")> action) Customizes the [`LayeredSpec.ApplicationSpec`](LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") using the given `action`. * Parameters: `action` - the action * ### getDependencies [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") public [LayeredSpec.DependenciesSpec](LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") getDependencies() Returns the [`LayeredSpec.DependenciesSpec`](LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which dependencies belong. * Returns: the dependencies spec * ### setDependencies public void setDependencies​([LayeredSpec.DependenciesSpec](LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") spec) Sets the [`LayeredSpec.DependenciesSpec`](LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which dependencies belong. * Parameters: `spec` - the dependencies spec * ### dependencies public void dependencies​([Action](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Action.html "class or interface in org.gradle.api")<[LayeredSpec.DependenciesSpec](LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling")> action) Customizes the [`LayeredSpec.DependenciesSpec`](LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") using the given `action`. * Parameters: `action` - the action * ### getLayerOrder [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [ListProperty](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/ListProperty.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getLayerOrder() Returns the order of the layers in the archive from least to most frequently changing. * Returns: the layer order ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/package-use.html ---- Uses of Package\ org.springframework.boot.gradle.tasks.bundling ============================================== Packages that use [org.springframework.boot.gradle.tasks.bundling](package-summary.html) Package Description [org.springframework.boot.gradle.tasks.bundling](#org.springframework.boot.gradle.tasks.bundling) Support for creating executable jars and wars. * Classes in [org.springframework.boot.gradle.tasks.bundling](package-summary.html) used by [org.springframework.boot.gradle.tasks.bundling](package-summary.html) Class Description [BootArchive](class-use/BootArchive.html#org.springframework.boot.gradle.tasks.bundling) A Spring Boot "fat" archive task. [CacheSpec](class-use/CacheSpec.html#org.springframework.boot.gradle.tasks.bundling) Configuration for an image building cache. [CacheSpec.BindCacheSpec](class-use/CacheSpec.BindCacheSpec.html#org.springframework.boot.gradle.tasks.bundling) Configuration for an image building cache stored in a bind mount. [CacheSpec.VolumeCacheSpec](class-use/CacheSpec.VolumeCacheSpec.html#org.springframework.boot.gradle.tasks.bundling) Configuration for an image building cache stored in a Docker volume. [DockerSpec](class-use/DockerSpec.html#org.springframework.boot.gradle.tasks.bundling) Encapsulates Docker configuration options. [DockerSpec.DockerRegistrySpec](class-use/DockerSpec.DockerRegistrySpec.html#org.springframework.boot.gradle.tasks.bundling) Encapsulates Docker registry authentication configuration options. [LayeredSpec](class-use/LayeredSpec.html#org.springframework.boot.gradle.tasks.bundling) Encapsulates the configuration for a layered archive. [LayeredSpec.ApplicationSpec](class-use/LayeredSpec.ApplicationSpec.html#org.springframework.boot.gradle.tasks.bundling) An [`LayeredSpec.IntoLayersSpec`](LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which application classes and resources belong. [LayeredSpec.DependenciesIntoLayerSpec](class-use/LayeredSpec.DependenciesIntoLayerSpec.html#org.springframework.boot.gradle.tasks.bundling) Spec that controls the dependencies that should be part of a particular layer. [LayeredSpec.DependenciesSpec](class-use/LayeredSpec.DependenciesSpec.html#org.springframework.boot.gradle.tasks.bundling) An [`LayeredSpec.IntoLayersSpec`](LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which dependencies belong. [LayeredSpec.IntoLayerSpec](class-use/LayeredSpec.IntoLayerSpec.html#org.springframework.boot.gradle.tasks.bundling) Spec that controls the content that should be part of a particular layer. [LayeredSpec.IntoLayersSpec](class-use/LayeredSpec.IntoLayersSpec.html#org.springframework.boot.gradle.tasks.bundling) Base class for specs that control the layers to which a category of content should belong. [ZipCompression](class-use/ZipCompression.html#org.springframework.boot.gradle.tasks.bundling) An enumeration of supported compression options for an entry in a ZIP archive. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-4.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## D * [DependencyFilter](../org/springframework/boot/maven/DependencyFilter.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Base class for `ArtifactsFilter` based on a [`FilterableDependency`](../org/springframework/boot/maven/FilterableDependency.html "class in org.springframework.boot.maven") list. * [DependencyFilter(List)](../org/springframework/boot/maven/DependencyFilter.html#%3Cinit%3E\(java.util.List\)) - Constructor for class org.springframework.boot.maven.[DependencyFilter](../org/springframework/boot/maven/DependencyFilter.html "class in org.springframework.boot.maven") Create a new instance with the list of [`FilterableDependency`](../org/springframework/boot/maven/FilterableDependency.html "class in org.springframework.boot.maven") instance(s) to use. * [DIR](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html#DIR) - Enum constant in enum class org.springframework.boot.maven.[AbstractPackagerMojo.LayoutType](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") Directory Layout. * [Docker](../org/springframework/boot/maven/Docker.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Docker configuration options. * [Docker()](../org/springframework/boot/maven/Docker.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.maven.[Docker](../org/springframework/boot/maven/Docker.html "class in org.springframework.boot.maven")   * [Docker.DockerRegistry](../org/springframework/boot/maven/Docker.DockerRegistry.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Encapsulates Docker registry authentication configuration options. * [DockerRegistry()](../org/springframework/boot/maven/Docker.DockerRegistry.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.maven.[Docker.DockerRegistry](../org/springframework/boot/maven/Docker.DockerRegistry.html "class in org.springframework.boot.maven")   * [DockerRegistry(String, String, String, String)](../org/springframework/boot/maven/Docker.DockerRegistry.html#%3Cinit%3E\(java.lang.String,java.lang.String,java.lang.String,java.lang.String\)) - Constructor for class org.springframework.boot.maven.[Docker.DockerRegistry](../org/springframework/boot/maven/Docker.DockerRegistry.html "class in org.springframework.boot.maven")   * [DockerRegistry(String)](../org/springframework/boot/maven/Docker.DockerRegistry.html#%3Cinit%3E\(java.lang.String\)) - Constructor for class org.springframework.boot.maven.[Docker.DockerRegistry](../org/springframework/boot/maven/Docker.DockerRegistry.html "class in org.springframework.boot.maven")   * [doWithLibraries(LibraryCallback)](../org/springframework/boot/maven/ArtifactsLibraries.html#doWithLibraries\(org.springframework.boot.loader.tools.LibraryCallback\)) - Method in class org.springframework.boot.maven.[ArtifactsLibraries](../org/springframework/boot/maven/ArtifactsLibraries.html "class in org.springframework.boot.maven")   [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-21.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## Z * [ZIP](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html#ZIP) - Enum constant in enum class org.springframework.boot.maven.[AbstractPackagerMojo.LayoutType](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") Zip Layout. [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/how-to/native-image/index.html ---- # GraalVM Native Applications This section contains details on developing and testing Spring Boot applications as GraalVM native images. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | For an overview of GraalVM native image concepts, see the [Introducing GraalVM Native Images](../../reference/packaging/native-image/introducing-graalvm-native-images.html) section. | * [Spring Boot](../../index.html) * [4.1.1](index.html) * [4.0.8](../../4.0/how-to/native-image/index.html) * [3.5.16](../../3.5/how-to/native-image/index.html) * [3.4.13](../../3.4/how-to/native-image/index.html) * [3.3.13](../../3.3/how-to/native-image/index.html) - [4.2.0-M2](../../4.2/how-to/native-image/index.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/how-to/native-image/index.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/how-to/native-image/index.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/how-to/native-image/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/running.html ---- # Running your Application with Gradle To run your application without first building an archive use the `bootRun` task: ```shell $ ./gradlew bootRun ``` The `bootRun` task is an instance of [`BootRun`](api/java/org/springframework/boot/gradle/tasks/run/BootRun.html) which is a `JavaExec` subclass. As such, all of the [usual configuration options](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.JavaExec.html) for executing a Java process in Gradle are available to you. The task is automatically configured to use the runtime classpath of the main source set. By default, the main class will be configured automatically by looking for a class with a `public static void main(String[])` method in the main source set’s output. The main class can also be configured explicitly using the task’s `main` property: * Groovy * Kotlin ```groovy tasks.named("bootRun") { mainClass = 'com.example.ExampleApplication' } ``` ```kotlin tasks.named("bootRun") { mainClass.set("com.example.ExampleApplication") } ``` Alternatively, the main class name can be configured project-wide using the `mainClass` property of the Spring Boot DSL: * Groovy * Kotlin ```groovy springBoot { mainClass = 'com.example.ExampleApplication' } ``` ```kotlin springBoot { mainClass.set("com.example.ExampleApplication") } ``` By default, `bootRun` will configure the JVM to optimize its launch for faster startup during development. This behavior can be disabled by using the `optimizedLaunch` property, as shown in the following example: * Groovy * Kotlin ```groovy tasks.named("bootRun") { optimizedLaunch = false } ``` ```kotlin tasks.named("bootRun") { optimizedLaunch.set(false) } ``` If the [`application` plugin](https://docs.gradle.org/current/userguide/application_plugin.html) has been applied, its `mainClass` property must be configured and can be used for the same purpose: * Groovy * Kotlin ```groovy application { mainClass = 'com.example.ExampleApplication' } ``` ```kotlin application { mainClass.set("com.example.ExampleApplication") } ``` ## [](#running-your-application.passing-arguments)Passing Arguments to Your Application Like all `JavaExec` tasks, arguments can be passed into `bootRun` from the command line using `--args=''` when using Gradle 4.9 or later. For example, to run your application with a profile named `dev` active the following command can be used: ```shell $ ./gradlew bootRun --args='--spring.profiles.active=dev' ``` See [the javadoc for `JavaExec.setArgsString`](https://docs.gradle.org/current/javadoc/org/gradle/api/tasks/JavaExec.html#setArgsString\(java.lang.String\)) for further details. ## [](#running-your-application.passing-system-properties)Passing System Properties to Your application Since `bootRun` is a standard `JavaExec` task, system properties can be passed to the application’s JVM by specifying them in the build script. To make that value of a system property to be configurable set its value using a [project property](https://docs.gradle.org/current/dsl/org.gradle.api.Project.html#N14FE1). To allow a project property to be optional, reference it using `findProperty`. Doing so also allows a default value to be provided using the `?:` Elvis operator, as shown in the following example: * Groovy * Kotlin ```groovy tasks.named("bootRun") { systemProperty 'com.example.property', findProperty('example') ?: 'default' } ``` ```kotlin tasks.named("bootRun") { systemProperty("com.example.property", findProperty("example") ?: "default") } ``` The preceding example sets that `com.example.property` system property to the value of the `example` project property. If the `example` project property has not been set, the value of the system property will be `default`. Gradle allows project properties to be set in a variety of ways, including on the command line using the `-P` flag, as shown in the following example: ```bash $ ./gradlew bootRun -Pexample=custom ``` The preceding example sets the value of the `example` project property to `custom`. `bootRun` will then use this as the value of the `com.example.property` system property. ## [](#running-your-application.reloading-resources)Reloading Resources If devtools has been added to your project it will automatically monitor your application’s classpath for changes. Note that modified files need to be recompiled for the classpath to update in order to trigger reloading with devtools. For more details on using devtools, refer to [this section of the reference documentation](../reference/using/devtools.html#using.devtools.restart). Alternatively, you can configure `bootRun` such that your application’s static resources are loaded from their source location: * Groovy * Kotlin ```groovy tasks.named("bootRun") { sourceResources sourceSets.main } ``` ```kotlin tasks.named("bootRun") { sourceResources(sourceSets["main"]) } ``` This makes them reloadable in the live application which can be helpful at development time. ## [](#running-your-application.using-a-test-main-class)Using a Test Main Class In addition to `bootRun` a `bootTestRun` task is also registered. Like `bootRun`, `bootTestRun` is an instance of `BootRun` but it’s configured to use a main class found in the output of the test source set rather than the main source set. It also uses the test source set’s runtime classpath rather than the main source set’s runtime classpath. As `bootTestRun` is an instance of `BootRun`, all of the configuration options described above for `bootRun` can also be used with `bootTestRun`. * [Spring Boot](../index.html) * [4.1.1](running.html) * [4.0.8](../4.0/gradle-plugin/running.html) * [3.5.16](../3.5/gradle-plugin/running.html) * [3.4.13](../3.4/gradle-plugin/running.html) * [3.3.13](../3.3/gradle-plugin/running.html) - [4.2.0-M2](../4.2/gradle-plugin/running.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/gradle-plugin/running.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/gradle-plugin/running.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/gradle-plugin/running.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/features/external-config.html ---- # Externalized Configuration Spring Boot lets you externalize your configuration so that you can work with the same application code in different environments. You can use a variety of external configuration sources including Java properties files, YAML files, environment variables, and command-line arguments. Property values can be injected directly into your beans by using the [`@Value`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Value.html) annotation, accessed through Spring’s [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) abstraction, or be [bound to structured objects](#features.external-config.typesafe-configuration-properties) through [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html). Spring Boot uses a very particular [`PropertySource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/PropertySource.html) order that is designed to allow sensible overriding of values. Later property sources can override the values defined in earlier ones. Sources are considered in the following order: 1. Default properties (specified by setting [`SpringApplication.setDefaultProperties(Map)`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html#setDefaultProperties\(java.util.Map\))). 2. [`@PropertySource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/PropertySource.html) annotations on your [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) classes. Please note that such property sources are not added to the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) until the application context is being refreshed. This is too late to configure certain properties such as `logging.*` and `spring.main.*` which are read before refresh begins. 3. Config data (such as `application.properties` files). 4. A [`RandomValuePropertySource`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/env/RandomValuePropertySource.html) that has properties only in `random.*`. 5. OS environment variables. 6. Java System properties (`System.getProperties()`). 7. JNDI attributes from `java:comp/env`. 8. [`ServletContext`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/ServletContext.html) init parameters. 9. [`ServletConfig`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/ServletConfig.html) init parameters. 10. Properties from `SPRING_APPLICATION_JSON` (inline JSON embedded in an environment variable or system property). 11. Command line arguments. 12. `properties` attribute on your tests. Available on [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html) and the [test annotations for testing a particular slice of your application](../testing/spring-boot-applications.html#testing.spring-boot-applications.autoconfigured-tests). 13. [`@DynamicPropertySource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/context/DynamicPropertySource.html) annotations in your tests. 14. [`@TestPropertySource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/context/TestPropertySource.html) annotations on your tests. 15. [Devtools global settings properties](../using/devtools.html#using.devtools.globalsettings) in the `$HOME/.config/spring-boot` directory when devtools is active. Config data files are considered in the following order: 1. [Application properties](#features.external-config.files) packaged inside your jar (`application.properties` and YAML variants). 2. [Profile-specific application properties](#features.external-config.files.profile-specific) packaged inside your jar (`application-{profile}.properties` and YAML variants). 3. [Application properties](#features.external-config.files) outside of your packaged jar (`application.properties` and YAML variants). 4. [Profile-specific application properties](#features.external-config.files.profile-specific) outside of your packaged jar (`application-{profile}.properties` and YAML variants). | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | It is recommended to stick with one format for your entire application. If you have configuration files with both `.properties` and YAML format in the same location, `.properties` takes precedence. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you use environment variables rather than system properties, most operating systems disallow period-separated key names, but you can use underscores instead (for example, `SPRING_CONFIG_NAME` instead of `spring.config.name`). See [Binding From Environment Variables](#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables) for details. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | If your application runs in a servlet container or application server, then JNDI properties (in `java:comp/env`) or servlet context initialization parameters can be used instead of, or as well as, environment variables or system properties. | To provide a concrete example, suppose you develop a [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) that uses a `name` property, as shown in the following example: * Java * Kotlin ```java import org.springframework.beans.factory.annotation.Value; import org.springframework.stereotype.Component; @Component public class MyBean { @Value("${name}") private String name; // ... } ``` ```kotlin import org.springframework.beans.factory.annotation.Value import org.springframework.stereotype.Component @Component class MyBean { @Value("\${name}") private val name: String? = null // ... } ``` On your application classpath (for example, inside your jar) you can have an `application.properties` file that provides a sensible default property value for `name`. When running in a new environment, an `application.properties` file can be provided outside of your jar that overrides the `name`. For one-off testing, you can launch with a specific command line switch (for example, `java -jar app.jar --name="Spring"`). | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The `env` and `configprops` endpoints can be useful in determining why a property has a particular value. You can use these two endpoints to diagnose unexpected property values. See the [Production ready features](../actuator/endpoints.html) section for details. | ## [](#features.external-config.command-line-args)Accessing Command Line Properties By default, [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) converts any command line option arguments (that is, arguments starting with `--`, such as `--server.port=9000`) to a `property` and adds them to the Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html). As mentioned previously, command line properties always take precedence over file-based property sources. If you do not want command line properties to be added to the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html), you can disable them by using `SpringApplication.setAddCommandLineProperties(false)`. ## [](#features.external-config.application-json)JSON Application Properties Environment variables and system properties often have restrictions that mean some property names cannot be used. To help with this, Spring Boot allows you to encode a block of properties into a single JSON structure. When your application starts, any `spring.application.json` or `SPRING_APPLICATION_JSON` properties will be parsed and added to the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html). For example, the `SPRING_APPLICATION_JSON` property can be supplied on the command line in a UN\*X shell as an environment variable: ```shell $ SPRING_APPLICATION_JSON='{"my":{"name":"test"}}' java -jar myapp.jar ``` In the preceding example, you end up with `my.name=test` in the Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html). The same JSON can also be provided as a system property: ```shell $ java -Dspring.application.json='{"my":{"name":"test"}}' -jar myapp.jar ``` Or you could supply the JSON by using a command line argument: ```shell $ java -jar myapp.jar --spring.application.json='{"my":{"name":"test"}}' ``` If you are deploying to a classic Application Server, you could also use a JNDI variable named `java:comp/env/spring.application.json`. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Although `null` values from the JSON will be added to the resulting property source, the [`PropertySourcesPropertyResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/PropertySourcesPropertyResolver.html) treats `null` properties as missing values. This means that the JSON cannot override properties from lower order property sources with a `null` value. | ## [](#features.external-config.files)External Application Properties Spring Boot will automatically find and load `application.properties` and `application.yaml` files from the following locations when your application starts: 1. From the classpath 1. The classpath root 2. The classpath `/config` package 2. From the current directory 1. The current directory 2. The `config/` subdirectory in the current directory 3. Immediate child directories of the `config/` subdirectory The list is ordered by precedence (with values from lower items overriding earlier ones). Documents from the loaded files are added as [`PropertySource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/PropertySource.html) instances to the Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html). If you do not like `application` as the configuration file name, you can switch to another file name by specifying a `spring.config.name` environment property. For example, to look for `myproject.properties` and `myproject.yaml` files you can run your application as follows: ```shell $ java -jar myproject.jar --spring.config.name=myproject ``` You can also refer to an explicit location by using the `spring.config.location` environment property. This property accepts a comma-separated list of one or more locations to check. The following example shows how to specify two distinct files: ```shell $ java -jar myproject.jar --spring.config.location=\ optional:classpath:/default.properties,\ optional:classpath:/override.properties ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Use the prefix `optional:` if the [locations are optional](#features.external-config.files.optional-prefix) and you do not mind if they do not exist. | | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | `spring.config.name`, `spring.config.location`, and `spring.config.additional-location` are used very early to determine which files have to be loaded. They must be defined as an environment property (typically an OS environment variable, a system property, or a command-line argument). | If `spring.config.location` contains directories (as opposed to files), they should end in `/`. At runtime they will be appended with the names generated from `spring.config.name` before being loaded. Files specified in `spring.config.location` are imported directly. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Both directory and file location values are also expanded to check for [profile-specific files](#features.external-config.files.profile-specific). For example, if you have a `spring.config.location` of `classpath:myconfig.properties`, you will also find appropriate `classpath:myconfig-.properties` files are loaded. | In most situations, each `spring.config.location` item you add will reference a single file or directory. Locations are processed in the order that they are defined and later ones can override the values of earlier ones. If you have a complex location setup, and you use profile-specific configuration files, you may need to provide further hints so that Spring Boot knows how they should be grouped. A location group is a collection of locations that are all considered at the same level. For example, you might want to group all classpath locations, then all external locations. Items within a location group should be separated with `;`. See the example in the [Profile Specific Files](#features.external-config.files.profile-specific) section for more details. Locations configured by using `spring.config.location` replace the default locations. For example, if `spring.config.location` is configured with the value `optional:classpath:/custom-config/,optional:file:./custom-config/`, the complete set of locations considered is: 1. `optional:classpath:custom-config/` 2. `optional:file:./custom-config/` If you prefer to add additional locations, rather than replacing them, you can use `spring.config.additional-location`. Properties loaded from additional locations can override those in the default locations. For example, if `spring.config.additional-location` is configured with the value `optional:classpath:/custom-config/,optional:file:./custom-config/`, the complete set of locations considered is: 1. `optional:classpath:/;optional:classpath:/config/` 2. `optional:file:./;optional:file:./config/;optional:file:./config/*/` 3. `optional:classpath:custom-config/` 4. `optional:file:./custom-config/` This search ordering lets you specify default values in one configuration file and then selectively override those values in another. You can provide default values for your application in `application.properties` (or whatever other basename you choose with `spring.config.name`) in one of the default locations. These default values can then be overridden at runtime with a different file located in one of the custom locations. ### [](#features.external-config.files.optional-prefix)Optional Locations By default, when a specified config data location does not exist, Spring Boot will throw a [`ConfigDataLocationNotFoundException`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/config/ConfigDataLocationNotFoundException.html) and your application will not start. If you want to specify a location, but you do not mind if it does not always exist, you can use the `optional:` prefix. You can use this prefix with the `spring.config.location` and `spring.config.additional-location` properties, as well as with [`spring.config.import`](#features.external-config.files.importing) declarations. For example, a `spring.config.import` value of `optional:file:./myconfig.properties` allows your application to start, even if the `myconfig.properties` file is missing. If you want to ignore all [`ConfigDataLocationNotFoundException`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/config/ConfigDataLocationNotFoundException.html) errors and always continue to start your application, you can use the `spring.config.on-not-found` property. Set the value to `ignore` using `SpringApplication.setDefaultProperties(…​)` or with a system/environment variable. ### [](#features.external-config.files.wildcard-locations)Wildcard Locations If a config file location includes the `*` character for the last path segment, it is considered a wildcard location. Wildcards are expanded when the config is loaded so that immediate subdirectories are also checked. Wildcard locations are particularly useful in an environment such as Kubernetes when there are multiple sources of config properties. For example, if you have some Redis configuration and some MySQL configuration, you might want to keep those two pieces of configuration separate, while requiring that both those are present in an `application.properties` file. This might result in two separate `application.properties` files mounted at different locations such as `/config/redis/application.properties` and `/config/mysql/application.properties`. In such a case, having a wildcard location of `config/*/`, will result in both files being processed. By default, Spring Boot includes `config/*/` in the default search locations. It means that all subdirectories of the `/config` directory outside of your jar will be searched. You can use wildcard locations yourself with the `spring.config.location` and `spring.config.additional-location` properties. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | A wildcard location must contain only one `*` and end with `*/` for search locations that are directories or `*/` for search locations that are files. Locations with wildcards are sorted alphabetically based on the absolute path of the file names. | | | | | -- | ------------------------------------------------------------------------------------------------------------- | | ** | Wildcard locations only work with external directories. You cannot use a wildcard in a `classpath:` location. | ### [](#features.external-config.files.profile-specific)Profile Specific Files As well as `application` property files, Spring Boot will also attempt to load profile-specific files using the naming convention `application-{profile}`. For example, if your application activates a profile named `prod` and uses YAML files, then both `application.yaml` and `application-prod.yaml` will be considered. Profile-specific properties are loaded from the same locations as standard `application.properties`, with profile-specific files always overriding the non-specific ones. If several profiles are specified, a last-wins strategy applies. For example, if profiles `prod,live` are specified by the `spring.profiles.active` property, values in `application-prod.properties` can be overridden by those in `application-live.properties`. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | The last-wins strategy applies at the [location group](#features.external-config.files.location-groups) level. A `spring.config.location` of `classpath:/cfg/,classpath:/ext/` will not have the same override rules as `classpath:/cfg/;classpath:/ext/`.For example, continuing our `prod,live` example above, we might have the following files:``` /cfg application-live.properties /ext application-live.properties application-prod.properties ```When we have a `spring.config.location` of `classpath:/cfg/,classpath:/ext/` we process all `/cfg` files before all `/ext` files:1) `/cfg/application-live.properties` 2) `/ext/application-prod.properties` 3) `/ext/application-live.properties`When we have `classpath:/cfg/;classpath:/ext/` instead (with a `;` delimiter) we process `/cfg` and `/ext` at the same level:1) `/ext/application-prod.properties` 2) `/cfg/application-live.properties` 3) `/ext/application-live.properties` | The [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) has a set of default profiles (by default, `[default]`) that are used if no active profiles are set. In other words, if no profiles are explicitly activated, then properties from `application-default` are considered. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Properties files are only ever loaded once. If you have already directly [imported](#features.external-config.files.importing) a profile specific property files then it will not be imported a second time. | ### [](#features.external-config.files.importing)Importing Additional Data Application properties may import further config data from other locations using the `spring.config.import` property. Imports are processed as they are discovered, and are treated as additional documents inserted immediately below the one that declares the import. For example, you might have the following in your classpath `application.properties` file: * Properties * YAML ```properties spring.application.name=myapp spring.config.import=optional:file:./dev.properties ``` ```yaml spring: application: name: "myapp" config: import: "optional:file:./dev.properties" ``` This will trigger the import of a `dev.properties` file in current directory (if such a file exists). Values from the imported `dev.properties` will take precedence over the file that triggered the import. In the above example, the `dev.properties` could redefine `spring.application.name` to a different value. | | | | -- | ----------------------------------------------------------------------------- | | ** | An import will only be imported once no matter how many times it is declared. | By default, properties files are imported using the ISO-8859-1 charset. To change that, you can use the encoding attribute: * Properties * YAML ```properties spring.config.import=classpath:import.properties[encoding=utf-8] ``` ```yaml spring: config: import: "classpath:import.properties[encoding=utf-8]" ``` The `import.properties` file will now be read in UTF-8 encoding. #### [](#features.external-config.files.importing.fixed-and-relative-paths)Using “Fixed” and “Import Relative” Locations Imports may be specified as *fixed* or *import relative* locations. A fixed location always resolves to the same underlying resource, regardless of where the `spring.config.import` property is declared. An import relative location resolves relative to the file that declares the `spring.config.import` property. A location starting with a forward slash (`/`) or a URL style prefix (`file:`, `classpath:`, etc.) is considered fixed. All other locations are considered import relative. | | | | -- | --------------------------------------------------------------------------------------------------- | | ** | `optional:` prefixes are not considered when determining if a location is fixed or import relative. | As an example, say we have a `/demo` directory containing our `application.jar` file. We might add a `/demo/application.properties` file with the following content: ```properties spring.config.import=optional:core/core.properties ``` This is an import relative location and so will attempt to load the file `/demo/core/core.properties` if it exists. If `/demo/core/core.properties` has the following content: ```properties spring.config.import=optional:extra/extra.properties ``` It will attempt to load `/demo/core/extra/extra.properties`. The `optional:extra/extra.properties` is relative to `/demo/core/core.properties` so the full directory is `/demo/core/` + `extra/extra.properties`. #### [](#features.external-config.files.importing.import-property-order)Property Ordering The order an import is defined inside a single document within the properties/yaml file does not matter. For instance, the two examples below produce the same result: * Properties * YAML ```properties spring.config.import=my.properties my.property=value ``` ```yaml spring: config: import: "my.properties" my: property: "value" ``` * Properties * YAML ```properties my.property=value spring.config.import=my.properties ``` ```yaml my: property: "value" spring: config: import: "my.properties" ``` In both of the above examples, the values from the `my.properties` file will take precedence over the file that triggered its import. Several locations can be specified under a single `spring.config.import` key. Locations will be processed in the order that they are defined, with later imports taking precedence. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | When appropriate, [Profile-specific variants](#features.external-config.files.profile-specific) are also considered for import. The example above would import both `my.properties` as well as any `my-.properties` variants. | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Spring Boot includes pluggable API that allows various different location addresses to be supported. By default you can import Java Properties, YAML and [configuration trees](#features.external-config.files.configtree).Third-party jars can offer support for additional technologies (there is no requirement for files to be local). For example, you can imagine config data being from external stores such as Consul, Apache ZooKeeper or Netflix Archaius.If you want to support your own locations, see the [`ConfigDataLocationResolver`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/config/ConfigDataLocationResolver.html) and [`ConfigDataLoader`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/config/ConfigDataLoader.html) classes in the `org.springframework.boot.context.config` package. | ### [](#features.external-config.files.importing-extensionless)Importing Extensionless Files Some cloud platforms cannot add a file extension to volume mounted files. To import these extensionless files, you need to give Spring Boot a hint so that it knows how to load them. You can do this by putting an extension hint in square brackets. For example, suppose you have a `/etc/config/myconfig` file that you wish to import as yaml. You can import it from your `application.properties` using the following: * Properties * YAML ```properties spring.config.import=file:/etc/config/myconfig[.yaml] ``` ```yaml spring: config: import: "file:/etc/config/myconfig[.yaml]" ``` This is the shorthand for: * Properties * YAML ```properties spring.config.import=file:/etc/config/myconfig[extension=.yaml] ``` ```yaml spring: config: import: "file:/etc/config/myconfig[extension=.yaml]" ``` ### [](#features.external-config.files.attributes)File attributes The `spring.config.import` configuration property supports file attributes, as shown when specifying the [encoding](#features.external-config.files.importing) or the [extension](#features.external-config.files.importing-extensionless). If you need to specify multiple attributes, you can use this syntax: * Properties * YAML ```properties spring.config.import=file:/etc/config/myconfig[extension=.yaml][encoding=utf-8] ``` ```yaml spring: config: import: "file:/etc/config/myconfig[extension=.yaml][encoding=utf-8]" ``` ### [](#features.external-config.files.env-variables)Using Environment Variables When running applications on a cloud platform (such as Kubernetes) you often need to read config values that the platform supplies. You can either use environment variables for such purpose, or you can use [configuration trees](#features.external-config.files.configtree). You can even store whole configurations in properties or yaml format in (multiline) environment variables and load them using the `env:` prefix. Assume there’s an environment variable called `MY_CONFIGURATION` with this content: ```properties my.name=Service1 my.cluster=Cluster1 ``` Using the `env:` prefix it is possible to import all properties from this variable: * Properties * YAML ```properties spring.config.import=env:MY_CONFIGURATION ``` ```yaml spring: config: import: "env:MY_CONFIGURATION" ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | This feature also supports [specifying the extension](#features.external-config.files.importing-extensionless). The default extension is `.properties`. | ### [](#features.external-config.files.configtree)Using Configuration Trees Storing config values in environment variables has drawbacks, especially if the value is supposed to be kept secret. As an alternative to environment variables, many cloud platforms now allow you to map configuration into mounted data volumes. For example, Kubernetes can volume mount both [`ConfigMaps`](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#populate-a-volume-with-data-stored-in-a-configmap) and [`Secrets`](https://kubernetes.io/docs/concepts/configuration/secret/#using-secrets-as-files-from-a-pod). There are two common volume mount patterns that can be used: 1. A single file contains a complete set of properties (usually written as YAML). 2. Multiple files are written to a directory tree, with the filename becoming the ‘key’ and the contents becoming the ‘value’. For the first case, you can import the YAML or Properties file directly using `spring.config.import` as described [above](#features.external-config.files.importing). For the second case, you need to use the `configtree:` prefix so that Spring Boot knows it needs to expose all the files as properties. As an example, let’s imagine that Kubernetes has mounted the following volume: ```none etc/ config/ myapp/ username password ``` The contents of the `username` file would be a config value, and the contents of `password` would be a secret. To import these properties, you can add the following to your `application.properties` or `application.yaml` file: * Properties * YAML ```properties spring.config.import=optional:configtree:/etc/config/ ``` ```yaml spring: config: import: "optional:configtree:/etc/config/" ``` You can then access or inject `myapp.username` and `myapp.password` properties from the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) in the usual way. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The names of the folders and files under the config tree form the property name. In the above example, to access the properties as `username` and `password`, you can set `spring.config.import` to `optional:configtree:/etc/config/myapp`. | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Filenames with dot notation are also correctly mapped. For example, in the above example, a file named `myapp.username` in `/etc/config` would result in a `myapp.username` property in the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html). | | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Configuration tree values can be bound to both string [`String`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html) and `byte[]` types depending on the contents expected. | If you have multiple config trees to import from the same parent folder you can use a wildcard shortcut. Any `configtree:` location that ends with `/*/` will import all immediate children as config trees. As with a non-wildcard import, the names of the folders and files under each config tree form the property name. For example, given the following volume: ```none etc/ config/ dbconfig/ db/ username password mqconfig/ mq/ username password ``` You can use `configtree:/etc/config/*/` as the import location: * Properties * YAML ```properties spring.config.import=optional:configtree:/etc/config/*/ ``` ```yaml spring: config: import: "optional:configtree:/etc/config/*/" ``` This will add `db.username`, `db.password`, `mq.username` and `mq.password` properties. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Directories loaded using a wildcard are sorted alphabetically. If you need a different order, then you should list each location as a separate import | Configuration trees can also be used for Docker secrets. When a Docker swarm service is granted access to a secret, the secret gets mounted into the container. For example, if a secret named `db.password` is mounted at location `/run/secrets/`, you can make `db.password` available to the Spring environment using the following: * Properties * YAML ```properties spring.config.import=optional:configtree:/run/secrets/ ``` ```yaml spring: config: import: "optional:configtree:/run/secrets/" ``` ### [](#features.external-config.files.property-placeholders)Property Placeholders The values in `application.properties` and `application.yaml` are filtered through the existing [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) when they are used, so you can refer back to previously defined values (for example, from System properties or environment variables). The standard `${name}` property-placeholder syntax can be used anywhere within a value. Property placeholders can also specify a default value using a `:` to separate the default value from the property name, for example `${name:default}`. The use of placeholders with and without defaults is shown in the following example: * Properties * YAML ```properties app.name=MyApp app.description=${app.name} is a Spring Boot application written by ${username:Unknown} ``` ```yaml app: name: "MyApp" description: "${app.name} is a Spring Boot application written by ${username:Unknown}" ``` Assuming that the `username` property has not been set elsewhere, `app.description` will have the value `MyApp is a Spring Boot application written by Unknown`. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You should always refer to property names in the placeholder using their canonical form (kebab-case using only lowercase letters). This will allow Spring Boot to use the same logic as it does when [relaxed binding](#features.external-config.typesafe-configuration-properties.relaxed-binding) [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html).For example, `${demo.item-price}` will pick up `demo.item-price` and `demo.itemPrice` forms from the `application.properties` file, as well as `DEMO_ITEMPRICE` from the system environment. If you use `${demo.itemPrice}` instead, it will pick up the `demo.itemPrice` form from the `application.properties` file, as well as `DEMO_ITEMPRICE` from the system environment, but `demo.item-price` would not be considered. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can also use this technique to create “short” variants of existing Spring Boot properties. See the [Use ‘Short’ Command Line Arguments](../../how-to/properties-and-configuration.html#howto.properties-and-configuration.short-command-line-arguments) section in “How-to Guides” for details. | ### [](#features.external-config.files.multi-document)Working With Multi-Document Files Spring Boot allows you to split a single physical file into multiple logical documents which are each added independently. Documents are processed in order, from top to bottom. Later documents can override the properties defined in earlier ones. For `application.yaml` files, the standard YAML multi-document syntax is used. Three consecutive hyphens represent the end of one document, and the start of the next. For example, the following file has two logical documents: ```yaml spring: application: name: "MyApp" --- spring: application: name: "MyCloudApp" config: activate: on-cloud-platform: "kubernetes" ``` For `application.properties` files a special `#---` or `!---` comment is used to mark the document splits: ```properties spring.application.name=MyApp #--- spring.application.name=MyCloudApp spring.config.activate.on-cloud-platform=kubernetes ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Property file separators must not have any leading whitespace and must have exactly three hyphen characters. The lines immediately before and after the separator must not be same comment prefix. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Multi-document property files are often used in conjunction with activation properties such as `spring.config.activate.on-profile`. See the [next section](#features.external-config.files.activation-properties) for details. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Multi-document property files cannot be loaded by using the [`@PropertySource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/PropertySource.html) or [`@TestPropertySource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/context/TestPropertySource.html) annotations. | ### [](#features.external-config.files.activation-properties)Activation Properties It is sometimes useful to only activate a given set of properties when certain conditions are met. For example, you might have properties that are only relevant when a specific profile is active. You can conditionally activate a properties document using `spring.config.activate.*`. The following activation properties are available: | Property | Note | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `on-profile` | A profile expression that must match for the document to be active, or a list of profile expressions of which at least one must match for the document to be active. | | `on-cloud-platform` | The [`CloudPlatform`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/cloud/CloudPlatform.html) that must be detected for the document to be active. | For example, the following specifies that the second document is only active when running on Kubernetes, and only when either the “prod” or “staging” profiles are active: * Properties * YAML ```properties myprop=always-set #--- spring.config.activate.on-cloud-platform=kubernetes spring.config.activate.on-profile=prod | staging myotherprop=sometimes-set ``` ```yaml myprop: "always-set" --- spring: config: activate: on-cloud-platform: "kubernetes" on-profile: "prod | staging" myotherprop: "sometimes-set" ``` ## [](#features.external-config.encrypting)Encrypting Properties Spring Boot does not provide any built-in support for encrypting property values, however, it does provide the hook points necessary to modify values contained in the Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html). The [`EnvironmentPostProcessor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/EnvironmentPostProcessor.html) interface allows you to manipulate the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) before the application starts. See [Customize the Environment or ApplicationContext Before It Starts](../../how-to/application.html#howto.application.customize-the-environment-or-application-context) for details. If you need a secure way to store credentials and passwords, the [Spring Cloud Vault](https://cloud.spring.io/spring-cloud-vault/) project provides support for storing externalized configuration in [HashiCorp Vault](https://www.vaultproject.io/). ## [](#features.external-config.yaml)Working With YAML [YAML](https://yaml.org) is a superset of JSON and, as such, is a convenient format for specifying hierarchical configuration data. The [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) class automatically supports YAML as an alternative to properties whenever you have the [SnakeYAML](https://github.com/snakeyaml/snakeyaml) library on your classpath. | | | | -- | ---------------------------------------------------------------------------------- | | ** | If you use starters, SnakeYAML is automatically provided by `spring-boot-starter`. | ### [](#features.external-config.yaml.mapping-to-properties)Mapping YAML to Properties YAML documents need to be converted from their hierarchical format to a flat structure that can be used with the Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html). For example, consider the following YAML document: ```yaml environments: dev: url: "https://dev.example.com" name: "Developer Setup" prod: url: "https://another.example.com" name: "My Cool App" ``` In order to access these properties from the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html), they would be flattened as follows: ```properties environments.dev.url=https://dev.example.com environments.dev.name=Developer Setup environments.prod.url=https://another.example.com environments.prod.name=My Cool App ``` Likewise, YAML lists also need to be flattened. They are represented as property keys with `[index]` dereferencers. For example, consider the following YAML: ```yaml my: servers: - "dev.example.com" - "another.example.com" ``` The preceding example would be transformed into these properties: ```properties my.servers[0]=dev.example.com my.servers[1]=another.example.com ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Properties that use the `[index]` notation can be bound to Java [`List`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html) or [`Set`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html) objects using Spring Boot’s [`Binder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/bind/Binder.html) class. For more details see the [Type-safe Configuration Properties](#features.external-config.typesafe-configuration-properties) section below. | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | YAML files cannot be loaded by using the [`@PropertySource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/PropertySource.html) or [`@TestPropertySource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/context/TestPropertySource.html) annotations. So, in the case that you need to load values that way, you need to use a properties file. | ### [](#features.external-config.yaml.directly-loading)Directly Loading YAML Spring Framework provides two convenient classes that can be used to load YAML documents. The [`YamlPropertiesFactoryBean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/config/YamlPropertiesFactoryBean.html) loads YAML as [`Properties`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Properties.html) and the [`YamlMapFactoryBean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/config/YamlMapFactoryBean.html) loads YAML as a [`Map`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html). You can also use the [`YamlPropertySourceLoader`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/env/YamlPropertySourceLoader.html) class if you want to load YAML as a Spring [`PropertySource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/PropertySource.html). ## [](#features.external-config.random-values)Configuring Random Values The [`RandomValuePropertySource`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/env/RandomValuePropertySource.html) is useful for injecting random values (for example, into secrets or test cases). It can produce integers, longs, uuids, or strings, as shown in the following example: * Properties * YAML ```properties my.secret=${random.value} my.number=${random.int} my.bignumber=${random.long} my.uuid=${random.uuid} my.number-less-than-ten=${random.int(10)} my.number-in-range=${random.int[1024,65536]} ``` ```yaml my: secret: "${random.value}" number: "${random.int}" bignumber: "${random.long}" uuid: "${random.uuid}" number-less-than-ten: "${random.int(10)}" number-in-range: "${random.int[1024,65536]}" ``` The `random.int*` syntax is `OPEN value (,max) CLOSE` where the `OPEN,CLOSE` are any character and `value,max` are integers. If `max` is provided, then `value` is the minimum value and `max` is the maximum value (exclusive). ## [](#features.external-config.system-environment)Configuring System Environment Properties Spring Boot supports setting a prefix for environment properties. This is useful if the system environment is shared by multiple Spring Boot applications with different configuration requirements. The prefix for system environment properties can be set directly on [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) by calling the `setEnvironmentPrefix(…​)` method before the application is run. For example, if you set the prefix to `input`, a property such as `remote.timeout` will be resolved as `INPUT_REMOTE_TIMEOUT` in the system environment. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The prefix *only* applies to system environment properties. The example above would continue to use `remote.timeout` when reading properties from other sources. | ## [](#features.external-config.typesafe-configuration-properties)Type-safe Configuration Properties Using the `@Value("${property}")` annotation to inject configuration properties can sometimes be cumbersome, especially if you are working with multiple properties or your data is hierarchical in nature. Spring Boot provides an alternative method of working with properties that lets strongly typed beans govern and validate the configuration of your application. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | See also the [differences between ](#features.external-config.typesafe-configuration-properties.vs-value-annotation)[`@Value`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Value.html) and type-safe configuration properties. | ### [](#features.external-config.typesafe-configuration-properties.java-bean-binding)JavaBean Properties Binding It is possible to bind a bean declaring standard JavaBean properties as shown in the following example: * Java * Kotlin ```java import java.net.InetAddress; import java.util.ArrayList; import java.util.Collections; import java.util.List; import org.springframework.boot.context.properties.ConfigurationProperties; @ConfigurationProperties("my.service") public class MyProperties { private boolean enabled; private InetAddress remoteAddress; private final Security security = new Security(); // getters / setters... public boolean isEnabled() { return this.enabled; } public void setEnabled(boolean enabled) { this.enabled = enabled; } public InetAddress getRemoteAddress() { return this.remoteAddress; } public void setRemoteAddress(InetAddress remoteAddress) { this.remoteAddress = remoteAddress; } public Security getSecurity() { return this.security; } public static class Security { private String username; private String password; private List roles = new ArrayList<>(Collections.singleton("USER")); // getters / setters... public String getUsername() { return this.username; } public void setUsername(String username) { this.username = username; } public String getPassword() { return this.password; } public void setPassword(String password) { this.password = password; } public List getRoles() { return this.roles; } public void setRoles(List roles) { this.roles = roles; } } } ``` ```kotlin import org.springframework.boot.context.properties.ConfigurationProperties import java.net.InetAddress @ConfigurationProperties("my.service") class MyProperties { var isEnabled = false var remoteAddress: InetAddress? = null val security = Security() class Security { var username: String? = null var password: String? = null var roles: List = ArrayList(setOf("USER")) } } ``` The preceding POJO defines the following properties: * `my.service.enabled`, with a value of `false` by default. * `my.service.remote-address`, with a type that can be coerced from [`String`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html). * `my.service.security.username`, with a nested "security" object whose name is determined by the name of the property. In particular, the type is not used at all there and could have been [`SecurityProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/security/autoconfigure/SecurityProperties.html). * `my.service.security.password`. * `my.service.security.roles`, with a collection of [`String`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html) that defaults to `USER`. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | To use a reserved keyword in the name of a property, such as `my.service.import`, use the [`@Name`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/bind/Name.html) annotation on the property’s field. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The properties that map to [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) classes available in Spring Boot, which are configured through properties files, YAML files, environment variables, and other mechanisms, are public API but the accessors (getters/setters) of the class itself are not meant to be used directly. | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Such arrangement relies on a default empty constructor and getters and setters are usually mandatory, since binding is through standard Java Beans property descriptors, just like in Spring MVC. A setter may be omitted in the following cases:- Pre-initialized Maps and Collections, as long as they are initialized with a mutable implementation (like the `roles` field in the preceding example). - Pre-initialized nested POJOs (like the `Security` field in the preceding example). If you want the binder to create the instance on the fly by using its default constructor, you need a setter.Some people use Project Lombok to add getters and setters automatically. Make sure that Lombok does not generate any particular constructor for such a type, as it is used automatically by the container to instantiate the object.Finally, only standard Java Bean properties are considered and binding on static properties is not supported. | ### [](#features.external-config.typesafe-configuration-properties.constructor-binding)Constructor Binding The example in the previous section can be rewritten in an immutable fashion as shown in the following example: * Java * Kotlin ```java import java.net.InetAddress; import java.util.List; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.context.properties.bind.DefaultValue; @ConfigurationProperties("my.service") public class MyProperties { // fields... private final boolean enabled; private final InetAddress remoteAddress; private final Security security; public MyProperties(boolean enabled, InetAddress remoteAddress, Security security) { this.enabled = enabled; this.remoteAddress = remoteAddress; this.security = security; } // getters... public boolean isEnabled() { return this.enabled; } public InetAddress getRemoteAddress() { return this.remoteAddress; } public Security getSecurity() { return this.security; } public static class Security { // fields... private final String username; private final String password; private final List roles; public Security(String username, String password, @DefaultValue("USER") List roles) { this.username = username; this.password = password; this.roles = roles; } // getters... public String getUsername() { return this.username; } public String getPassword() { return this.password; } public List getRoles() { return this.roles; } } } ``` ```kotlin import org.springframework.boot.context.properties.ConfigurationProperties import org.springframework.boot.context.properties.bind.DefaultValue import java.net.InetAddress @ConfigurationProperties("my.service") class MyProperties(val enabled: Boolean, val remoteAddress: InetAddress, val security: Security) { class Security(val username: String, val password: String, @param:DefaultValue("USER") val roles: List) } ``` In this setup, the presence of a single parameterized constructor implies that constructor binding should be used. This means that the binder will find a constructor with the parameters that you wish to have bound. If your class has multiple constructors, the [`@ConstructorBinding`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/bind/ConstructorBinding.html) annotation can be used to specify which constructor to use for constructor binding. To opt-out of constructor binding for a class, the parameterized constructor must be annotated with [`@Autowired`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Autowired.html) or made `private`. Kotlin developers can use an empty primary constructor to opt-out of constructor binding. For example: * Java * Kotlin ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.context.properties.ConfigurationProperties; @ConfigurationProperties("my") public class MyProperties { // fields... final MyBean myBean; private String name; @Autowired public MyProperties(MyBean myBean) { this.myBean = myBean; } // getters / setters... public String getName() { return this.name; } public void setName(String name) { this.name = name; } } ``` ```kotlin import org.springframework.boot.context.properties.ConfigurationProperties @ConfigurationProperties("my") class MyProperties() { constructor(name: String) : this() { this.name = name } // vars... var name: String? = null } ``` Constructor binding can be used with records. Unless your record has multiple constructors, there is no need to use [`@ConstructorBinding`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/bind/ConstructorBinding.html). Nested members of a constructor bound class (such as `Security` in the example above) will also be bound through their constructor. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | To use constructor binding the class must be enabled using [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) or configuration property scanning. You cannot use constructor binding with beans that are created by the regular Spring mechanisms (for example [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) beans, beans created by using [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) methods or beans loaded by using [`@Import`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Import.html)) | | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | To use constructor binding the class must be compiled with `-parameters`. This will happen automatically if you use Spring Boot’s Gradle plugin or if you use Maven and `spring-boot-starter-parent`. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The use of [`Optional`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html) with [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) is not recommended as it is primarily intended for use as a return type. As such, it is not well-suited to configuration property injection. If you do declare an [`Optional`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html) constructor-bound property and it has no value, an empty [`Optional`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html) will be bound. | | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | To use a reserved keyword in the name of a property, such as `my.service.import`, use the [`@Name`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/bind/Name.html) annotation on the constructor parameter. | #### [](#features.external-config.typesafe-configuration-properties.constructor-binding.default-values)@DefaultValue and Binding Default values can be specified using [`@DefaultValue`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/bind/DefaultValue.html) on constructor parameters and record components. The conversion service will be applied to coerce the annotation’s [`String`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html) value to the target type of a missing property. In the `MyProperties` example above, you can see the nested `Security` class uses `@DefaultValue("USER")` for the `roles` parameter. This means that if `security` properties are defined, but `roles` is not, the default of `"USER"` will be bound. For example, the following properties: * Properties * YAML ```properties my.service.enabled=true my.service.security.username=admin ``` ```yaml my: service: enabled: true security: username: admin ``` Will be bound as `new MyProperties(true, null, new Security("admin", null, List.of("USER")))` If the `security` property is not present at all, then the `Security` instance will be `null`. For example, the following properties: * Properties * YAML ```properties my.service.enabled=true ``` ```yaml my: service: enabled: true ``` Will be bound as `new MyProperties(true, null, null)` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can define an empty `security` property if you want to trigger binding with fully default `Security` instance.For YAML, you can use the following syntax:```yaml my: service: enabled: true security: {} ```With `Properties` you can use:```properties my.service.enabled=true my.service.security= ```Will be bound as `new MyProperties(true, null, new Security(null, null, List.of("USER")))` | If you want to always bind a non-null instance of `Security`, even when properties are missing, you can use an empty [`@DefaultValue`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/bind/DefaultValue.html) annotation: * Java * Kotlin ```java public MyProperties(boolean enabled, InetAddress remoteAddress, @DefaultValue Security security) { this.enabled = enabled; this.remoteAddress = remoteAddress; this.security = security; } ``` ```kotlin class MyProperties(val enabled: Boolean, val remoteAddress: InetAddress, @DefaultValue val security: Security) { class Security(val username: String?, val password: String?, @param:DefaultValue("USER") val roles: List) } ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------- | | ** | When using Kotlin, you will need to declare the `username` and `password` parameters as nullable since they do not have default values | ### [](#features.external-config.typesafe-configuration-properties.default-values)Default Values Default Values defined in configuration properties are not reflected in the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html). In the examples above, the `enabled` property of `MyProperties` bound to `my.service` is `false` by default. However, `my.service.enabled` is not available in the `Environment` with a value of `false` if no such property is set by the user. Concretely, this prevents you from using `@Value("${my.service.enabled}")` or `my.service.enabled` as a placeholder in configuration properties without explicitly providing a default. If you need to query the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) for that property, for instance in a [`Condition`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Condition.html) implementation, the default needs to be provided as well. ### [](#features.external-config.typesafe-configuration-properties.enabling-annotated-types)Enabling @ConfigurationProperties-annotated Types Spring Boot provides infrastructure to bind [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) types and register them as beans. You can either enable configuration properties on a class-by-class basis or enable configuration property scanning that works in a similar manner to component scanning. Sometimes, classes annotated with [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) might not be suitable for scanning, for example, if you’re developing your own auto-configuration or you want to enable them conditionally. In these cases, specify the list of types to process using the [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) annotation. This can be done on any [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class, as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) @EnableConfigurationProperties(SomeProperties.class) public class MyConfiguration { } ``` ```kotlin import org.springframework.boot.context.properties.EnableConfigurationProperties import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) @EnableConfigurationProperties(SomeProperties::class) class MyConfiguration ``` * Java * Kotlin ```java import org.springframework.boot.context.properties.ConfigurationProperties; @ConfigurationProperties("some.properties") public class SomeProperties { } ``` ```kotlin import org.springframework.boot.context.properties.ConfigurationProperties @ConfigurationProperties("some.properties") class SomeProperties ``` To use configuration property scanning, add the [`@ConfigurationPropertiesScan`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationPropertiesScan.html) annotation to your application. Typically, it is added to the main application class that is annotated with [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html) but it can be added to any [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class. By default, scanning will occur from the package of the class that declares the annotation. If you want to define specific packages to scan, you can do so as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.context.properties.ConfigurationPropertiesScan; @SpringBootApplication @ConfigurationPropertiesScan({ "com.example.app", "com.example.another" }) public class MyApplication { } ``` ```kotlin import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.context.properties.ConfigurationPropertiesScan @SpringBootApplication @ConfigurationPropertiesScan("com.example.app", "com.example.another") class MyApplication ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | When the [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) bean is registered using configuration property scanning or through [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html), the bean has a conventional name: `-`, where `` is the environment key prefix specified in the [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) annotation and `` is the fully qualified name of the bean. If the annotation does not provide any prefix, only the fully qualified name of the bean is used.Assuming that it is in the `com.example.app` package, the bean name of the `SomeProperties` example above is `some.properties-com.example.app.SomeProperties`. | We recommend that [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) only deal with the environment and, in particular, does not inject other beans from the context. For corner cases, setter injection can be used or any of the `*Aware` interfaces provided by the framework (such as [`EnvironmentAware`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/EnvironmentAware.html) if you need access to the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html)). If you still want to inject other beans using the constructor, the configuration properties bean must be annotated with [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) and use JavaBean-based property binding. ### [](#features.external-config.typesafe-configuration-properties.using-annotated-types)Using @ConfigurationProperties-annotated Types This style of configuration works particularly well with the [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) external YAML configuration, as shown in the following example: ```yaml my: service: remote-address: 192.168.1.1 security: username: "admin" roles: - "USER" - "ADMIN" ``` To work with [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans, you can inject them in the same way as any other bean, as shown in the following example: * Java * Kotlin ```java import org.springframework.stereotype.Service; @Service public class MyService { private final MyProperties properties; public MyService(MyProperties properties) { this.properties = properties; } public void openConnection() { Server server = new Server(this.properties.getRemoteAddress()); server.start(); // ... } // ... } ``` ```kotlin import org.springframework.stereotype.Service @Service class MyService(val properties: MyProperties) { fun openConnection() { val server = Server(properties.remoteAddress) server.start() // ... } // ... } ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Using [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) also lets you generate metadata files that can be used by IDEs to offer auto-completion for your own keys. See the [appendix](../../specification/configuration-metadata/index.html) for details. | ### [](#features.external-config.typesafe-configuration-properties.third-party-configuration)Third-party Configuration As well as using [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) to annotate a class, you can also use it on public [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) methods. Doing so can be particularly useful when you want to bind properties to third-party components that are outside of your control. To configure a bean from the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) properties, add [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) to its bean registration, as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class ThirdPartyConfiguration { @Bean @ConfigurationProperties("another") public AnotherComponent anotherComponent() { return new AnotherComponent(); } } ``` ```kotlin import org.springframework.boot.context.properties.ConfigurationProperties import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class ThirdPartyConfiguration { @Bean @ConfigurationProperties("another") fun anotherComponent(): AnotherComponent = AnotherComponent() } ``` Any JavaBean property defined with the `another` prefix is mapped onto that `AnotherComponent` bean in manner similar to the preceding `SomeProperties` example. ### [](#features.external-config.typesafe-configuration-properties.relaxed-binding)Relaxed Binding Spring Boot uses some relaxed rules for binding [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) properties to [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans, so there does not need to be an exact match between the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) property name and the bean property name. Common examples where this is useful include dash-separated environment properties (for example, `context-path` binds to `contextPath`), and capitalized environment properties (for example, `PORT` binds to `port`). As an example, consider the following [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) class: * Java * Kotlin ```java import org.springframework.boot.context.properties.ConfigurationProperties; @ConfigurationProperties("my.main-project.person") public class MyPersonProperties { private String firstName; public String getFirstName() { return this.firstName; } public void setFirstName(String firstName) { this.firstName = firstName; } } ``` ```kotlin import org.springframework.boot.context.properties.ConfigurationProperties @ConfigurationProperties("my.main-project.person") class MyPersonProperties { var firstName: String? = null } ``` With the preceding code, the following properties names can all be used: | Property | Note | | ----------------------------------- | -------------------------------------------------------------------------------------------- | | `my.main-project.person.first-name` | Kebab case, which is recommended for use in `.properties` and YAML files. | | `my.main-project.person.firstName` | Standard camel case syntax. | | `my.main-project.person.first_name` | Underscore notation, which is an alternative format for use in `.properties` and YAML files. | | `MY_MAINPROJECT_PERSON_FIRSTNAME` | Upper case format, which is recommended when using system environment variables. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------- | | ** | The `prefix` value for the annotation *must* be in kebab case (lowercase and separated by `-`, such as `my.main-project.person`). | | Property Source | Simple | List | | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Properties Files | Camel case, kebab case, or underscore notation | Standard list syntax using `[ ]` or comma-separated values | | YAML Files | Camel case, kebab case, or underscore notation | Standard YAML list syntax or comma-separated values | | Environment Variables | Upper case format with underscore as the delimiter (see [Binding From Environment Variables](#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables)). | Numeric values surrounded by underscores (see [Binding From Environment Variables](#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables)) | | System properties | Camel case, kebab case, or underscore notation | Standard list syntax using `[ ]` or comma-separated values | | | | | -- | ----------------------------------------------------------------------------------------------------------------------- | | ** | We recommend that, when possible, properties are stored in lower-case kebab format, such as `my.person.first-name=Rod`. | #### [](#features.external-config.typesafe-configuration-properties.relaxed-binding.maps)Binding Maps When binding to [`Map`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html) properties you may need to use a special bracket notation so that the original `key` value is preserved. If the key is not surrounded by `[]`, any characters that are not alpha-numeric, `-` or `.` are removed. For example, consider binding the following properties to a `Map`: * Properties * YAML ```properties my.map[/key1]=value1 my.map[/key2]=value2 my.map./key3=value3 ``` ```yaml my: map: "[/key1]": "value1" "[/key2]": "value2" "/key3": "value3" ``` | | | | -- | ------------------------------------------------------------------------------------------------ | | ** | For YAML files, the brackets need to be surrounded by quotes for the keys to be parsed properly. | The properties above will bind to a [`Map`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html) with `/key1`, `/key2` and `key3` as the keys in the map. The slash has been removed from `key3` because it was not surrounded by square brackets. When binding to scalar values, keys with `.` in them do not need to be surrounded by `[]`. Scalar values include enums and all types in the `java.lang` package except for [`Object`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html). Binding `a.b=c` to `Map` will preserve the `.` in the key and return a Map with the entry `{"a.b"="c"}`. For any other types you need to use the bracket notation if your `key` contains a `.`. For example, binding `a.b=c` to `Map` will return a Map with the entry `{"a"={"b"="c"}}` whereas `[a.b]=c` will return a Map with the entry `{"a.b"="c"}`. #### [](#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables)Binding From Environment Variables Most operating systems impose strict rules around the names that can be used for environment variables. For example, Linux shell variables can contain only letters (`a` to `z` or `A` to `Z`), numbers (`0` to `9`) or the underscore character (`_`). By convention, Unix shell variables will also have their names in UPPERCASE. Spring Boot’s relaxed binding rules are, as much as possible, designed to be compatible with these naming restrictions. To convert a property name in the canonical-form to an environment variable name you can follow these rules: * Replace dots (`.`) with underscores (`_`). * Remove any dashes (`-`). * Convert to uppercase. For example, the configuration property `spring.main.log-startup-info` would be an environment variable named `SPRING_MAIN_LOGSTARTUPINFO`. Environment variables can also be used when binding to object lists. To bind to a [`List`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html), the element number should be surrounded with underscores in the variable name. For example, the configuration property `my.service[0].other` would use an environment variable named `MY_SERVICE_0_OTHER`. Support for binding from environment variables is applied to the `systemEnvironment` property source and to any additional property source whose name ends with `-systemEnvironment`. #### [](#features.external-config.typesafe-configuration-properties.relaxed-binding.maps-from-environment-variables)Binding Maps From Environment Variables When Spring Boot binds an environment variable to a property class, it lowercases the environment variable name before binding. Most of the time this detail isn’t important, except when binding to [`Map`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html) properties. The keys in the [`Map`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html) are always in lowercase, as seen in the following example: * Java * Kotlin ```java import java.util.HashMap; import java.util.Map; import org.springframework.boot.context.properties.ConfigurationProperties; @ConfigurationProperties("my.props") public class MyMapsProperties { private final Map values = new HashMap<>(); public Map getValues() { return this.values; } } ``` ```kotlin import org.springframework.boot.context.properties.ConfigurationProperties @ConfigurationProperties("my.props") class MyMapsProperties { val values: Map = HashMap() } ``` When setting `MY_PROPS_VALUES_KEY=value`, the `values` [`Map`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html) contains a `{"key"="value"}` entry. Only the environment variable **name** is lower-cased, not the value. When setting `MY_PROPS_VALUES_KEY=VALUE`, the `values` [`Map`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html) contains a `{"key"="VALUE"}` entry. #### [](#features.external-config.typesafe-configuration-properties.relaxed-binding.caching)Caching Relaxed binding uses a cache to improve performance. By default, this caching is only applied to immutable property sources. To customize this behavior, for example to enable caching for mutable property sources, use [`ConfigurationPropertyCaching`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/source/ConfigurationPropertyCaching.html). ### [](#features.external-config.typesafe-configuration-properties.merging-complex-types)Merging Complex Types When lists are configured in more than one place, overriding works by replacing the entire list. For example, assume a `MyPojo` object with `name` and `description` attributes that are `null` by default. The following example exposes a list of `MyPojo` objects from `MyProperties`: * Java * Kotlin ```java import java.util.ArrayList; import java.util.List; import org.springframework.boot.context.properties.ConfigurationProperties; @ConfigurationProperties("my") public class MyProperties { private final List list = new ArrayList<>(); public List getList() { return this.list; } } ``` ```kotlin import org.springframework.boot.context.properties.ConfigurationProperties @ConfigurationProperties("my") class MyProperties { val list: List = ArrayList() } ``` Consider the following configuration: * Properties * YAML ```properties my.list[0].name=my name my.list[0].description=my description #--- spring.config.activate.on-profile=dev my.list[0].name=my another name ``` ```yaml my: list: - name: "my name" description: "my description" --- spring: config: activate: on-profile: "dev" my: list: - name: "my another name" ``` If the `dev` profile is not active, `MyProperties.list` contains one `MyPojo` entry, as previously defined. If the `dev` profile is enabled, however, the `list` *still* contains only one entry (with a name of `my another name` and a description of `null`). This configuration *does not* add a second `MyPojo` instance to the list, and it does not merge the items. When a [`List`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html) is specified in multiple profiles, the one with the highest priority (and only that one) is used. Consider the following example: * Properties * YAML ```properties my.list[0].name=my name my.list[0].description=my description my.list[1].name=another name my.list[1].description=another description #--- spring.config.activate.on-profile=dev my.list[0].name=my another name ``` ```yaml my: list: - name: "my name" description: "my description" - name: "another name" description: "another description" --- spring: config: activate: on-profile: "dev" my: list: - name: "my another name" ``` In the preceding example, if the `dev` profile is active, `MyProperties.list` contains *one* `MyPojo` entry (with a name of `my another name` and a description of `null`). For YAML, both comma-separated lists and YAML lists can be used for completely overriding the contents of the list. For [`Map`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html) properties, you can bind with property values drawn from multiple sources. However, for the same property in multiple sources, the one with the highest priority is used. The following example exposes a `Map` from `MyProperties`: * Java * Kotlin ```java import java.util.LinkedHashMap; import java.util.Map; import org.springframework.boot.context.properties.ConfigurationProperties; @ConfigurationProperties("my") public class MyProperties { private final Map map = new LinkedHashMap<>(); public Map getMap() { return this.map; } } ``` ```kotlin import org.springframework.boot.context.properties.ConfigurationProperties @ConfigurationProperties("my") class MyProperties { val map: Map = LinkedHashMap() } ``` Consider the following configuration: * Properties * YAML ```properties my.map.key1.name=my name 1 my.map.key1.description=my description 1 #--- spring.config.activate.on-profile=dev my.map.key1.name=dev name 1 my.map.key2.name=dev name 2 my.map.key2.description=dev description 2 ``` ```yaml my: map: key1: name: "my name 1" description: "my description 1" --- spring: config: activate: on-profile: "dev" my: map: key1: name: "dev name 1" key2: name: "dev name 2" description: "dev description 2" ``` If the `dev` profile is not active, `MyProperties.map` contains one entry with key `key1` (with a name of `my name 1` and a description of `my description 1`). If the `dev` profile is enabled, however, `map` contains two entries with keys `key1` (with a name of `dev name 1` and a description of `my description 1`) and `key2` (with a name of `dev name 2` and a description of `dev description 2`). | | | | -- | ---------------------------------------------------------------------------------------------- | | ** | The preceding merging rules apply to properties from all property sources, and not just files. | ### [](#features.external-config.typesafe-configuration-properties.conversion)Properties Conversion Spring Boot attempts to coerce the external application properties to the right type when it binds to the [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans. If you need custom type conversion, you can provide a [`ConversionService`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/convert/ConversionService.html) bean (with a bean named `conversionService`) or custom property editors (through a [`CustomEditorConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/config/CustomEditorConfigurer.html) bean) or custom converters (with bean definitions annotated as [`@ConfigurationPropertiesBinding`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationPropertiesBinding.html)). | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Beans used for property conversion are requested very early during the application lifecycle so make sure to limit the dependencies that your [`ConversionService`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/convert/ConversionService.html) is using. Typically, any dependency that you require may not be fully initialized at creation time. | | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You may want to rename your custom [`ConversionService`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/convert/ConversionService.html) if it is not required for configuration keys coercion and only rely on custom converters qualified with [`@ConfigurationPropertiesBinding`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationPropertiesBinding.html). When qualifying a `@Bean` method with `@ConfigurationPropertiesBinding`, the method should be `static` to avoid “bean is not eligible for getting processed by all BeanPostProcessors” warnings. | #### [](#features.external-config.typesafe-configuration-properties.conversion.durations)Converting Durations Spring Boot has dedicated support for expressing durations. If you expose a [`Duration`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html) property, the following formats in application properties are available: * A regular `long` representation (using milliseconds as the default unit unless a [`@DurationUnit`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/convert/DurationUnit.html) has been specified) * The standard ISO-8601 format [used by ](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse\(java.lang.CharSequence\))[`Duration`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html) * A more readable format where the value and the unit are coupled (`10s` means 10 seconds) Consider the following example: * Java * Kotlin ```java import java.time.Duration; import java.time.temporal.ChronoUnit; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.convert.DurationUnit; @ConfigurationProperties("my") public class MyProperties { @DurationUnit(ChronoUnit.SECONDS) private Duration sessionTimeout = Duration.ofSeconds(30); private Duration readTimeout = Duration.ofMillis(1000); // getters / setters... public Duration getSessionTimeout() { return this.sessionTimeout; } public void setSessionTimeout(Duration sessionTimeout) { this.sessionTimeout = sessionTimeout; } public Duration getReadTimeout() { return this.readTimeout; } public void setReadTimeout(Duration readTimeout) { this.readTimeout = readTimeout; } } ``` ```kotlin import org.springframework.boot.context.properties.ConfigurationProperties import org.springframework.boot.convert.DurationUnit import java.time.Duration import java.time.temporal.ChronoUnit @ConfigurationProperties("my") class MyProperties { @DurationUnit(ChronoUnit.SECONDS) var sessionTimeout = Duration.ofSeconds(30) var readTimeout = Duration.ofMillis(1000) } ``` To specify a session timeout of 30 seconds, `30`, `PT30S` and `30s` are all equivalent. A read timeout of 500ms can be specified in any of the following form: `500`, `PT0.5S` and `500ms`. You can also use any of the supported units. These are: * `ns` for nanoseconds * `us` for microseconds * `ms` for milliseconds * `s` for seconds * `m` for minutes * `h` for hours * `d` for days The default unit is milliseconds and can be overridden using [`@DurationUnit`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/convert/DurationUnit.html) as illustrated in the sample above. If you prefer to use constructor binding, the same properties can be exposed, as shown in the following example: * Java * Kotlin ```java import java.time.Duration; import java.time.temporal.ChronoUnit; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.context.properties.bind.DefaultValue; import org.springframework.boot.convert.DurationUnit; @ConfigurationProperties("my") public class MyProperties { // fields... private final Duration sessionTimeout; private final Duration readTimeout; public MyProperties(@DurationUnit(ChronoUnit.SECONDS) @DefaultValue("30s") Duration sessionTimeout, @DefaultValue("1000ms") Duration readTimeout) { this.sessionTimeout = sessionTimeout; this.readTimeout = readTimeout; } // getters... public Duration getSessionTimeout() { return this.sessionTimeout; } public Duration getReadTimeout() { return this.readTimeout; } } ``` ```kotlin import org.springframework.boot.context.properties.ConfigurationProperties import org.springframework.boot.context.properties.bind.DefaultValue import org.springframework.boot.convert.DurationUnit import java.time.Duration import java.time.temporal.ChronoUnit @ConfigurationProperties("my") class MyProperties(@param:DurationUnit(ChronoUnit.SECONDS) @param:DefaultValue("30s") val sessionTimeout: Duration, @param:DefaultValue("1000ms") val readTimeout: Duration) ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you are upgrading a [`Long`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html) property, make sure to define the unit (using [`@DurationUnit`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/convert/DurationUnit.html)) if it is not milliseconds. Doing so gives a transparent upgrade path while supporting a much richer format. | #### [](#features.external-config.typesafe-configuration-properties.conversion.periods)Converting Periods In addition to durations, Spring Boot can also work with [`Period`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Period.html) type. The following formats can be used in application properties: * A regular `int` representation (using days as the default unit unless a [`@PeriodUnit`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/convert/PeriodUnit.html) has been specified) * The standard ISO-8601 format [used by ](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Period.html#parse\(java.lang.CharSequence\))[`Period`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Period.html) * A simpler format where the value and the unit pairs are coupled (`1y3d` means 1 year and 3 days) The following units are supported with the simple format: * `y` for years * `m` for months * `w` for weeks * `d` for days | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The [`Period`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Period.html) type never actually stores the number of weeks, it is a shortcut that means “7 days”. | #### [](#features.external-config.typesafe-configuration-properties.conversion.data-sizes)Converting Data Sizes Spring Framework has a [`DataSize`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/util/unit/DataSize.html) value type that expresses a size in bytes. If you expose a [`DataSize`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/util/unit/DataSize.html) property, the following formats in application properties are available: * A regular `long` representation (using bytes as the default unit unless a [`@DataSizeUnit`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/convert/DataSizeUnit.html) has been specified) * A more readable format where the value and the unit are coupled (`10MB` means 10 megabytes) Consider the following example: * Java * Kotlin ```java import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.convert.DataSizeUnit; import org.springframework.util.unit.DataSize; import org.springframework.util.unit.DataUnit; @ConfigurationProperties("my") public class MyProperties { @DataSizeUnit(DataUnit.MEGABYTES) private DataSize bufferSize = DataSize.ofMegabytes(2); private DataSize sizeThreshold = DataSize.ofBytes(512); // getters/setters... public DataSize getBufferSize() { return this.bufferSize; } public void setBufferSize(DataSize bufferSize) { this.bufferSize = bufferSize; } public DataSize getSizeThreshold() { return this.sizeThreshold; } public void setSizeThreshold(DataSize sizeThreshold) { this.sizeThreshold = sizeThreshold; } } ``` ```kotlin import org.springframework.boot.context.properties.ConfigurationProperties import org.springframework.boot.convert.DataSizeUnit import org.springframework.util.unit.DataSize import org.springframework.util.unit.DataUnit @ConfigurationProperties("my") class MyProperties { @DataSizeUnit(DataUnit.MEGABYTES) var bufferSize = DataSize.ofMegabytes(2) var sizeThreshold = DataSize.ofBytes(512) } ``` To specify a buffer size of 10 megabytes, `10` and `10MB` are equivalent. A size threshold of 256 bytes can be specified as `256` or `256B`. You can also use any of the supported units. These are: * `B` for bytes * `KB` for kilobytes * `MB` for megabytes * `GB` for gigabytes * `TB` for terabytes The default unit is bytes and can be overridden using [`@DataSizeUnit`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/convert/DataSizeUnit.html) as illustrated in the sample above. If you prefer to use constructor binding, the same properties can be exposed, as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.context.properties.bind.DefaultValue; import org.springframework.boot.convert.DataSizeUnit; import org.springframework.util.unit.DataSize; import org.springframework.util.unit.DataUnit; @ConfigurationProperties("my") public class MyProperties { // fields... private final DataSize bufferSize; private final DataSize sizeThreshold; public MyProperties(@DataSizeUnit(DataUnit.MEGABYTES) @DefaultValue("2MB") DataSize bufferSize, @DefaultValue("512B") DataSize sizeThreshold) { this.bufferSize = bufferSize; this.sizeThreshold = sizeThreshold; } // getters... public DataSize getBufferSize() { return this.bufferSize; } public DataSize getSizeThreshold() { return this.sizeThreshold; } } ``` ```kotlin import org.springframework.boot.context.properties.ConfigurationProperties import org.springframework.boot.context.properties.bind.DefaultValue import org.springframework.boot.convert.DataSizeUnit import org.springframework.util.unit.DataSize import org.springframework.util.unit.DataUnit @ConfigurationProperties("my") class MyProperties(@param:DataSizeUnit(DataUnit.MEGABYTES) @param:DefaultValue("2MB") val bufferSize: DataSize, @param:DefaultValue("512B") val sizeThreshold: DataSize) ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you are upgrading a [`Long`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html) property, make sure to define the unit (using [`@DataSizeUnit`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/convert/DataSizeUnit.html)) if it is not bytes. Doing so gives a transparent upgrade path while supporting a much richer format. | #### [](#features.external-config.typesafe-configuration-properties.conversion.base64)Converting Base64 Data Spring Boot supports resolving binary data that have been Base64 encoded. If you expose a `Resource` property, the base64 encoded text can be provided as the value with a `base64:` prefix, as shown in the following example: * Properties * YAML ```properties my.property=base64:SGVsbG8gV29ybGQ= ``` ```yaml my: property: base64:SGVsbG8gV29ybGQ= ``` | | | | -- | ------------------------------------------------------------------------------------------------------- | | ** | The `Resource` property can also be used to provide the path to the resource, making it more versatile. | ### [](#features.external-config.typesafe-configuration-properties.validation)@ConfigurationProperties Validation Spring Boot attempts to validate [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) classes whenever they are annotated with Spring’s [`@Validated`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/validation/annotation/Validated.html) annotation. You can use JSR-303 `jakarta.validation` constraint annotations directly on your configuration class. To do so, ensure that a compliant JSR-303 implementation is on your classpath and then add constraint annotations to your fields, as shown in the following example: * Java * Kotlin ```java import java.net.InetAddress; import jakarta.validation.constraints.NotNull; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.validation.annotation.Validated; @ConfigurationProperties("my.service") @Validated public class MyProperties { @NotNull private InetAddress remoteAddress; // getters/setters... public InetAddress getRemoteAddress() { return this.remoteAddress; } public void setRemoteAddress(InetAddress remoteAddress) { this.remoteAddress = remoteAddress; } } ``` ```kotlin import jakarta.validation.constraints.NotNull import org.springframework.boot.context.properties.ConfigurationProperties import org.springframework.validation.annotation.Validated import java.net.InetAddress @ConfigurationProperties("my.service") @Validated class MyProperties { var remoteAddress: @NotNull InetAddress? = null } ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can also trigger validation by annotating the [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) method that creates the configuration properties with [`@Validated`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/validation/annotation/Validated.html). | To cascade validation to nested properties the associated field must be annotated with [`@Valid`](https://jakarta.ee/specifications/bean-validation/3.1/apidocs/jakarta/validation/Valid.html). The following example builds on the preceding `MyProperties` example: * Java * Kotlin ```java import java.net.InetAddress; import jakarta.validation.Valid; import jakarta.validation.constraints.NotEmpty; import jakarta.validation.constraints.NotNull; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.validation.annotation.Validated; @ConfigurationProperties("my.service") @Validated public class MyProperties { @NotNull private InetAddress remoteAddress; @Valid private final Security security = new Security(); // getters/setters... public InetAddress getRemoteAddress() { return this.remoteAddress; } public void setRemoteAddress(InetAddress remoteAddress) { this.remoteAddress = remoteAddress; } public Security getSecurity() { return this.security; } public static class Security { @NotEmpty private String username; // getters/setters... public String getUsername() { return this.username; } public void setUsername(String username) { this.username = username; } } } ``` ```kotlin import jakarta.validation.Valid import jakarta.validation.constraints.NotEmpty import jakarta.validation.constraints.NotNull import org.springframework.boot.context.properties.ConfigurationProperties import org.springframework.validation.annotation.Validated import java.net.InetAddress @ConfigurationProperties("my.service") @Validated class MyProperties { var remoteAddress: @NotNull InetAddress? = null @Valid val security = Security() class Security { @NotEmpty var username: String? = null } } ``` You can also add a custom Spring [`Validator`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/validation/Validator.html) by creating a bean definition called `configurationPropertiesValidator`. The [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) method should be declared `static`. The configuration properties validator is created very early in the application’s lifecycle, and declaring the [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) method as static lets the bean be created without having to instantiate the [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class. Doing so avoids any problems that may be caused by early instantiation. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | The `spring-boot-actuator` module includes an endpoint that exposes all [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans. Point your web browser to `/actuator/configprops` or use the equivalent JMX endpoint. See the [Production ready features](../actuator/endpoints.html) section for details. | ### [](#features.external-config.typesafe-configuration-properties.vs-value-annotation)@ConfigurationProperties vs. @Value The [`@Value`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Value.html) annotation is a core container feature, and it does not provide the same features as type-safe configuration properties. The following table summarizes the features that are supported by [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) and [`@Value`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Value.html): | Feature | `@ConfigurationProperties` | `@Value` | | ---------------------------------------------------------------------------------------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------- | | [Relaxed binding](#features.external-config.typesafe-configuration-properties.relaxed-binding) | Yes | Limited (see [note below](#features.external-config.typesafe-configuration-properties.vs-value-annotation.note)) | | [Meta-data support](../../specification/configuration-metadata/index.html) | Yes | No | | `SpEL` evaluation | No | Yes | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you do want to use [`@Value`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Value.html), we recommend that you refer to property names using their canonical form (kebab-case using only lowercase letters). This will allow Spring Boot to use the same logic as it does when [relaxed binding](#features.external-config.typesafe-configuration-properties.relaxed-binding) [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html).For example, `@Value("${demo.item-price}")` will pick up `demo.item-price` and `demo.itemPrice` forms from the `application.properties` file, as well as `DEMO_ITEMPRICE` from the system environment. If you use `@Value("${demo.itemPrice}")` instead, it will pickup the `demo.itemPrice` form from the `application.properties` file, as well as `DEMO_ITEMPRICE` from the system environment, but `demo.item-price` would not be considered. | If you define a set of configuration keys for your own components, we recommend you group them in a POJO annotated with [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html). Doing so will provide you with structured, type-safe object that you can inject into your own beans. `SpEL` expressions from [application property files](#features.external-config.files) are not processed at time of parsing these files and populating the environment. However, it is possible to write a `SpEL` expression in [`@Value`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Value.html). If the value of a property from an application property file is a `SpEL` expression, it will be evaluated when consumed through [`@Value`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Value.html). * [Spring Boot](../../index.html) * [4.1.1](external-config.html) * [4.0.8](../../4.0/reference/features/external-config.html) * [3.5.16](../../3.5/reference/features/external-config.html) * [3.4.13](../../3.4/reference/features/external-config.html) * [3.3.13](../../3.3/reference/features/external-config.html) - [4.2.0-M2](../../4.2/reference/features/external-config.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/features/external-config.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/features/external-config.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/features/external-config.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) * [Spring AI](https://docs.spring.io/spring-ai/reference/) * [Spring AMQP](https://docs.spring.io/spring-amqp/reference/) * [Spring CLI](https://docs.spring.io/spring-cli/reference/) * [Spring GraphQL](https://docs.spring.io/spring-graphql/reference/) * [Spring for Apache Kafka](https://docs.spring.io/spring-kafka/reference/) * [Spring Modulith](https://docs.spring.io/spring-modulith/reference/) * [Spring for Apache Pulsar](https://docs.spring.io/spring-pulsar/reference/) * [Spring Shell](https://docs.spring.io/spring-shell/reference/) [All Docs...](../../spring-projects.html) [Search in all Spring Docs](../../search.html) [](https://www.algolia.com/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/overview-tree.html ---- # Hierarchy For All Packages Package Hierarchies: * [org.springframework.boot.gradle.dsl](org/springframework/boot/gradle/dsl/package-tree.html), * [org.springframework.boot.gradle.plugin](org/springframework/boot/gradle/plugin/package-tree.html), * [org.springframework.boot.gradle.tasks.aot](org/springframework/boot/gradle/tasks/aot/package-tree.html), * [org.springframework.boot.gradle.tasks.buildinfo](org/springframework/boot/gradle/tasks/buildinfo/package-tree.html), * [org.springframework.boot.gradle.tasks.bundling](org/springframework/boot/gradle/tasks/bundling/package-tree.html), * [org.springframework.boot.gradle.tasks.run](org/springframework/boot/gradle/tasks/run/package-tree.html), * [org.springframework.boot.gradle.util](org/springframework/boot/gradle/util/package-tree.html) ## Class Hierarchy * java.lang.[Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") * org.gradle.api.internal.AbstractTask (implements org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal) * org.gradle.api.[DefaultTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/DefaultTask.html "class or interface in org.gradle.api") (implements org.gradle.api.[Task](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api")) * org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") * org.springframework.boot.gradle.tasks.buildinfo.[BuildInfo](org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") * org.gradle.api.internal.ConventionTask (implements org.gradle.api.internal.IConventionAware) * org.gradle.api.tasks.[AbstractCopyTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/AbstractCopyTask.html "class or interface in org.gradle.api.tasks") (implements org.gradle.api.file.[CopySpec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/CopySpec.html "class or interface in org.gradle.api.file"), org.gradle.api.internal.file.copy.CopySpecSource) * org.gradle.api.tasks.bundling.[AbstractArchiveTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/AbstractArchiveTask.html "class or interface in org.gradle.api.tasks.bundling") * org.gradle.api.tasks.bundling.[Zip](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/Zip.html "class or interface in org.gradle.api.tasks.bundling") * org.gradle.jvm.tasks.[Jar](https://docs.gradle.org/9.7.0/javadoc/org/gradle/jvm/tasks/Jar.html "class or interface in org.gradle.jvm.tasks") * org.gradle.api.tasks.bundling.[Jar](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/Jar.html "class or interface in org.gradle.api.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[BootJar](org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling") (implements org.springframework.boot.gradle.tasks.bundling.[BootArchive](org/springframework/boot/gradle/tasks/bundling/BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling")) * org.gradle.api.tasks.bundling.[War](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/War.html "class or interface in org.gradle.api.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[BootWar](org/springframework/boot/gradle/tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling") (implements org.springframework.boot.gradle.tasks.bundling.[BootArchive](org/springframework/boot/gradle/tasks/bundling/BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling")) * org.gradle.api.tasks.[JavaExec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") (implements org.gradle.process.[JavaExecSpec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/process/JavaExecSpec.html "class or interface in org.gradle.process")) * org.springframework.boot.gradle.tasks.aot.[AbstractAot](org/springframework/boot/gradle/tasks/aot/AbstractAot.html "class in org.springframework.boot.gradle.tasks.aot") * org.springframework.boot.gradle.tasks.aot.[ProcessAot](org/springframework/boot/gradle/tasks/aot/ProcessAot.html "class in org.springframework.boot.gradle.tasks.aot") * org.springframework.boot.gradle.tasks.aot.[ProcessTestAot](org/springframework/boot/gradle/tasks/aot/ProcessTestAot.html "class in org.springframework.boot.gradle.tasks.aot") * org.springframework.boot.gradle.tasks.run.[BootRun](org/springframework/boot/gradle/tasks/run/BootRun.html "class in org.springframework.boot.gradle.tasks.run") * org.springframework.boot.gradle.plugin.[ResolveMainClassName](org/springframework/boot/gradle/plugin/ResolveMainClassName.html "class in org.springframework.boot.gradle.plugin") * org.springframework.boot.gradle.tasks.buildinfo.[BuildInfoProperties](org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") (implements java.io.[Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io")) * org.springframework.boot.gradle.tasks.bundling.[CacheSpec](org/springframework/boot/gradle/tasks/bundling/CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[CacheSpec.BindCacheSpec](org/springframework/boot/gradle/tasks/bundling/CacheSpec.BindCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[CacheSpec.VolumeCacheSpec](org/springframework/boot/gradle/tasks/bundling/CacheSpec.VolumeCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[DockerSpec](org/springframework/boot/gradle/tasks/bundling/DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[DockerSpec.DockerRegistrySpec](org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[LayeredSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.IntoLayerSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") (implements java.io.[Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io")) * org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.DependenciesIntoLayerSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesIntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.IntoLayersSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling")\ (implements java.io.[Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io")) * org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.ApplicationSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.DependenciesSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") (implements java.io.[Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io")) * org.springframework.boot.gradle.plugin.[SpringBootAotPlugin](org/springframework/boot/gradle/plugin/SpringBootAotPlugin.html "class in org.springframework.boot.gradle.plugin") (implements org.gradle.api.[Plugin](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Plugin.html "class or interface in org.gradle.api")\) * org.springframework.boot.gradle.dsl.[SpringBootExtension](org/springframework/boot/gradle/dsl/SpringBootExtension.html "class in org.springframework.boot.gradle.dsl") * org.springframework.boot.gradle.plugin.[SpringBootPlugin](org/springframework/boot/gradle/plugin/SpringBootPlugin.html "class in org.springframework.boot.gradle.plugin") (implements org.gradle.api.[Plugin](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Plugin.html "class or interface in org.gradle.api")\) * org.springframework.boot.gradle.util.[VersionExtractor](org/springframework/boot/gradle/util/VersionExtractor.html "class in org.springframework.boot.gradle.util") ## Interface Hierarchy * java.lang.[Comparable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html "class or interface in java.lang")\ * org.gradle.api.[Task](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") (also extends org.gradle.api.plugins.[ExtensionAware](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/plugins/ExtensionAware.html "class or interface in org.gradle.api.plugins"), org.gradle.api.[Named](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Named.html "class or interface in org.gradle.api")) * org.springframework.boot.gradle.tasks.bundling.[BootArchive](org/springframework/boot/gradle/tasks/bundling/BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") * org.gradle.api.plugins.[ExtensionAware](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/plugins/ExtensionAware.html "class or interface in org.gradle.api.plugins") * org.gradle.api.[Task](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") (also extends java.lang.[Comparable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html "class or interface in java.lang")\, org.gradle.api.[Named](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Named.html "class or interface in org.gradle.api")) * org.springframework.boot.gradle.tasks.bundling.[BootArchive](org/springframework/boot/gradle/tasks/bundling/BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") * org.gradle.api.[Named](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Named.html "class or interface in org.gradle.api") * org.gradle.api.[Task](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") (also extends java.lang.[Comparable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html "class or interface in java.lang")\, org.gradle.api.plugins.[ExtensionAware](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/plugins/ExtensionAware.html "class or interface in org.gradle.api.plugins")) * org.springframework.boot.gradle.tasks.bundling.[BootArchive](org/springframework/boot/gradle/tasks/bundling/BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") ## Enum Class Hierarchy * java.lang.[Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") * java.lang.[Enum](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html "class or interface in java.lang")\ (implements java.lang.[Comparable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html "class or interface in java.lang")\, java.lang.constant.[Constable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html "class or interface in java.lang.constant"), java.io.[Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io")) * org.springframework.boot.gradle.tasks.bundling.[ZipCompression](org/springframework/boot/gradle/tasks/bundling/ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/run/class-use/BootRun.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.run.BootRun ================================================= No usage of org.springframework.boot.gradle.tasks.run.BootRun ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/class-use/LayeredSpec.DependenciesIntoLayerSpec.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.bundling.LayeredSpec.DependenciesIntoLayerSpec ==================================================================================== Packages that use [LayeredSpec.DependenciesIntoLayerSpec](../LayeredSpec.DependenciesIntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Package Description [org.springframework.boot.gradle.tasks.bundling](#org.springframework.boot.gradle.tasks.bundling) Support for creating executable jars and wars. * ## Uses of [LayeredSpec.DependenciesIntoLayerSpec](../LayeredSpec.DependenciesIntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) Subclasses with type arguments of type [LayeredSpec.DependenciesIntoLayerSpec](../LayeredSpec.DependenciesIntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) Modifier and Type Class Description `static class ` `LayeredSpec.DependenciesSpec` An [`LayeredSpec.IntoLayersSpec`](../LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which dependencies belong. Constructors in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) with parameters of type [LayeredSpec.DependenciesIntoLayerSpec](../LayeredSpec.DependenciesIntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Modifier Constructor Description ` ` `DependenciesSpec(LayeredSpec.DependenciesIntoLayerSpec... contents)` Creates a new `DependenciesSpec` with the given `contents`. ---- url: https://docs.spring.io/spring-boot/reference/actuator/index.html ---- # Production-ready Features Spring Boot includes a number of additional features to help you monitor and manage your application when you push it to production. You can choose to manage and monitor your application by using HTTP endpoints or with JMX. Auditing, health, and metrics gathering can also be automatically applied to your application. * [Spring Boot](../../index.html) * [4.1.1](index.html) * [4.0.8](../../4.0/reference/actuator/index.html) * [3.5.16](../../3.5/reference/actuator/index.html) * [3.4.13](../../3.4/reference/actuator/index.html) * [3.3.13](../../3.3/reference/actuator/index.html) - [4.2.0-M2](../../4.2/reference/actuator/index.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/actuator/index.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/actuator/index.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/actuator/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/help-doc.html ---- # JavaDoc Help *** *** ## Kinds of Pages The following sections describe the different kinds of pages in this collection. ### Overview The [Overview](index.html) page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages. ### Constant Field Values The [Constant Field Values](constant-values.html) page lists the static final fields and their values. *** ## Release Details The details for each module, package, class or interface normally include the release in which the declaration was introduced. When a member is added after the initial introduction of the enclosing class or interface, the details of the member include the release in which it was introduced. *** This help file applies to API documentation generated by the standard doclet. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/Layers.html ---- Uses of Class\ org.springframework.boot.maven.Layers ===================================== No usage of org.springframework.boot.maven.Layers ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/FilterableDependency.html ---- Uses of Class\ org.springframework.boot.maven.FilterableDependency =================================================== * ## Uses of [FilterableDependency](../FilterableDependency.html "class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Subclasses of [FilterableDependency](../FilterableDependency.html "class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Modifier and Type Class Description `class ` `Exclude` A model for a dependency to exclude. `class ` `Include` A model for a dependency to include. Methods in [org.springframework.boot.maven](../package-summary.html) that return types with arguments of type [FilterableDependency](../FilterableDependency.html "class in org.springframework.boot.maven") Modifier and Type Method Description `protected final List` DependencyFilter.`getFilters()`   Methods in [org.springframework.boot.maven](../package-summary.html) with parameters of type [FilterableDependency](../FilterableDependency.html "class in org.springframework.boot.maven") Modifier and Type Method Description `protected final boolean` DependencyFilter.`equals(org.apache.maven.artifact.Artifact artifact, FilterableDependency dependency)` Check if the specified `Artifact` matches the specified [`FilterableDependency`](../FilterableDependency.html "class in org.springframework.boot.maven"). Constructor parameters in [org.springframework.boot.maven](../package-summary.html) with type arguments of type [FilterableDependency](../FilterableDependency.html "class in org.springframework.boot.maven") Modifier Constructor Description ` ` `DependencyFilter(List dependencies)` Create a new instance with the list of [`FilterableDependency`](../FilterableDependency.html "class in org.springframework.boot.maven") instance(s) to use. ---- url: https://docs.spring.io/spring-boot/gradle-plugin/integrating-with-actuator.html ---- # Integrating with Actuator ## [](#integrating-with-actuator.build-info)Generating Build Information Spring Boot Actuator’s `info` endpoint automatically publishes information about your build in the presence of a `META-INF/build-info.properties` file. A [`BuildInfo`](api/java/org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html) task is provided to generate this file. The easiest way to use the task is through the plugin’s DSL: * Groovy * Kotlin ```groovy springBoot { buildInfo() } ``` ```kotlin springBoot { buildInfo() } ``` This will configure a [`BuildInfo`](api/java/org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html) task named `bootBuildInfo`. The task’s destination directory will be `build/bootBuildInfo` and its filename will be `META-INF/build-info.properties`. If the main source set exists, its resources are configured to use the output of the `bootBuildInfo` task as a src dir. By default, the generated build information is derived from the project: | Property | Default value | | ---------------- | ------------------------------------------------ | | `build.artifact` | The base name of the `bootJar` or `bootWar` task | | `build.group` | The group of the project | | `build.name` | The name of the project | | `build.version` | The version of the project | | `build.time` | The time at which the project is being built | The properties can be customized using the DSL: * Groovy * Kotlin ```groovy springBoot { buildInfo { properties { artifact = 'example-app' version = '1.2.3' group = 'com.example' name = 'Example application' } } } ``` ```kotlin springBoot { buildInfo { properties { artifact.set("example-app") version.set("1.2.3") group.set("com.example") name.set("Example application") } } } ``` To exclude any of the default properties from the generated build information, add its name to the excludes. For example, the `time` property can be excluded as follows: * Groovy * Kotlin ```groovy springBoot { buildInfo { excludes = ['time'] } } ``` ```kotlin springBoot { buildInfo { excludes.set(setOf("time")) } } ``` The default value for `build.time` is the instant at which the project is being built. A side-effect of this is that the task will never be up-to-date. As a result, builds will take longer as more tasks, including the project’s tests, will have to be executed. Another side-effect is that the task’s output will always change and, therefore, the build will not be truly repeatable. If you value build performance or repeatability more highly than the accuracy of the `build.time` property, exclude the `time` property as shown in the preceding example. Additional properties can also be added to the build information: * Groovy * Kotlin ```groovy springBoot { buildInfo { properties { additional = [ 'a': 'alpha', 'b': 'bravo' ] } } } ``` ```kotlin springBoot { buildInfo { properties { additional.set(mapOf( "a" to "alpha", "b" to "bravo" )) } } } ``` An additional property’s value can be computed lazily by using a `Provider`. * [Spring Boot](../index.html) * [4.1.1](integrating-with-actuator.html) * [4.0.8](../4.0/gradle-plugin/integrating-with-actuator.html) * [3.5.16](../3.5/gradle-plugin/integrating-with-actuator.html) * [3.4.13](../3.4/gradle-plugin/integrating-with-actuator.html) * [3.3.13](../3.3/gradle-plugin/integrating-with-actuator.html) - [4.2.0-M2](../4.2/gradle-plugin/integrating-with-actuator.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/gradle-plugin/integrating-with-actuator.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/gradle-plugin/integrating-with-actuator.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/gradle-plugin/integrating-with-actuator.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/using/build-systems.html ---- # Build Systems It is strongly recommended that you choose a build system that supports [dependency management](#using.build-systems.dependency-management) and that can consume artifacts published to the Maven Central repository. We would recommend that you choose Maven or Gradle. It is possible to get Spring Boot to work with other build systems (Ant, for example), but they are not particularly well supported. ## [](#using.build-systems.dependency-management)Dependency Management Each release of Spring Boot provides a curated list of dependencies that it supports. In practice, you do not need to provide a version for any of these dependencies in your build configuration, as Spring Boot manages that for you. When you upgrade Spring Boot itself, these dependencies are upgraded as well in a consistent way. | | | | -- | ------------------------------------------------------------------------------------------------ | | ** | You can still specify a version and override Spring Boot’s recommendations if you need to do so. | The curated list contains all the Spring modules that you can use with Spring Boot as well as a refined list of third party libraries. The list is available as a standard Bills of Materials (`spring-boot-dependencies`) that can be used with both [Maven](#using.build-systems.maven) and [Gradle](#using.build-systems.gradle). | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Each release of Spring Boot is associated with a base version of the Spring Framework. We **highly** recommend that you do not specify its version. | ## [](#using.build-systems.maven)Maven To learn about using Spring Boot with Maven, see the documentation for Spring Boot’s Maven plugin: * [Reference](../../maven-plugin/index.html) * [API](../../maven-plugin/api/java/index.html) ## [](#using.build-systems.gradle)Gradle To learn about using Spring Boot with Gradle, see the documentation for Spring Boot’s Gradle plugin: * [Reference](../../gradle-plugin/index.html) * [API](../../gradle-plugin/api/java/index.html) ## [](#using.build-systems.ant)Ant It is possible to build a Spring Boot project using Apache Ant+Ivy. The `spring-boot-antlib` “AntLib” module is also available to help Ant create executable jars. To declare dependencies, a typical `ivy.xml` file looks something like the following example: ```xml ``` A typical `build.xml` looks like the following example: ```xml ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you do not want to use the `spring-boot-antlib` module, see the [Build an Executable Archive From Ant without Using spring-boot-antlib](../../how-to/build.html#howto.build.build-an-executable-archive-with-ant-without-using-spring-boot-antlib) section of “How-to Guides”. | ## [](#using.build-systems.starters)Starters Starters are a set of convenient dependency descriptors that you can include in your application. You get a one-stop shop for all the Spring and related technologies that you need without having to hunt through sample code and copy-paste loads of dependency descriptors. For example, if you want to get started using Spring and JPA for database access, include the `spring-boot-starter-data-jpa` dependency in your project. The starters contain a lot of the dependencies that you need to get a project up and running quickly and with a consistent, supported set of managed transitive dependencies. What is in a name All **official** starters follow a similar naming pattern; `spring-boot-starter-*`, where `*` is a particular type of application. This naming structure is intended to help when you need to find a starter. The Maven integration in many IDEs lets you search dependencies by name. For example, with the appropriate Eclipse or Spring Tools plugin installed, you can press `ctrl-space` in the POM editor and type “spring-boot-starter” for a complete list. As explained in the [Creating Your Own Starter](../features/developing-auto-configuration.html#features.developing-auto-configuration.custom-starter) section, third party starters should not start with `spring-boot`, as it is reserved for official Spring Boot artifacts. Rather, a third-party starter typically starts with the name of the project. For example, a third-party starter project called `thirdpartyproject` would typically be named `thirdpartyproject-spring-boot-starter`. The following application starters are provided by Spring Boot under the `org.springframework.boot` group: | Name | Description | | ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | []()`spring-boot-starter` | Core starter, including auto-configuration support, logging and YAML | | []()`spring-boot-starter-activemq` | Starter for using Apache ActiveMQ and JMS | | []()`spring-boot-starter-activemq-test` | Starter for testing using Apache ActiveMQ and JMS | | []()`spring-boot-starter-actuator-test` | Starter for testing Spring Boot’s Actuator which provides production ready features to help you monitor and manage your application | | []()`spring-boot-starter-amqp` | Starter for using Spring AMQP and Rabbit MQ | | []()`spring-boot-starter-amqp-test` | Starter for testing Spring AMQP and Rabbit MQ | | []()`spring-boot-starter-artemis` | Starter for using Apache Artemis and JMS | | []()`spring-boot-starter-artemis-test` | Starter for testing Apache Artemis and JMS | | []()`spring-boot-starter-aspectj` | Starter for using aspect-oriented programming with AspectJ | | []()`spring-boot-starter-aspectj-test` | Starter for testing aspect-oriented programming with AspectJ | | []()`spring-boot-starter-batch` | Starter for using Spring Batch | | []()`spring-boot-starter-batch-data-mongodb` | Starter for using Spring Batch with Data MongoDB | | []()`spring-boot-starter-batch-data-mongodb-test` | Starter for testing using Spring Batch with Data MongoDB | | []()`spring-boot-starter-batch-jdbc` | Starter for using Spring Batch with JDBC | | []()`spring-boot-starter-batch-jdbc-test` | Starter for testing using Spring Batch with JDBC | | []()`spring-boot-starter-batch-test` | Starter for testing using Spring Batch | | []()`spring-boot-starter-cache` | Starter for using Spring’s caching support | | []()`spring-boot-starter-cache-test` | Starter for testing Spring’s caching support | | []()`spring-boot-starter-cassandra` | Starter for using Cassandra distributed database | | []()`spring-boot-starter-cassandra-test` | Starter for testing Cassandra distributed database | | []()`spring-boot-starter-classic` | Core classic starter, including full auto-configuration support, logging and YAML | | []()`spring-boot-starter-cloudfoundry` | Starter for using Cloud Foundry | | []()`spring-boot-starter-cloudfoundry-test` | Starter for testing Cloud Foundry | | []()`spring-boot-starter-couchbase` | Starter for using Couchbase document-oriented database | | []()`spring-boot-starter-couchbase-test` | Starter for testing Couchbase document-oriented database | | []()`spring-boot-starter-data-cassandra` | Starter for using Cassandra distributed database and Spring Data Cassandra | | []()`spring-boot-starter-data-cassandra-reactive` | Starter for using Cassandra distributed database and Spring Data Cassandra Reactive | | []()`spring-boot-starter-data-cassandra-reactive-test` | Starter for testing Cassandra distributed database and Spring Data Cassandra Reactive | | []()`spring-boot-starter-data-cassandra-test` | Starter for testing Cassandra distributed database and Spring Data Cassandra | | []()`spring-boot-starter-data-couchbase` | Starter for using Couchbase document-oriented database and Spring Data Couchbase | | []()`spring-boot-starter-data-couchbase-reactive` | Starter for using Couchbase document-oriented database and Spring Data Couchbase Reactive | | []()`spring-boot-starter-data-couchbase-reactive-test` | Starter for testing Couchbase document-oriented database and Spring Data Couchbase Reactive | | []()`spring-boot-starter-data-couchbase-test` | Starter for testing Couchbase document-oriented database and Spring Data Couchbase | | []()`spring-boot-starter-data-elasticsearch` | Starter for using Elasticsearch search and analytics engine and Spring Data Elasticsearch | | []()`spring-boot-starter-data-elasticsearch-test` | Starter for testing Elasticsearch search and analytics engine and Spring Data Elasticsearch | | []()`spring-boot-starter-data-jdbc` | Starter for using Spring Data JDBC | | []()`spring-boot-starter-data-jdbc-test` | Starter for testing Spring Data JDBC | | []()`spring-boot-starter-data-jpa` | Starter for using Spring Data JPA with Hibernate | | []()`spring-boot-starter-data-jpa-test` | Starter for testing Spring Data JPA with Hibernate | | []()`spring-boot-starter-data-ldap` | Starter for using Spring Data LDAP | | []()`spring-boot-starter-data-ldap-test` | Starter for testing Spring Data LDAP | | []()`spring-boot-starter-data-mongodb` | Starter for using MongoDB document-oriented database and Spring Data MongoDB | | []()`spring-boot-starter-data-mongodb-reactive` | Starter for using MongoDB document-oriented database and Spring Data MongoDB Reactive | | []()`spring-boot-starter-data-mongodb-reactive-test` | Starter for using MongoDB document-oriented database and Spring Data MongoDB Reactive | | []()`spring-boot-starter-data-mongodb-test` | Starter for testing MongoDB document-oriented database and Spring Data MongoDB | | []()`spring-boot-starter-data-neo4j` | Starter for using Neo4j graph database and Spring Data Neo4j | | []()`spring-boot-starter-data-neo4j-test` | Starter for testing Neo4j graph database and Spring Data Neo4j | | []()`spring-boot-starter-data-r2dbc` | Starter for using Spring Data R2DBC | | []()`spring-boot-starter-data-r2dbc-test` | Starter for testing Spring Data R2DBC | | []()`spring-boot-starter-data-redis` | Starter for using Redis key-value data store with Spring Data Redis and the Lettuce client | | []()`spring-boot-starter-data-redis-reactive` | Starter for using Redis key-value data store with Spring Data Redis reactive and the Lettuce client | | []()`spring-boot-starter-data-redis-reactive-test` | Starter for testing Redis key-value data store with Spring Data Redis reactive and the Lettuce client | | []()`spring-boot-starter-data-redis-test` | Starter for testing Redis key-value data store with Spring Data Redis and the Lettuce client | | []()`spring-boot-starter-data-rest` | Starter for using Spring Data repositories exposed over REST using Spring Data REST and Spring MVC | | []()`spring-boot-starter-data-rest-test` | Starter for testing Spring Data repositories exposed over REST using Spring Data REST and Spring MVC | | []()`spring-boot-starter-elasticsearch` | Starter for using Elasticsearch search and analytics engine | | []()`spring-boot-starter-elasticsearch-test` | Starter for testing Elasticsearch search and analytics engine | | []()`spring-boot-starter-flyway` | Starter for using Flyway database migrations | | []()`spring-boot-starter-flyway-test` | Starter for testing Flyway database migrations | | []()`spring-boot-starter-freemarker` | Starter for using FreeMarker | | []()`spring-boot-starter-freemarker-test` | Starter for testing FreeMarker | | []()`spring-boot-starter-graphql` | Starter using Spring GraphQL | | []()`spring-boot-starter-graphql-test` | Starter for testing Spring GraphQL | | []()`spring-boot-starter-groovy-templates` | Starter for using Groovy Templates | | []()`spring-boot-starter-groovy-templates-test` | Starter for testing Groovy Templates | | []()`spring-boot-starter-grpc-client` | Starter for using Spring gRPC client | | []()`spring-boot-starter-grpc-client-test` | Starter for testing gRPC client | | []()`spring-boot-starter-grpc-server` | Starter for using Spring gRPC server | | []()`spring-boot-starter-grpc-server-test` | Starter for testing gRPC server | | []()`spring-boot-starter-gson` | Starter for using GSON | | []()`spring-boot-starter-gson-test` | Starter for testing GSON | | []()`spring-boot-starter-hateoas` | Starter for using Spring HATEOS to build hypermedia-based RESTful Spring MVC web applications | | []()`spring-boot-starter-hateoas-test` | Starter for testing Spring HATEOS to build hypermedia-based RESTful Spring MVC web applications | | []()`spring-boot-starter-hazelcast` | Starter for using Hazelcast | | []()`spring-boot-starter-hazelcast-test` | Starter for testing Hazelcast | | []()`spring-boot-starter-integration` | Starter for using Spring Integration | | []()`spring-boot-starter-integration-test` | Starter for testing Spring Integration | | []()`spring-boot-starter-jackson` | Starter for using Jackson | | []()`spring-boot-starter-jackson-test` | Starter for testing Jackson | | []()`spring-boot-starter-jdbc` | Starter for using JDBC with the HikariCP connection pool | | []()`spring-boot-starter-jdbc-test` | Starter for testing JDBC with the HikariCP connection pool | | []()`spring-boot-starter-jersey` | Starter for using JAX-RS and Jersey | | []()`spring-boot-starter-jersey-test` | Starter for testing JAX-RS and Jersey | | []()`spring-boot-starter-jetty` | Starter for using Jetty as the embedded servlet container | | []()`spring-boot-starter-jms` | Starter for using JMS | | []()`spring-boot-starter-jms-test` | Starter for testing JMS | | []()`spring-boot-starter-jooq` | Starter for using jOOQ to access SQL databases with JDBC | | []()`spring-boot-starter-jooq-test` | Starter for testing jOOQ to access SQL databases with JDBC | | []()`spring-boot-starter-json` | Starter for reading and writing JSON | | []()`spring-boot-starter-jsonb` | Starter for using JSON-B | | []()`spring-boot-starter-jsonb-test` | Starter for testing JSON-B | | []()`spring-boot-starter-kafka` | Starter for using Apache Kafka | | []()`spring-boot-starter-kafka-test` | Starter for testing Apache Kafka | | []()`spring-boot-starter-kotlinx-serialization-json` | Starter for using Kotlinx Serialization JSON | | []()`spring-boot-starter-kotlinx-serialization-json-test` | Starter for testing Kotlinx Serialization JSON | | []()`spring-boot-starter-ldap` | Starter for using LDAP | | []()`spring-boot-starter-ldap-test` | Starter for testing LDAP | | []()`spring-boot-starter-liquibase` | Starter for using Liquibase database migrations | | []()`spring-boot-starter-liquibase-test` | Starter for testing Liquibase database migrations | | []()`spring-boot-starter-mail` | Starter for using Java Mail and Spring Framework’s email sending support | | []()`spring-boot-starter-mail-test` | Starter for testing Java Mail and Spring Framework’s email sending support | | []()`spring-boot-starter-micrometer-metrics` | Starter for using Micrometer Metrics | | []()`spring-boot-starter-micrometer-metrics-test` | Starter for testing Micrometer Metrics | | []()`spring-boot-starter-mongodb` | Starter for using MongoDB document-oriented database | | []()`spring-boot-starter-mongodb-test` | Starter for testing MongoDB document-oriented database | | []()`spring-boot-starter-mustache` | Starter for using Mustache | | []()`spring-boot-starter-mustache-test` | Starter for testing Mustache | | []()`spring-boot-starter-neo4j` | Starter for using Neo4j graph database | | []()`spring-boot-starter-neo4j-test` | Starter for testing Neo4j graph database | | []()`spring-boot-starter-oauth2-authorization-server` | Starter for using Spring Authorization Server features (deprecated in favor of [`spring-boot-starter-security-oauth2-authorization-server`](#spring-boot-starter-security-oauth2-authorization-server)) | | []()`spring-boot-starter-oauth2-client` | Starter for using Spring Security’s OAuth2/OpenID Connect client features (deprecated in favor of [`spring-boot-starter-security-oauth2-client`](#spring-boot-starter-security-oauth2-client)) | | []()`spring-boot-starter-oauth2-resource-server` | Starter for using Spring Security’s OAuth2 resource server features (deprecated in favor of [`spring-boot-starter-security-oauth2-resource-server`](#spring-boot-starter-security-oauth2-resource-server)) | | []()`spring-boot-starter-opentelemetry` | Starter for using OpenTelemetry | | []()`spring-boot-starter-opentelemetry-test` | Starter for testing OpenTelemetry | | []()`spring-boot-starter-pulsar` | Starter for using Spring for Apache Pulsar | | []()`spring-boot-starter-pulsar-test` | Starter for testing Spring for Apache Pulsar | | []()`spring-boot-starter-quartz` | Starter for using the Quartz scheduler | | []()`spring-boot-starter-quartz-test` | Starter for testing the Quartz scheduler | | []()`spring-boot-starter-r2dbc` | Starter for using R2DBC | | []()`spring-boot-starter-r2dbc-test` | Starter for testing R2DBC | | []()`spring-boot-starter-reactor-netty` | Starter for Reactor Netty | | []()`spring-boot-starter-restclient` | Starter using Spring’s blocking HTTP clients (RestClient, RestTemplate and HTTP Service Clients) | | []()`spring-boot-starter-restclient-test` | Starter for testing Spring’s blocking HTTP clients (RestClient, RestTemplate and HTTP Service Clients) | | []()`spring-boot-starter-rsocket` | Starter for using RSocket | | []()`spring-boot-starter-rsocket-test` | Starter for testing RSocket | | []()`spring-boot-starter-security` | Starter for using Spring Security | | []()`spring-boot-starter-security-oauth2-authorization-server` | Starter for using Spring Authorization Server features | | []()`spring-boot-starter-security-oauth2-authorization-server-test` | Starter for testing Spring Authorization Server features | | []()`spring-boot-starter-security-oauth2-client` | Starter for using Spring Security’s OAuth2/OpenID Connect client features | | []()`spring-boot-starter-security-oauth2-client-test` | Starter for testing Spring Security’s OAuth2/OpenID Connect client features | | []()`spring-boot-starter-security-oauth2-resource-server` | Starter for using Spring Security’s OAuth2 resource server features | | []()`spring-boot-starter-security-oauth2-resource-server-test` | Starter for testing Spring Security’s OAuth2 resource server features | | []()`spring-boot-starter-security-saml2` | Starter for using Spring Security with SAML2 | | []()`spring-boot-starter-security-saml2-test` | Starter for testing Spring Security with SAML2 | | []()`spring-boot-starter-security-test` | Starter for testing Spring Security | | []()`spring-boot-starter-sendgrid` | Starter for using Spring Session with Sendgrid | | []()`spring-boot-starter-sendgrid-test` | Starter for testing Spring Session with Sendgrid | | []()`spring-boot-starter-session-data-redis` | Starter for using Spring Session with Spring Data Redis | | []()`spring-boot-starter-session-data-redis-test` | Starter for testing Spring Session with Spring Data Redis | | []()`spring-boot-starter-session-jdbc` | Starter for using Spring Session with JDBC | | []()`spring-boot-starter-session-jdbc-test` | Starter for testing Spring Session with JDBC | | []()`spring-boot-starter-test` | Starter for testing Spring Boot applications with libraries including JUnit Jupiter, Hamcrest and Mockito | | []()`spring-boot-starter-test-classic` | Classic starter for testing Spring Boot applications with libraries including JUnit Jupiter, Hamcrest and Mockito | | []()`spring-boot-starter-thymeleaf` | Starter for using Thymeleaf | | []()`spring-boot-starter-thymeleaf-test` | Starter for testing Thymeleaf | | []()`spring-boot-starter-tomcat` | Starter for using Tomcat as the embedded servlet container | | []()`spring-boot-starter-validation` | Starter for using Java Bean Validation with Hibernate Validator | | []()`spring-boot-starter-validation-test` | Starter for testing Java Bean Validation with Hibernate Validator | | []()`spring-boot-starter-web` | Starter for building web, including RESTful, applications using Spring MVC. Uses Tomcat as the default embedded container (deprecated in favor of [`spring-boot-starter-webmvc`](#spring-boot-starter-webmvc)) | | []()`spring-boot-starter-web-server-test` | Starter for testing Spring Web Server | | []()`spring-boot-starter-web-services` | Starter for using Spring Web Services (deprecated in favor of [`spring-boot-starter-webservices`](#spring-boot-starter-webservices)) | | []()`spring-boot-starter-webclient` | Starter using Spring’s reactive HTTP clients (WebClient and HTTP Service Clients) | | []()`spring-boot-starter-webclient-test` | Starter for testing Spring’s reactive HTTP clients (WebClient and HTTP Service Clients) | | []()`spring-boot-starter-webflux` | Starter for using WebFlux and Reactor Netty | | []()`spring-boot-starter-webflux-test` | Starter for testing WebFlux and Reactor Netty | | []()`spring-boot-starter-webmvc` | Starter for using Spring MVC and Tomcat | | []()`spring-boot-starter-webmvc-test` | Starter for testing Spring MVC and Tomcat | | []()`spring-boot-starter-webservices` | Starter for using Spring Web Services | | []()`spring-boot-starter-webservices-test` | Starter for testing Spring Web Services | | []()`spring-boot-starter-websocket` | Starter for using Spring MVC WebSocket support | | []()`spring-boot-starter-websocket-test` | Starter for testing Spring MVC WebSocket support | | []()`spring-boot-starter-zipkin` | Starter for using Zipkin | | []()`spring-boot-starter-zipkin-test` | Starter for testing Zipkin | In addition to the application starters, the following starters can be used to add [production ready](../../how-to/actuator.html) features: | Name | Description | | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | []()`spring-boot-starter-actuator` | Starter for using Spring Boot’s Actuator which provides production ready features to help you monitor and manage your application | Finally, Spring Boot also includes the following starters that can be used if you want to exclude or swap specific technical facets: | Name | Description | | ---------------------------------------- | ----------------------------------- | | []()`spring-boot-starter-jetty-runtime` | Starter for the Jetty runtime | | []()`spring-boot-starter-log4j2` | Starter for using Log4j2 | | []()`spring-boot-starter-logback` | Starter for logging using Logback | | []()`spring-boot-starter-logging` | Starter for logging default logging | | []()`spring-boot-starter-restdocs` | Starter for using Spring REST Docs | | []()`spring-boot-starter-tomcat-runtime` | Starter for the Tomcat runtime | To learn how to swap technical facets, please see the how-to documentation for [swapping web server](../../how-to/webserver.html#howto.webserver.use-another) and [logging system](../../how-to/logging.html#howto.logging.log4j). | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | For a list of additional community contributed starters, see the [README file](https://github.com/spring-projects/spring-boot/tree/main/starter/README.adoc) in the `spring-boot-starters` module on GitHub. | * [Spring Boot](../../index.html) * [4.1.1](build-systems.html) * [4.0.8](../../4.0/reference/using/build-systems.html) * [3.5.16](../../3.5/reference/using/build-systems.html) * [3.4.13](../../3.4/reference/using/build-systems.html) * [3.3.13](../../3.3/reference/using/build-systems.html) - [4.2.0-M2](../../4.2/reference/using/build-systems.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/using/build-systems.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/using/build-systems.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/using/build-systems.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/getting-started.html ---- # Getting Started To use the Spring Boot Maven Plugin, include the appropriate XML in the `plugins` section of your `pom.xml`, as shown in the following example: ```xml 4.0.0 getting-started org.springframework.boot spring-boot-maven-plugin ``` If you use a milestone or snapshot release, you also need to add the appropriate `pluginRepository` elements, as shown in the following listing: ```xml spring-snapshots https://repo.spring.io/snapshot spring-milestones https://repo.spring.io/milestone ``` * [Spring Boot](../index.html) * [4.1.1](getting-started.html) * [4.0.8](../4.0/maven-plugin/getting-started.html) * [3.5.16](../3.5/maven-plugin/getting-started.html) * [3.4.13](../3.4/maven-plugin/getting-started.html) * [3.3.13](../3.3/maven-plugin/getting-started.html) - [4.2.0-M2](../4.2/maven-plugin/getting-started.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/maven-plugin/getting-started.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/maven-plugin/getting-started.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/maven-plugin/getting-started.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/util/package-tree.html ---- # Hierarchy For Package org.springframework.boot.gradle.util Package Hierarchies: * [All Packages](../../../../../overview-tree.html) ## Class Hierarchy * java.lang.[Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") * org.springframework.boot.gradle.util.[VersionExtractor](VersionExtractor.html "class in org.springframework.boot.gradle.util") ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/buildinfo/class-use/BuildInfo.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.buildinfo.BuildInfo ========================================================= Packages that use [BuildInfo](../BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") Package Description [org.springframework.boot.gradle.dsl](#org.springframework.boot.gradle.dsl) Spring Boot Gradle DSL. * ## Uses of [BuildInfo](../BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") in [org.springframework.boot.gradle.dsl](../../../dsl/package-summary.html) Method parameters in [org.springframework.boot.gradle.dsl](../../../dsl/package-summary.html) with type arguments of type [BuildInfo](../BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") Modifier and Type Method Description `void` SpringBootExtension.`buildInfo(@Nullable Action configurer)` Creates a new [`BuildInfo`](../BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") task named `bootBuildInfo` and adds its output as a [`source directory`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/SourceDirectorySet.html#srcDir\(java.lang.Object\) "class or interface in org.gradle.api.file") of the main source set's [`resources`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html#getResources\(\) "class or interface in org.gradle.api.tasks"). ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/index-files/index-3.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ## C * [CacheSpec](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") - Class in [org.springframework.boot.gradle.tasks.bundling](../org/springframework/boot/gradle/tasks/bundling/package-summary.html) Configuration for an image building cache. * [CacheSpec(ObjectFactory)](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.html#%3Cinit%3E\(org.gradle.api.model.ObjectFactory\)) - Constructor for class org.springframework.boot.gradle.tasks.bundling.[CacheSpec](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling")   * [CacheSpec.BindCacheSpec](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.BindCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") - Class in [org.springframework.boot.gradle.tasks.bundling](../org/springframework/boot/gradle/tasks/bundling/package-summary.html) Configuration for an image building cache stored in a bind mount. * [CacheSpec.VolumeCacheSpec](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.VolumeCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") - Class in [org.springframework.boot.gradle.tasks.bundling](../org/springframework/boot/gradle/tasks/bundling/package-summary.html) Configuration for an image building cache stored in a Docker volume. * [classpath(Object...)](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html#classpath\(java.lang.Object...\)) - Method in interface org.springframework.boot.gradle.tasks.bundling.[BootArchive](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") Adds files to the classpath to include in the archive. * [classpath(Object...)](../org/springframework/boot/gradle/tasks/bundling/BootJar.html#classpath\(java.lang.Object...\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootJar](../org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling")   * [copy()](../org/springframework/boot/gradle/tasks/bundling/BootJar.html#copy\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootJar](../org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling")   * [copy()](../org/springframework/boot/gradle/tasks/bundling/BootWar.html#copy\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootWar](../org/springframework/boot/gradle/tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling")   * [createCopyAction()](../org/springframework/boot/gradle/tasks/bundling/BootJar.html#createCopyAction\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootJar](../org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling")   * [createCopyAction()](../org/springframework/boot/gradle/tasks/bundling/BootWar.html#createCopyAction\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootWar](../org/springframework/boot/gradle/tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling")   [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ---- url: https://docs.spring.io/spring-boot/how-to/jersey.html ---- # Jersey ## [](#howto.jersey.spring-security)Secure Jersey Endpoints with Spring Security Spring Security can be used to secure a Jersey-based web application in much the same way as it can be used to secure a Spring MVC-based web application. However, if you want to use Spring Security’s method-level security with Jersey, you must configure Jersey to use `setStatus(int)` rather `sendError(int)`. This prevents Jersey from committing the response before Spring Security has had an opportunity to report an authentication or authorization failure to the client. The `jersey.config.server.response.setStatusOverSendError` property must be set to `true` on the application’s [`ResourceConfig`](https://javadoc.io/doc/org.glassfish.jersey.core/jersey-server/4.0.2/org/glassfish/jersey/server/ResourceConfig.html) bean, as shown in the following example: ```java import java.util.Collections; import org.glassfish.jersey.server.ResourceConfig; import org.springframework.stereotype.Component; @Component public class JerseySetStatusOverSendErrorConfig extends ResourceConfig { public JerseySetStatusOverSendErrorConfig() { register(Endpoint.class); setProperties(Collections.singletonMap("jersey.config.server.response.setStatusOverSendError", true)); } } ``` ## [](#howto.jersey.alongside-another-web-framework)Use Jersey Alongside Another Web Framework To use Jersey alongside another web framework, such as Spring MVC, it should be configured so that it will allow the other framework to handle requests that it cannot handle. First, configure Jersey to use a filter rather than a servlet by configuring the `spring.jersey.type` application property with a value of `filter`. Second, configure your [`ResourceConfig`](https://javadoc.io/doc/org.glassfish.jersey.core/jersey-server/4.0.2/org/glassfish/jersey/server/ResourceConfig.html) to forward requests that would have resulted in a 404, as shown in the following example. ```java import org.glassfish.jersey.server.ResourceConfig; import org.glassfish.jersey.servlet.ServletProperties; import org.springframework.stereotype.Component; @Component public class JerseyConfig extends ResourceConfig { public JerseyConfig() { register(Endpoint.class); property(ServletProperties.FILTER_FORWARD_ON_404, true); } } ``` * [Spring Boot](../index.html) * [4.1.1](jersey.html) * [4.0.8](../4.0/how-to/jersey.html) * [3.5.16](../3.5/how-to/jersey.html) * [3.4.13](../3.4/how-to/jersey.html) * [3.3.13](../3.3/how-to/jersey.html) - [4.2.0-M2](../4.2/how-to/jersey.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/jersey.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/jersey.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/jersey.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/messaging/kafka.html ---- # Apache Kafka Support [Apache Kafka](https://kafka.apache.org/) is supported by providing auto-configuration of the `spring-kafka` project. Kafka configuration is controlled by external configuration properties in `spring.kafka.*`. For example, you might declare the following section in `application.properties`: * Properties * YAML ```properties spring.kafka.bootstrap-servers=localhost:9092 spring.kafka.consumer.group-id=myGroup ``` ```yaml spring: kafka: bootstrap-servers: "localhost:9092" consumer: group-id: "myGroup" ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | To create a topic on startup, add a bean of type [`NewTopic`](https://kafka.apache.org/42/javadoc/org/apache/kafka/clients/admin/NewTopic.html). If the topic already exists, the bean is ignored. | See [`KafkaProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/kafka/autoconfigure/KafkaProperties.html) for more supported options. ## [](#messaging.kafka.sending)Sending a Message Spring’s [`KafkaTemplate`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/core/KafkaTemplate.html) is auto-configured, and you can autowire it directly in your own beans, as shown in the following example: * Java * Kotlin ```java import org.springframework.kafka.core.KafkaTemplate; import org.springframework.stereotype.Component; @Component public class MyBean { private final KafkaTemplate kafkaTemplate; public MyBean(KafkaTemplate kafkaTemplate) { this.kafkaTemplate = kafkaTemplate; } // ... public void someMethod() { this.kafkaTemplate.send("someTopic", "Hello"); } } ``` ```kotlin import org.springframework.kafka.core.KafkaTemplate import org.springframework.stereotype.Component @Component class MyBean(private val kafkaTemplate: KafkaTemplate) { // ... fun someMethod() { kafkaTemplate.send("someTopic", "Hello") } } ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If the property `spring.kafka.producer.transaction-id-prefix` is defined, a [`KafkaTransactionManager`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/transaction/KafkaTransactionManager.html) is automatically configured. Also, if a [`RecordMessageConverter`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/support/converter/RecordMessageConverter.html) bean is defined, it is automatically associated to the auto-configured [`KafkaTemplate`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/core/KafkaTemplate.html). | If there’s a bean of type `KafkaTemplateObservationConvention` in the context, it is automatically registered on the `KafkaTemplate`. ## [](#messaging.kafka.receiving)Receiving a Message When the Apache Kafka infrastructure is present, any bean can be annotated with [`@KafkaListener`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/annotation/KafkaListener.html) to create a listener endpoint. If no [`KafkaListenerContainerFactory`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/config/KafkaListenerContainerFactory.html) has been defined, a default one is automatically configured with keys defined in `spring.kafka.listener.*`. The following component creates a listener endpoint on the `someTopic` topic: * Java * Kotlin ```java import org.springframework.kafka.annotation.KafkaListener; import org.springframework.stereotype.Component; @Component public class MyBean { @KafkaListener(topics = "someTopic") public void processMessage(String content) { // ... } } ``` ```kotlin import org.springframework.kafka.annotation.KafkaListener import org.springframework.stereotype.Component @Component class MyBean { @KafkaListener(topics = ["someTopic"]) fun processMessage(content: String?) { // ... } } ``` If a [`KafkaTransactionManager`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/transaction/KafkaTransactionManager.html) bean is defined, it is automatically associated to the container factory. Similarly, if a [`RecordFilterStrategy`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/listener/adapter/RecordFilterStrategy.html), [`CommonErrorHandler`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/listener/CommonErrorHandler.html), [`AfterRollbackProcessor`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/listener/AfterRollbackProcessor.html) or [`ConsumerAwareRebalanceListener`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/listener/ConsumerAwareRebalanceListener.html) bean is defined, it is automatically associated to the default factory. Depending on the listener type, a [`RecordMessageConverter`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/support/converter/RecordMessageConverter.html) or [`BatchMessageConverter`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/support/converter/BatchMessageConverter.html) bean is associated to the default factory. If only a [`RecordMessageConverter`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/support/converter/RecordMessageConverter.html) bean is present for a batch listener, it is wrapped in a [`BatchMessageConverter`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/support/converter/BatchMessageConverter.html). | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | A custom [`ChainedKafkaTransactionManager`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/transaction/ChainedKafkaTransactionManager.html) must be marked [`@Primary`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Primary.html) as it usually references the auto-configured [`KafkaTransactionManager`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/transaction/KafkaTransactionManager.html) bean. | If there’s a bean of type `KafkaListenerObservationConvention` in the context, it is automatically registered on the container factory. ## [](#messaging.kafka.streams)Kafka Streams Spring for Apache Kafka provides a factory bean to create a [`StreamsBuilder`](https://kafka.apache.org/42/javadoc/org/apache/kafka/streams/StreamsBuilder.html) object and manage the lifecycle of its streams. Spring Boot auto-configures the required [`KafkaStreamsConfiguration`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/config/KafkaStreamsConfiguration.html) bean as long as `kafka-streams` is on the classpath and Kafka Streams is enabled by the [`@EnableKafkaStreams`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/annotation/EnableKafkaStreams.html) annotation. Enabling Kafka Streams means that the application id and bootstrap servers must be set. The former can be configured using `spring.kafka.streams.application-id`, defaulting to `spring.application.name` if not set. The latter can be set globally or specifically overridden only for streams. Several additional properties are available using dedicated properties; other arbitrary Kafka properties can be set using the `spring.kafka.streams.properties` namespace. See also [Additional Kafka Properties](#messaging.kafka.additional-properties) for more information. To use the factory bean, wire [`StreamsBuilder`](https://kafka.apache.org/42/javadoc/org/apache/kafka/streams/StreamsBuilder.html) into your [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) as shown in the following example: * Java * Kotlin ```java import java.util.Locale; import org.apache.kafka.common.serialization.Serdes; import org.apache.kafka.streams.KeyValue; import org.apache.kafka.streams.StreamsBuilder; import org.apache.kafka.streams.kstream.KStream; import org.apache.kafka.streams.kstream.Produced; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.kafka.annotation.EnableKafkaStreams; import org.springframework.kafka.support.serializer.JacksonJsonSerde; @Configuration(proxyBeanMethods = false) @EnableKafkaStreams public class MyKafkaStreamsConfiguration { @Bean public KStream kStream(StreamsBuilder streamsBuilder) { KStream stream = streamsBuilder.stream("ks1In"); stream.map(this::uppercaseValue).to("ks1Out", Produced.with(Serdes.Integer(), new JacksonJsonSerde<>())); return stream; } private KeyValue uppercaseValue(Integer key, String value) { return new KeyValue<>(key, value.toUpperCase(Locale.getDefault())); } } ``` ```kotlin import org.apache.kafka.common.serialization.Serdes import org.apache.kafka.streams.KeyValue import org.apache.kafka.streams.StreamsBuilder import org.apache.kafka.streams.kstream.KStream import org.apache.kafka.streams.kstream.Produced import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.kafka.annotation.EnableKafkaStreams import org.springframework.kafka.support.serializer.JacksonJsonSerde @Configuration(proxyBeanMethods = false) @EnableKafkaStreams class MyKafkaStreamsConfiguration { @Bean fun kStream(streamsBuilder: StreamsBuilder): KStream { val stream = streamsBuilder.stream("ks1In") stream.map(this::uppercaseValue).to("ks1Out", Produced.with(Serdes.Integer(), JacksonJsonSerde())) return stream } private fun uppercaseValue(key: Int, value: String): KeyValue { return KeyValue(key, value.uppercase()) } } ``` By default, the streams managed by the [`StreamsBuilder`](https://kafka.apache.org/42/javadoc/org/apache/kafka/streams/StreamsBuilder.html) object are started automatically. You can customize this behavior using the `spring.kafka.streams.auto-startup` property. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can also register an arbitrary number of beans that implement [`StreamsBuilderFactoryBeanConfigurer`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/config/StreamsBuilderFactoryBeanConfigurer.html) for more advanced customizations. | ## [](#messaging.kafka.additional-properties)Additional Kafka Properties The properties supported by auto configuration are shown in the [Integration Properties](../../appendix/application-properties/index.html#appendix.application-properties.integration) section of the Appendix. Note that, for the most part, these properties (hyphenated or camelCase) map directly to the Apache Kafka dotted properties. See the Apache Kafka documentation for details. Properties that don’t include a client type (`producer`, `consumer`, `admin`, or `streams`) in their name are considered to be common and apply to all clients. Most of these common properties can be overridden for one or more of the client types, if needed. Apache Kafka designates properties with an importance of HIGH, MEDIUM, or LOW. Spring Boot auto-configuration supports all HIGH importance properties, some selected MEDIUM and LOW properties, and any properties that do not have a default value. Only a subset of the properties supported by Kafka are available directly through the [`KafkaProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/kafka/autoconfigure/KafkaProperties.html) class. If you wish to configure the individual client types with additional properties that are not directly supported, use the following properties: * Properties * YAML ```properties spring.kafka.properties[prop.one]=first spring.kafka.admin.properties[prop.two]=second spring.kafka.consumer.properties[prop.three]=third spring.kafka.producer.properties[prop.four]=fourth spring.kafka.streams.properties[prop.five]=fifth ``` ```yaml spring: kafka: properties: "[prop.one]": "first" admin: properties: "[prop.two]": "second" consumer: properties: "[prop.three]": "third" producer: properties: "[prop.four]": "fourth" streams: properties: "[prop.five]": "fifth" ``` This sets the common `prop.one` Kafka property to `first` (applies to producers, consumers, admins, and streams), the `prop.two` admin property to `second`, the `prop.three` consumer property to `third`, the `prop.four` producer property to `fourth` and the `prop.five` streams property to `fifth`. You can also configure the Spring Kafka [`JacksonJsonDeserializer`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/support/serializer/JacksonJsonDeserializer.html) as follows: * Properties * YAML ```properties spring.kafka.consumer.value-deserializer=org.springframework.kafka.support.serializer.JacksonJsonDeserializer spring.kafka.consumer.properties[spring.json.value.default.type]=com.example.Invoice spring.kafka.consumer.properties[spring.json.trusted.packages]=com.example.main,com.example.another ``` ```yaml spring: kafka: consumer: value-deserializer: "org.springframework.kafka.support.serializer.JacksonJsonDeserializer" properties: "[spring.json.value.default.type]": "com.example.Invoice" "[spring.json.trusted.packages]": "com.example.main,com.example.another" ``` Similarly, you can disable the [`JacksonJsonSerializer`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/support/serializer/JacksonJsonSerializer.html) default behavior of sending type information in headers: * Properties * YAML ```properties spring.kafka.producer.value-serializer=org.springframework.kafka.support.serializer.JacksonJsonSerializer spring.kafka.producer.properties[spring.json.add.type.headers]=false ``` ```yaml spring: kafka: producer: value-serializer: "org.springframework.kafka.support.serializer.JacksonJsonSerializer" properties: "[spring.json.add.type.headers]": false ``` | | | | -- | ------------------------------------------------------------------------------------------------ | | ** | Properties set in this way override any configuration item that Spring Boot explicitly supports. | ## [](#messaging.kafka.embedded)Testing with Embedded Kafka Spring for Apache Kafka provides a convenient way to test projects with an embedded Apache Kafka broker. To use this feature, annotate a test class with [`@EmbeddedKafka`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/test/context/EmbeddedKafka.html) from the `spring-kafka-test` module. For more information, please see the Spring for Apache Kafka [reference manual](https://docs.spring.io/spring-kafka/reference/4.1/testing.html#ekb). To make Spring Boot auto-configuration work with the aforementioned embedded Apache Kafka broker, you need to remap a system property for embedded broker addresses (populated by the [`EmbeddedKafkaBroker`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/test/EmbeddedKafkaBroker.html)) into the Spring Boot configuration property for Apache Kafka. There are several ways to do that: * Provide a system property to map embedded broker addresses into `spring.kafka.bootstrap-servers` in the test class: - Java - Kotlin ```java static { System.setProperty(EmbeddedKafkaBroker.BROKER_LIST_PROPERTY, "spring.kafka.bootstrap-servers"); } ``` ```kotlin init { System.setProperty(EmbeddedKafkaBroker.BROKER_LIST_PROPERTY, "spring.kafka.bootstrap-servers") } ``` * Configure a property name on the [`@EmbeddedKafka`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/test/context/EmbeddedKafka.html) annotation: - Java - Kotlin ```java import org.springframework.boot.test.context.SpringBootTest; import org.springframework.kafka.test.context.EmbeddedKafka; @SpringBootTest @EmbeddedKafka(topics = "someTopic", bootstrapServersProperty = "spring.kafka.bootstrap-servers") class MyTest { // ... } ``` ```kotlin import org.springframework.boot.test.context.SpringBootTest import org.springframework.kafka.test.context.EmbeddedKafka @SpringBootTest @EmbeddedKafka(topics = ["someTopic"], bootstrapServersProperty = "spring.kafka.bootstrap-servers") class MyTest { // ... } ``` * Use a placeholder in configuration properties: - Properties - YAML ```properties spring.kafka.bootstrap-servers=${spring.embedded.kafka.brokers} ``` ```yaml spring: kafka: bootstrap-servers: "${spring.embedded.kafka.brokers}" ``` * [Spring Boot](../../index.html) * [4.1.1](kafka.html) * [4.0.8](../../4.0/reference/messaging/kafka.html) * [3.5.16](../../3.5/reference/messaging/kafka.html) * [3.4.13](../../3.4/reference/messaging/kafka.html) * [3.3.13](../../3.3/reference/messaging/kafka.html) - [4.2.0-M2](../../4.2/reference/messaging/kafka.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/messaging/kafka.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/messaging/kafka.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/messaging/kafka.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/features/developing-auto-configuration.html ---- # Creating Your Own Auto-configuration If you work in a company that develops shared libraries, or if you work on an open-source or commercial library, you might want to develop your own auto-configuration. Auto-configuration classes can be bundled in external jars and still be picked up by Spring Boot. Auto-configuration can be associated to a “starter” that provides the auto-configuration code as well as the typical libraries that you would use with it. We first cover what you need to know to build your own auto-configuration and then we move on to the [typical steps required to create a custom starter](#features.developing-auto-configuration.custom-starter). ## [](#features.developing-auto-configuration.understanding-auto-configured-beans)Understanding Auto-configured Beans Classes that implement auto-configuration are annotated with [`@AutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/AutoConfiguration.html). This annotation itself is meta-annotated with [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html), making auto-configurations standard [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) classes. Additional [`@Conditional`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Conditional.html) annotations are used to constrain when the auto-configuration should apply. Usually, auto-configuration classes use [`@ConditionalOnClass`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnClass.html) and [`@ConditionalOnMissingBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.html) annotations. This ensures that auto-configuration applies only when relevant classes are found and when you have not declared your own [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html). You can browse the source code of [`spring-boot-autoconfigure`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/core/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure) to see the core [`@AutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/AutoConfiguration.html) classes that Spring provides (see the [`META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/core/spring-boot-autoconfigure/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports) file). You can also look at the equivalent file in other modules to see the auto-configurations that they provide. ## [](#features.developing-auto-configuration.locating-auto-configuration-candidates)Locating Auto-configuration Candidates Spring Boot checks for the presence of a `META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports` file within your published jar. The file should list your configuration classes, with one class name per line, as shown in the following example: ```none com.mycorp.libx.autoconfigure.LibXAutoConfiguration com.mycorp.libx.autoconfigure.LibXWebAutoConfiguration ``` | | | | -- | ----------------------------------------------------------------- | | ** | You can add comments to the imports file using the `#` character. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | In the unusual case that an auto-configuration class is not a top-level class, its class name should use `$` to separate it from its containing class, for example `com.example.Outer$NestedAutoConfiguration`. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Auto-configurations must be loaded *only* by being named in the imports file. Make sure that they are defined in a specific package space and that they are never the target of component scanning. Furthermore, auto-configuration classes should not enable component scanning to find additional components. Specific [`@Import`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Import.html) annotations should be used instead. | If your configuration needs to be applied in a specific order, you can use the `before`, `beforeName`, `after` and `afterName` attributes on the [`@AutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/AutoConfiguration.html) annotation or the dedicated [`@AutoConfigureBefore`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/AutoConfigureBefore.html) and [`@AutoConfigureAfter`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/AutoConfigureAfter.html) annotations. For example, if you provide web-specific configuration, your class may need to be applied after [`WebMvcAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/autoconfigure/WebMvcAutoConfiguration.html). If you want to order certain auto-configurations that should not have any direct knowledge of each other, you can also use [`@AutoConfigureOrder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/AutoConfigureOrder.html). That annotation has the same semantic as the regular [`@Order`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/annotation/Order.html) annotation but provides a dedicated order for auto-configuration classes. As with standard [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) classes, the order in which auto-configuration classes are applied only affects the order in which their beans are defined. The order in which those beans are subsequently created is unaffected and is determined by each bean’s dependencies and any [`@DependsOn`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/DependsOn.html) relationships. ### [](#features.developing-auto-configuration.locating-auto-configuration-candidates.deprecating)Deprecating and Replacing Auto-configuration Classes You may need to occasionally deprecate auto-configuration classes and offer an alternative. For example, you may want to change the package name where your auto-configuration class resides. Since auto-configuration classes may be referenced in `before`/`after` ordering and `excludes`, you’ll need to add an additional file that tells Spring Boot how to deal with replacements. To define replacements, create a `META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.replacements` file indicating the link between the old class and the new one. For example: ```none com.mycorp.libx.autoconfigure.LibXAutoConfiguration=com.mycorp.libx.autoconfigure.core.LibXAutoConfiguration ``` | | | | -- | ------------------------------------------------------------------------------------------------------ | | ** | The `AutoConfiguration.imports` file should also be updated to *only* reference the replacement class. | ## [](#features.developing-auto-configuration.condition-annotations)Condition Annotations You almost always want to include one or more [`@Conditional`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Conditional.html) annotations on your auto-configuration class. The [`@ConditionalOnMissingBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.html) annotation is one common example that is used to allow developers to override auto-configuration if they are not happy with your defaults. Spring Boot includes a number of [`@Conditional`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Conditional.html) annotations that you can reuse in your own code by annotating [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) classes or individual [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) methods. These annotations include: * [Class Conditions](#features.developing-auto-configuration.condition-annotations.class-conditions) * [Bean Conditions](#features.developing-auto-configuration.condition-annotations.bean-conditions) * [Property Conditions](#features.developing-auto-configuration.condition-annotations.property-conditions) * [Resource Conditions](#features.developing-auto-configuration.condition-annotations.resource-conditions) * [Web Application Conditions](#features.developing-auto-configuration.condition-annotations.web-application-conditions) * [SpEL Expression Conditions](#features.developing-auto-configuration.condition-annotations.spel-conditions) ### [](#features.developing-auto-configuration.condition-annotations.class-conditions)Class Conditions The [`@ConditionalOnClass`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnClass.html) and [`@ConditionalOnMissingClass`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingClass.html) annotations let [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) classes be included based on the presence or absence of specific classes. Due to the fact that annotation metadata is parsed by using [ASM](https://asm.ow2.io/), you can use the `value` attribute to refer to the real class, even though that class might not actually appear on the running application classpath. You can also use the `name` attribute if you prefer to specify the class name by using a [`String`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html) value. This mechanism does not apply the same way to [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) methods where typically the return type is the target of the condition: before the condition on the method applies, the JVM will have loaded the class and potentially processed method references which will fail if the class is not present. To handle this scenario, a separate [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class can be used to isolate the condition, as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.autoconfigure.AutoConfiguration; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @AutoConfiguration // Some conditions ... public final class MyAutoConfiguration { // Auto-configured beans ... @Configuration(proxyBeanMethods = false) @ConditionalOnClass(SomeService.class) static class SomeServiceConfiguration { @Bean @ConditionalOnMissingBean SomeService someService() { return new SomeService(); } } } ``` ```kotlin import org.springframework.boot.autoconfigure.AutoConfiguration import org.springframework.boot.autoconfigure.condition.ConditionalOnClass import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @AutoConfiguration // Some conditions ... class MyAutoConfiguration { // Auto-configured beans ... @Configuration(proxyBeanMethods = false) @ConditionalOnClass(SomeService::class) class SomeServiceConfiguration { @Bean @ConditionalOnMissingBean fun someService(): SomeService { return SomeService() } } } ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you use [`@ConditionalOnClass`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnClass.html) or [`@ConditionalOnMissingClass`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingClass.html) as a part of a meta-annotation to compose your own composed annotations, you must use `name` as referring to the class in such a case is not handled. | ### [](#features.developing-auto-configuration.condition-annotations.bean-conditions)Bean Conditions The [`@ConditionalOnBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBean.html) and [`@ConditionalOnMissingBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.html) annotations let a bean be included based on the presence or absence of specific beans. You can use the `value` attribute to specify beans by type or `name` to specify beans by name. The `search` attribute lets you limit the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) hierarchy that should be considered when searching for beans. When placed on a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) method, the target type defaults to the return type of the method, as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.autoconfigure.AutoConfiguration; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.context.annotation.Bean; @AutoConfiguration public final class MyAutoConfiguration { @Bean @ConditionalOnMissingBean SomeService someService() { return new SomeService(); } } ``` ```kotlin import org.springframework.boot.autoconfigure.AutoConfiguration import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean import org.springframework.context.annotation.Bean @AutoConfiguration class MyAutoConfiguration { @Bean @ConditionalOnMissingBean fun someService(): SomeService { return SomeService() } } ``` In the preceding example, the `someService` bean is going to be created if no bean of type `SomeService` is already contained in the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html). | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | You need to be very careful about the order in which bean definitions are added, as these conditions are evaluated based on what has been processed so far. For this reason, we recommend using only [`@ConditionalOnBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBean.html) and [`@ConditionalOnMissingBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.html) annotations on auto-configuration classes (since these are guaranteed to load after any user-defined bean definitions have been added). | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | [`@ConditionalOnBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBean.html) and [`@ConditionalOnMissingBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.html) do not prevent [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) classes from being created. The only difference between using these conditions at the class level and marking each contained [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) method with the annotation is that the former prevents registration of the [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class as a bean if the condition does not match. | | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | When declaring a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) method, provide as much type information as possible in the method’s return type. For example, if your bean’s concrete class implements an interface the bean method’s return type should be the concrete class and not the interface. Providing as much type information as possible in [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) methods is particularly important when using bean conditions as their evaluation can only rely upon to type information that is available in the method signature. | ### [](#features.developing-auto-configuration.condition-annotations.property-conditions)Property Conditions The [`@ConditionalOnProperty`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnProperty.html) annotation lets configuration be included based on a Spring Environment property. Use the `prefix` and `name` attributes to specify the property that should be checked. By default, any property that exists and is not equal to `false` is matched. There is also a dedicated [`@ConditionalOnBooleanProperty`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBooleanProperty.html) annotation specifically made for boolean properties. With both annotations you can also create more advanced checks by using the `havingValue` and `matchIfMissing` attributes. If multiple names are given in the `name` attribute, all of the properties have to pass the test for the condition to match. ### [](#features.developing-auto-configuration.condition-annotations.resource-conditions)Resource Conditions The [`@ConditionalOnResource`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnResource.html) annotation lets configuration be included only when a specific resource is present. Resources can be specified by using the usual Spring conventions, as shown in the following example: `file:/home/user/test.dat`. ### [](#features.developing-auto-configuration.condition-annotations.web-application-conditions)Web Application Conditions The [`@ConditionalOnWebApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnWebApplication.html) and [`@ConditionalOnNotWebApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnNotWebApplication.html) annotations let configuration be included depending on whether the application is a web application. A servlet-based web application is any application that uses a Spring [`WebApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/context/WebApplicationContext.html), defines a `session` scope, or has a [`ConfigurableWebEnvironment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/context/ConfigurableWebEnvironment.html). A reactive web application is any application that uses a [`ReactiveWebApplicationContext`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/context/reactive/ReactiveWebApplicationContext.html), or has a [`ConfigurableReactiveWebEnvironment`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/context/reactive/ConfigurableReactiveWebEnvironment.html). The [`@ConditionalOnWarDeployment`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnWarDeployment.html) and [`@ConditionalOnNotWarDeployment`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnNotWarDeployment.html) annotations let configuration be included depending on whether the application is a traditional WAR application that is deployed to a servlet container. This condition will not match for applications that are run with an embedded web server. ### [](#features.developing-auto-configuration.condition-annotations.spel-conditions)SpEL Expression Conditions The [`@ConditionalOnExpression`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnExpression.html) annotation lets configuration be included based on the result of a [SpEL expression](https://docs.spring.io/spring-framework/reference/7.0/core/expressions.html). | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Referencing a bean in the expression will cause that bean to be initialized very early in context refresh processing. As a result, the bean won’t be eligible for post-processing (such as configuration properties binding) and its state may be incomplete. | ## [](#features.developing-auto-configuration.testing)Testing your Auto-configuration An auto-configuration can be affected by many factors: user configuration (`@Bean` definition and [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) customization), condition evaluation (presence of a particular library), and others. Concretely, each test should create a well defined [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) that represents a combination of those customizations. [`ApplicationContextRunner`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/runner/ApplicationContextRunner.html) provides a great way to achieve that. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | [`ApplicationContextRunner`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/runner/ApplicationContextRunner.html) doesn’t work when running the tests in a native image. | [`ApplicationContextRunner`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/runner/ApplicationContextRunner.html) is usually defined as a field of the test class to gather the base, common configuration. The following example makes sure that `MyServiceAutoConfiguration` is always invoked: * Java * Kotlin ```java private final ApplicationContextRunner contextRunner = new ApplicationContextRunner() .withConfiguration(AutoConfigurations.of(MyServiceAutoConfiguration.class)); ``` ```kotlin val contextRunner = ApplicationContextRunner() .withConfiguration(AutoConfigurations.of(MyServiceAutoConfiguration::class.java)) ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If multiple auto-configurations have to be defined, there is no need to order their declarations as they are invoked in the exact same order as when running the application. | Each test can use the runner to represent a particular use case. For instance, the sample below invokes a user configuration (`UserConfiguration`) and checks that the auto-configuration backs off properly. Invoking `run` provides a callback context that can be used with AssertJ. * Java * Kotlin ```java @Test void defaultServiceBacksOff() { this.contextRunner.withUserConfiguration(UserConfiguration.class).run((context) -> { assertThat(context).hasSingleBean(MyService.class); assertThat(context).getBean("myCustomService").isSameAs(context.getBean(MyService.class)); }); } @Configuration(proxyBeanMethods = false) static class UserConfiguration { @Bean MyService myCustomService() { return new MyService("mine"); } } ``` ```kotlin @Test fun defaultServiceBacksOff() { contextRunner.withUserConfiguration(UserConfiguration::class.java) .run { context: AssertableApplicationContext -> assertThat(context).hasSingleBean(MyService::class.java) assertThat(context).getBean("myCustomService") .isSameAs(context.getBean(MyService::class.java)) } } @Configuration(proxyBeanMethods = false) internal class UserConfiguration { @Bean fun myCustomService(): MyService { return MyService("mine") } } ``` It is also possible to easily customize the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html), as shown in the following example: * Java * Kotlin ```java @Test void serviceNameCanBeConfigured() { this.contextRunner.withPropertyValues("user.name=test123").run((context) -> { assertThat(context).hasSingleBean(MyService.class); assertThat(context.getBean(MyService.class).getName()).isEqualTo("test123"); }); } ``` ```kotlin @Test fun serviceNameCanBeConfigured() { contextRunner.withPropertyValues("user.name=test123").run { context: AssertableApplicationContext -> assertThat(context).hasSingleBean(MyService::class.java) assertThat(context.getBean(MyService::class.java).name).isEqualTo("test123") } } ``` The runner can also be used to display the [`ConditionEvaluationReport`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionEvaluationReport.html). The report can be printed at `INFO` or `DEBUG` level. The following example shows how to use the [`ConditionEvaluationReportLoggingListener`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/logging/ConditionEvaluationReportLoggingListener.html) to print the report in auto-configuration tests. * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener; import org.springframework.boot.logging.LogLevel; import org.springframework.boot.test.context.runner.ApplicationContextRunner; class MyConditionEvaluationReportingTests { @Test void autoConfigTest() { new ApplicationContextRunner() .withInitializer(ConditionEvaluationReportLoggingListener.forLogLevel(LogLevel.INFO)) .run((context) -> { // Test something... }); } } ``` ```kotlin import org.junit.jupiter.api.Test import org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener import org.springframework.boot.logging.LogLevel import org.springframework.boot.test.context.assertj.AssertableApplicationContext import org.springframework.boot.test.context.runner.ApplicationContextRunner class MyConditionEvaluationReportingTests { @Test fun autoConfigTest() { ApplicationContextRunner() .withInitializer(ConditionEvaluationReportLoggingListener.forLogLevel(LogLevel.INFO)) .run { context: AssertableApplicationContext? -> // Test something... } } } ``` ### [](#features.developing-auto-configuration.testing.simulating-a-web-context)Simulating a Web Context If you need to test an auto-configuration that only operates in a servlet or reactive web application context, use the [`WebApplicationContextRunner`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/runner/WebApplicationContextRunner.html) or [`ReactiveWebApplicationContextRunner`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/runner/ReactiveWebApplicationContextRunner.html) respectively. ### [](#features.developing-auto-configuration.testing.overriding-classpath)Overriding the Classpath It is also possible to test what happens when a particular class and/or package is not present at runtime. Spring Boot ships with a [`FilteredClassLoader`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/FilteredClassLoader.html) that can easily be used by the runner. In the following example, we assert that if `MyService` is not present, the auto-configuration is properly disabled: * Java * Kotlin ```java @Test void serviceIsIgnoredIfLibraryIsNotPresent() { this.contextRunner.withClassLoader(new FilteredClassLoader(MyService.class)) .run((context) -> assertThat(context).doesNotHaveBean("myService")); } ``` ```kotlin @Test fun serviceIsIgnoredIfLibraryIsNotPresent() { contextRunner.withClassLoader(FilteredClassLoader(MyService::class.java)) .run { context: AssertableApplicationContext? -> assertThat(context).doesNotHaveBean("myService") } } ``` ## [](#features.developing-auto-configuration.custom-starter)Creating Your Own Starter A typical Spring Boot starter contains code to auto-configure and customize the infrastructure of a given technology, let’s call that "acme". To make it easily extensible, a number of configuration keys in a dedicated namespace can be exposed to the environment. Finally, a single "starter" dependency is provided to help users get started as easily as possible. Concretely, a custom starter can contain the following: * The `acme-spring-boot` module that contains the auto-configuration code for "acme" as well as any API to use the feature. * The `acme-spring-boot-starter` module that provides a dependency to the other starters required by "acme", `acme-spring-boot`, and potentially additional dependencies that are typically useful. In a nutshell, adding the starter should provide everything needed to start using that library. This separation in two modules is in no way necessary. If "acme" has several flavors, options or optional features, then it is better to separate the auto-configuration as you can clearly express the fact some features are optional. Besides, you have the ability to craft a starter that provides an opinion about those optional dependencies. At the same time, others can rely only on `acme-spring-boot` and craft their own starter with different opinions. If the auto-configuration is relatively straightforward and does not have optional features, merging the two modules in the starter is definitely an option. If "acme" has a basic set of dependencies that are required to work, but you want to express a more opinionated view, then having a separate starter is a good option. When testing "acme" features, you may need test-specific auto-configurations. For example, you could offer a way to replace external dependencies with in-memory alternatives. A separate test-scoped starter can be created for this purpose, following the same principles. ### [](#features.developing-auto-configuration.custom-starter.naming)Naming You should make sure to provide a proper namespace for your starter. Do not start your module names with `spring-boot`, even if you use a different Maven `groupId`. We may offer official support for the thing you auto-configure in the future. As a rule of thumb, you should name a combined module after the starter. For example, assume that you are creating a starter for "acme" and that you name the auto-configure module `acme-spring-boot` and the starter `acme-spring-boot-starter`. If you only have one module that combines the two, name it `acme-spring-boot-starter`. If "acme" also has a test-scoped starter, name it `acme-spring-boot-starter-test`. ### [](#features.developing-auto-configuration.custom-starter.configuration-keys)Configuration keys If your starter provides configuration keys, use a unique namespace for them. In particular, do not include your keys in the namespaces that Spring Boot uses (such as `server`, `management`, `spring`, and so on). If you use the same namespace, we may modify these namespaces in the future in ways that break your modules. As a rule of thumb, prefix all your keys with a namespace that you own (for example `acme`). Make sure that configuration keys are documented by adding field Javadoc for each property, as shown in the following example: * Java * Kotlin ```java import java.time.Duration; import org.springframework.boot.context.properties.ConfigurationProperties; @ConfigurationProperties("acme") public class AcmeProperties { /** * Whether to check the location of acme resources. */ private boolean checkLocation = true; /** * Timeout for establishing a connection to the acme server. */ private Duration loginTimeout = Duration.ofSeconds(3); // getters/setters ... public boolean isCheckLocation() { return this.checkLocation; } public void setCheckLocation(boolean checkLocation) { this.checkLocation = checkLocation; } public Duration getLoginTimeout() { return this.loginTimeout; } public void setLoginTimeout(Duration loginTimeout) { this.loginTimeout = loginTimeout; } } ``` ```kotlin import org.springframework.boot.context.properties.ConfigurationProperties import java.time.Duration @ConfigurationProperties("acme") class AcmeProperties( /** * Whether to check the location of acme resources. */ var isCheckLocation: Boolean = true, /** * Timeout for establishing a connection to the acme server. */ var loginTimeout:Duration = Duration.ofSeconds(3)) ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | You should only use plain text with [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) field Javadoc, since they are not processed before being added to the JSON. | If you use [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) with record class then record components' descriptions should be provided via class-level Javadoc tag `@param` (there are no explicit instance fields in record classes to put regular field-level Javadocs on). Here are some rules we follow internally to make sure descriptions are consistent: * Do not start the description by "The" or "A". * For `boolean` types, start the description with "Whether" or "Enable". * For collection-based types, start the description with "Comma-separated list" * Use [`Duration`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html) rather than `long` and describe the default unit if it differs from milliseconds, such as "If a duration suffix is not specified, seconds will be used". * Do not provide the default value in the description unless it has to be determined at runtime. Make sure to [trigger meta-data generation](../../specification/configuration-metadata/annotation-processor.html) so that IDE assistance is available for your keys as well. You may want to review the generated metadata (`META-INF/spring-configuration-metadata.json`) to make sure your keys are properly documented. Using your own starter in a compatible IDE is also a good idea to validate that quality of the metadata. ### [](#features.developing-auto-configuration.custom-starter.autoconfigure-module)The “autoconfigure” Module The `autoconfigure` module contains everything that is necessary to get started with the library. It may also contain configuration key definitions (such as [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html)) and any callback interface that can be used to further customize how the components are initialized. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You should mark the dependencies to the library as optional so that you can include the `autoconfigure` module in your projects more easily. If you do it that way, the library is not provided and, by default, Spring Boot backs off. | Spring Boot uses an annotation processor to collect the conditions on auto-configurations in a metadata file (`META-INF/spring-autoconfigure-metadata.properties`). If that file is present, it is used to eagerly filter auto-configurations that do not match, which will improve startup time. When building with Maven, configure the compiler plugin (3.12.0 or later) to add `spring-boot-autoconfigure-processor` to the annotation processor paths: ```xml org.apache.maven.plugins maven-compiler-plugin org.springframework.boot spring-boot-autoconfigure-processor ``` With Gradle, the dependency should be declared in the `annotationProcessor` configuration, as shown in the following example: ```gradle dependencies { annotationProcessor "org.springframework.boot:spring-boot-autoconfigure-processor" } ``` ### [](#features.developing-auto-configuration.custom-starter.starter-module)Starter Module The starter is really an empty jar. Its only purpose is to provide the necessary dependencies to work with the library. You can think of it as an opinionated view of what is required to get started. Do not make assumptions about the project in which your starter is added. If the library you are auto-configuring typically requires other starters, mention them as well. Providing a proper set of *default* dependencies may be hard if the number of optional dependencies is high, as you should avoid including dependencies that are unnecessary for a typical usage of the library. In other words, you should not include optional dependencies. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Either way, your starter must reference the core Spring Boot starter (`spring-boot-starter`) directly or indirectly (there is no need to add it if your starter relies on another starter). If a project is created with only your custom starter, Spring Boot’s core features will be honoured by the presence of the core starter. | * [Spring Boot](../../index.html) * [4.1.1](developing-auto-configuration.html) * [4.0.8](../../4.0/reference/features/developing-auto-configuration.html) * [3.5.16](../../3.5/reference/features/developing-auto-configuration.html) * [3.4.13](../../3.4/reference/features/developing-auto-configuration.html) * [3.3.13](../../3.3/reference/features/developing-auto-configuration.html) - [4.2.0-M2](../../4.2/reference/features/developing-auto-configuration.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/features/developing-auto-configuration.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/features/developing-auto-configuration.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/features/developing-auto-configuration.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/DockerSpec.html ---- # Class DockerSpec [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.gradle.tasks.bundling.DockerSpec *** public abstract class DockerSpec extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") Encapsulates Docker configuration options. `DockerSpec.DockerRegistrySpec` Encapsulates Docker registry authentication configuration options. - ## Constructor Summary Constructors Constructor Description `DockerSpec(ObjectFactory objects)`   - ## Method Summary Modifier and Type Method Description `void` `builderRegistry(Action action)` Customizes the [`DockerSpec.DockerRegistrySpec`](DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") that configures authentication to the builder registry. `abstract Property` `getBindHostToBuilder()`   `DockerSpec.DockerRegistrySpec` `getBuilderRegistry()` Returns the [`DockerSpec.DockerRegistrySpec`](DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") that configures authentication to the builder registry. `abstract Property` `getCertPath()`   `abstract Property` `getContext()`   `abstract Property` `getHost()`   `DockerSpec.DockerRegistrySpec` `getPublishRegistry()` Returns the [`DockerSpec.DockerRegistrySpec`](DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") that configures authentication to the publishing registry. `abstract Property` `getTlsVerify()`   `void` `publishRegistry(Action action)` Customizes the [`DockerSpec.DockerRegistrySpec`](DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") that configures authentication to the publishing registry. ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### DockerSpec @Inject public DockerSpec​([ObjectFactory](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/model/ObjectFactory.html "class or interface in org.gradle.api.model") objects) * ## Method Details * ### getContext [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getContext() * ### getHost [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getHost() * ### getTlsVerify [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[Boolean](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html "class or interface in java.lang")> getTlsVerify() * ### getCertPath [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getCertPath() * ### getBindHostToBuilder [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[Boolean](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html "class or interface in java.lang")> getBindHostToBuilder() * ### getBuilderRegistry public [DockerSpec.DockerRegistrySpec](DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") getBuilderRegistry() Returns the [`DockerSpec.DockerRegistrySpec`](DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") that configures authentication to the builder registry. * Returns: the registry spec * ### builderRegistry public void builderRegistry​([Action](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Action.html "class or interface in org.gradle.api")<[DockerSpec.DockerRegistrySpec](DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling")> action) Customizes the [`DockerSpec.DockerRegistrySpec`](DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") that configures authentication to the builder registry. * Parameters: `action` - the action to apply * ### getPublishRegistry public [DockerSpec.DockerRegistrySpec](DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") getPublishRegistry() Returns the [`DockerSpec.DockerRegistrySpec`](DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") that configures authentication to the publishing registry. * Returns: the registry spec * ### publishRegistry public void publishRegistry​([Action](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Action.html "class or interface in org.gradle.api")<[DockerSpec.DockerRegistrySpec](DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling")> action) Customizes the [`DockerSpec.DockerRegistrySpec`](DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") that configures authentication to the publishing registry. * Parameters: `action` - the action to apply ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/deprecated-list.html ---- # Deprecated API ## Contents * [Methods](#method) - Deprecated Methods Method Description [org.springframework.boot.maven.PropertiesMergingResourceTransformer.processResource​(String, InputStream, List\)](org/springframework/boot/maven/PropertiesMergingResourceTransformer.html#processResource\(java.lang.String,java.io.InputStream,java.util.List\)) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/index-files/index-15.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ## V * [valueOf(String)](../org/springframework/boot/gradle/tasks/bundling/ZipCompression.html#valueOf\(java.lang.String\)) - Static method in enum class org.springframework.boot.gradle.tasks.bundling.[ZipCompression](../org/springframework/boot/gradle/tasks/bundling/ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") Returns the enum constant of this class with the specified name. * [values()](../org/springframework/boot/gradle/tasks/bundling/ZipCompression.html#values\(\)) - Static method in enum class org.springframework.boot.gradle.tasks.bundling.[ZipCompression](../org/springframework/boot/gradle/tasks/bundling/ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") Returns an array containing the constants of this enum class, in the order they are declared. * [VersionExtractor](../org/springframework/boot/gradle/util/VersionExtractor.html "class in org.springframework.boot.gradle.util") - Class in [org.springframework.boot.gradle.util](../org/springframework/boot/gradle/util/package-summary.html) Extracts version information for a Class. * [volume(Action)](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.html#volume\(org.gradle.api.Action\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[CacheSpec](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Configures a volume cache using the given `action`. * [VolumeCacheSpec()](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.VolumeCacheSpec.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.gradle.tasks.bundling.[CacheSpec.VolumeCacheSpec](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.VolumeCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling")   [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/buildinfo/class-use/BuildInfoProperties.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.buildinfo.BuildInfoProperties =================================================================== Packages that use [BuildInfoProperties](../BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") Package Description [org.springframework.boot.gradle.tasks.buildinfo](#org.springframework.boot.gradle.tasks.buildinfo) Support for producing build info for consumption by Spring Boot's actuator. * ## Uses of [BuildInfoProperties](../BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") in [org.springframework.boot.gradle.tasks.buildinfo](../package-summary.html) Methods in [org.springframework.boot.gradle.tasks.buildinfo](../package-summary.html) that return [BuildInfoProperties](../BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") Modifier and Type Method Description `BuildInfoProperties` BuildInfo.`getProperties()` Returns the [`properties`](../BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") that will be included in the written file. Method parameters in [org.springframework.boot.gradle.tasks.buildinfo](../package-summary.html) with type arguments of type [BuildInfoProperties](../BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") Modifier and Type Method Description `void` BuildInfo.`properties(Action action)` Executes the given `action` on the [`BuildInfo.getProperties()`](../BuildInfo.html#getProperties\(\)) properties. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/StartMojo.html ---- Uses of Class\ org.springframework.boot.maven.StartMojo ======================================== No usage of org.springframework.boot.maven.StartMojo ---- url: https://docs.spring.io/spring-boot/reference/features/logging.html ---- # Logging Spring Boot uses [Commons Logging](https://commons.apache.org/logging) for all internal logging but leaves the underlying log implementation open. Default configurations are provided for [Java Util Logging](https://docs.oracle.com/en/java/javase/17/docs/api/java.logging/java/util/logging/package-summary.html), [Log4j2](https://logging.apache.org/log4j/2.x/), and [Logback](https://logback.qos.ch/). In each case, loggers are pre-configured to use console output with optional file output also available. By default, if you use the starters, Logback is used for logging. Appropriate Logback routing is also included to ensure that dependent libraries that use Java Util Logging, Commons Logging, Log4J, or SLF4J all work correctly. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | There are a lot of logging frameworks available for Java. Do not worry if the above list seems confusing. Generally, you do not need to change your logging dependencies and the Spring Boot defaults work just fine. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | When you deploy your application to a servlet container or application server, logging performed with the Java Util Logging API is not routed into your application’s logs. This prevents logging performed by the container or other applications that have been deployed to it from appearing in your application’s logs. | ## [](#features.logging.log-format)Log Format The default log output from Spring Boot resembles the following example: ```none 2026-08-17T10:51:28.508Z INFO 11390 --- [myapp] [ main] o.s.b.d.f.logexample.MyApplication : Starting MyApplication using Java 25.0.4 with PID 11390 (/opt/apps/myapp.jar started by myuser in /opt/apps/) 2026-08-17T10:51:28.527Z INFO 11390 --- [myapp] [ main] o.s.b.d.f.logexample.MyApplication : No active profile set, falling back to 1 default profile: "default" 2026-08-17T10:51:33.118Z INFO 11390 --- [myapp] [ main] o.s.boot.tomcat.TomcatWebServer : Tomcat initialized with port 8080 (http) 2026-08-17T10:51:33.232Z INFO 11390 --- [myapp] [ main] o.apache.catalina.core.StandardService : Starting service [Tomcat] 2026-08-17T10:51:33.239Z INFO 11390 --- [myapp] [ main] o.apache.catalina.core.StandardEngine : Starting Servlet engine: [Apache Tomcat/11.0.24] 2026-08-17T10:51:33.461Z INFO 11390 --- [myapp] [ main] b.w.c.s.WebApplicationContextInitializer : Root WebApplicationContext: initialization completed in 4632 ms 2026-08-17T10:51:35.255Z INFO 11390 --- [myapp] [ main] o.s.boot.tomcat.TomcatWebServer : Tomcat started on port 8080 (http) with context path '/' 2026-08-17T10:51:35.286Z INFO 11390 --- [myapp] [ main] o.s.b.d.f.logexample.MyApplication : Started MyApplication in 8.572 seconds (process running for 10.155) 2026-08-17T10:51:35.315Z INFO 11390 --- [myapp] [ionShutdownHook] o.s.boot.tomcat.GracefulShutdown : Commencing graceful shutdown. Waiting for active requests to complete 2026-08-17T10:51:35.346Z INFO 11390 --- [myapp] [tomcat-shutdown] o.s.boot.tomcat.GracefulShutdown : Graceful shutdown complete ``` The following items are output: * Date and Time: Millisecond precision and easily sortable. * Log Level: `ERROR`, `WARN`, `INFO`, `DEBUG`, or `TRACE`. * Process ID. * A `---` separator to distinguish the start of actual log messages. * Application name: Enclosed in square brackets (logged by default only if `spring.application.name` is set) * Application group: Enclosed in square brackets (logged by default only if `spring.application.group` is set) * Thread name: Enclosed in square brackets (may be truncated for console output). * Correlation ID: If tracing is enabled (not shown in the sample above) * Logger name: This is usually the source class name (often abbreviated). * The log message. | | | | -- | --------------------------------------------------------------- | | ** | Logback does not have a `FATAL` level. It is mapped to `ERROR`. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------ | | ** | If you have a `spring.application.name` property but don’t want it logged you can set `logging.include-application-name` to `false`. | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you have a `spring.application.group` property but don’t want it logged you can set `logging.include-application-group` to `false`. | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------- | | ** | For more details about correlation IDs, please [see this documentation](../actuator/tracing.html#actuator.micrometer-tracing.logging). | ## [](#features.logging.console-output)Console Output The default log configuration echoes messages to the console as they are written. By default, `ERROR`-level, `WARN`-level, and `INFO`-level messages are logged. You can also enable a “debug” mode by starting your application with a `--debug` flag. ```shell $ java -jar myapp.jar --debug ``` | | | | -- | ------------------------------------------------------------------- | | ** | You can also specify `debug=true` in your `application.properties`. | When the debug mode is enabled, a selection of core loggers (embedded container, Hibernate, and Spring Boot) are configured to output more information. Enabling the debug mode does *not* configure your application to log all messages with `DEBUG` level. Alternatively, you can enable a “trace” mode by starting your application with a `--trace` flag (or `trace=true` in your `application.properties`). Doing so enables trace logging for a selection of core loggers (embedded container, Hibernate schema generation, and the whole Spring portfolio). If you want to disable console-based logging, you can set the `logging.console.enabled` property to `false`. ### [](#features.logging.console-output.color-coded)Color-coded Output If your terminal supports ANSI, color output is used to aid readability. You can set `spring.output.ansi.enabled` to a [supported value](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ansi/AnsiOutput.Enabled.html) to override the auto-detection. Color coding is configured by using the `%clr` conversion word. In its simplest form, the converter colors the output according to the log level, as shown in the following example: ```none %clr(%5p) ``` The following table describes the mapping of log levels to colors: | Level | Color | | ------- | ------ | | `FATAL` | Red | | `ERROR` | Red | | `WARN` | Yellow | | `INFO` | Green | | `DEBUG` | Green | | `TRACE` | Green | Alternatively, you can specify the color and styles that should be used by providing them as options to the conversion. For example, to make the text yellow and bold, use the following setting: ```none %clr(%d{yyyy-MM-dd'T'HH:mm:ss.SSSXXX}){yellow,bold} ``` The following text colors are supported: * `black` * `blue` * `bright_black` * `bright_blue` * `bright_cyan` * `bright_green` * `bright_magenta` * `bright_red` * `bright_white` * `bright_yellow` * `cyan` * `green` * `magenta` * `red` * `white` * `yellow` The following background colors are supported: * `bg_black` * `bg_blue` * `bg_bright_black` * `bg_bright_blue` * `bg_bright_cyan` * `bg_bright_green` * `bg_bright_magenta` * `bg_bright_red` * `bg_bright_white` * `bg_bright_yellow` * `bg_cyan` * `bg_green` * `bg_magenta` * `bg_red` * `bg_white` * `bg_yellow` The following styles are supported: * `bold` * `faint` * `italic` * `normal` * `reverse` * `underline` ## [](#features.logging.file-output)File Output By default, Spring Boot logs only to the console and does not write log files. If you want to write log files in addition to the console output, you need to set a `logging.file.name` or `logging.file.path` property (for example, in your `application.properties`). If both properties are set, `logging.file.path` is ignored and only `logging.file.name` is used. The following table shows how the `logging.*` properties can be used together: | `logging.file.name` | `logging.file.path` | Description | | ------------------------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | | *(none)* | *(none)* | Console only logging. | | Specific file (for example, `my.log`) | *(none)* | Writes to the location specified by `logging.file.name`. The location can be absolute or relative to the current directory. | | *(none)* | Specific directory (for example, `/var/log`) | Writes `spring.log` to the directory specified by `logging.file.path`. The directory can be absolute or relative to the current directory. | | Specific file | Specific directory | Writes to the location specified by `logging.file.name` and ignores `logging.file.path`. The location can be absolute or relative to the current directory. | Log files rotate when they reach 10 MB and, as with console output, `ERROR`-level, `WARN`-level, and `INFO`-level messages are logged by default. Note that Log4J2 requires `logging.file.path` to be set with such configuration. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Logging properties are independent of the actual logging infrastructure. As a result, specific configuration keys (such as `logback.configurationFile` for Logback) are not managed by spring Boot. | ## [](#features.logging.file-rotation)File Rotation If you are using Logback or Log4j2, it is possible to fine-tune log rotation settings using your `application.properties` or `application.yaml` file. For all other logging system, you will need to configure rotation settings directly yourself. The following rotation policy properties are supported for Logback: | Name | Description | | ------------------------------------------------------ | ---------------------------------------------------------------------- | | `logging.logback.rollingpolicy.file-name-pattern` | The filename pattern used to create log archives. | | `logging.logback.rollingpolicy.clean-history-on-start` | If log archive cleanup should occur when the application starts. | | `logging.logback.rollingpolicy.max-file-size` | The maximum size of log file before it is archived. | | `logging.logback.rollingpolicy.total-size-cap` | The maximum amount of size log archives can take before being deleted. | | `logging.logback.rollingpolicy.max-history` | The maximum number of archive log files to keep (defaults to 7). | If you are using Log4j2, the following rotation policy properties are available: | Name | Description | | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- | | `logging.log4j2.rollingpolicy.file-name-pattern` | The filename pattern used to create log archives. | | `logging.log4j2.rollingpolicy.max-file-size` | The maximum size of log file before it is archived (defaults to 10MB). | | `logging.log4j2.rollingpolicy.max-history` | The maximum number of archive log files to keep (defaults to 7). | | `logging.log4j2.rollingpolicy.strategy` | Rolling policy strategy (defaults to 'size'). | | `logging.log4j2.rollingpolicy.cron` | Cron expression used when the strategy is 'cron' (default to every day at midnight). | | `logging.log4j2.rollingpolicy.time-interval` | Time based triggering interval when the strategy is 'time' or 'size-and-time' (default to 1). | | `logging.log4j2.rollingpolicy.time-modulate` | Whether to align the next rollover time to occur at the top of the interval when the strategy is time based (defaults to `false`). | ## [](#features.logging.log-levels)Log Levels All the supported logging systems can have the logger levels set in the Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) (for example, in `application.properties`) by using `logging.level.=` where `level` is one of TRACE, DEBUG, INFO, WARN, ERROR, FATAL, or OFF. The `root` logger can be configured by using `logging.level.root`. The following example shows potential logging settings in `application.properties`: * Properties * YAML ```properties logging.level.root=warn logging.level.org.springframework.web=debug logging.level.org.hibernate=error ``` ```yaml logging: level: root: "warn" org.springframework.web: "debug" org.hibernate: "error" ``` It is also possible to set logging levels using environment variables. For example, `LOGGING_LEVEL_ORG_SPRINGFRAMEWORK_WEB=DEBUG` will set `org.springframework.web` to `DEBUG`. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The above approach will only work for package level logging. Since relaxed binding [always converts environment variables to lowercase](external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.maps-from-environment-variables), it is not possible to configure logging for an individual class in this way. If you need to configure logging for a class, you can use [the `SPRING_APPLICATION_JSON`](external-config.html#features.external-config.application-json) variable. | ## [](#features.logging.log-groups)Log Groups It is often useful to be able to group related loggers together so that they can all be configured at the same time. For example, you might commonly change the logging levels for *all* Tomcat related loggers, but you can not easily remember top level packages. To help with this, Spring Boot allows you to define logging groups in your Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html). For example, here is how you could define a “tomcat” group by adding it to your `application.properties`: * Properties * YAML ```properties logging.group.tomcat=org.apache.catalina,org.apache.coyote,org.apache.tomcat ``` ```yaml logging: group: tomcat: "org.apache.catalina,org.apache.coyote,org.apache.tomcat" ``` Once defined, you can change the level for all the loggers in the group with a single line: * Properties * YAML ```properties logging.level.tomcat=trace ``` ```yaml logging: level: tomcat: "trace" ``` Spring Boot includes the following pre-defined logging groups that can be used out-of-the-box: | Name | Loggers | | ---- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | web | `org.springframework.core.codec`, `org.springframework.http`, `org.springframework.web`, `org.springframework.boot.actuate.endpoint.web`, `org.springframework.boot.web.servlet.ServletContextInitializerBeans` | | sql | `org.springframework.jdbc.core`, `org.hibernate.SQL`, [`LoggerListener`](https://www.jooq.org/javadoc/3.21.7/org/jooq/tools/LoggerListener.html) | ## [](#features.logging.shutdown-hook)Using a Log Shutdown Hook In order to release logging resources when your application terminates, a shutdown hook that will trigger log system cleanup when the JVM exits is provided. This shutdown hook is registered automatically unless your application is deployed as a war file. If your application has complex context hierarchies the shutdown hook may not meet your needs. If it does not, disable the shutdown hook and investigate the options provided directly by the underlying logging system. For example, Logback offers [context selectors](https://logback.qos.ch/manual/loggingSeparation.html) which allow each Logger to be created in its own context. You can use the `logging.register-shutdown-hook` property to disable the shutdown hook. Setting it to `false` will disable the registration. You can set the property in your `application.properties` or `application.yaml` file: * Properties * YAML ```properties logging.register-shutdown-hook=false ``` ```yaml logging: register-shutdown-hook: false ``` ## [](#features.logging.custom-log-configuration)Custom Log Configuration The various logging systems can be activated by including the appropriate libraries on the classpath and can be further customized by providing a suitable configuration file in the root of the classpath or in a location specified by the following Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) property: `logging.config`. You can force Spring Boot to use a particular logging system by using the `org.springframework.boot.logging.LoggingSystem` system property. The value should be the fully qualified class name of a [`LoggingSystem`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/logging/LoggingSystem.html) implementation. You can also disable Spring Boot’s logging configuration entirely by using a value of `none`. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Since logging is initialized **before** the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) is created, it is not possible to control logging from [`@PropertySources`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/PropertySources.html) in Spring [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) files. The only way to change the logging system or disable it entirely is through System properties. | Depending on your logging system, the following files are loaded: | Logging System | Customization | | ----------------------- | --------------------------------------------------------------------------------- | | Logback | `logback-spring.xml`, `logback-spring.groovy`, `logback.xml`, or `logback.groovy` | | Log4j2 | `log4j2-spring.xml` or `log4j2.xml` | | JDK (Java Util Logging) | `logging.properties` | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | When possible, we recommend that you use the `-spring` variants for your logging configuration (for example, `logback-spring.xml` rather than `logback.xml`). If you use standard configuration locations, Spring cannot completely control log initialization. | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | There are known classloading issues with Java Util Logging that cause problems when running from an 'executable jar'. We recommend that you avoid it when running from an 'executable jar' if at all possible. | To help with the customization, some other properties are transferred from the Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) to System properties. This allows the properties to be consumed by logging system configuration. For example, setting `logging.file.name` in `application.properties` or `LOGGING_FILE_NAME` as an environment variable will result in the `LOG_FILE` System property being set. The properties that are transferred are described in the following table: | Spring Environment | System Property | Comments | | ----------------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------- | | `logging.exception-conversion-word` | `LOG_EXCEPTION_CONVERSION_WORD` | The conversion word used when logging exceptions. | | `logging.file.name` | `LOG_FILE` | If defined, it is used in the default log configuration. | | `logging.file.path` | `LOG_PATH` | If defined, it is used in the default log configuration. | | `logging.pattern.console` | `CONSOLE_LOG_PATTERN` | The log pattern to use on the console (stdout). | | `logging.pattern.dateformat` | `LOG_DATEFORMAT_PATTERN` | Appender pattern for log date format. | | `logging.charset.console` | `CONSOLE_LOG_CHARSET` | The charset to use for console logging. | | `logging.threshold.console` | `CONSOLE_LOG_THRESHOLD` | The log level threshold to use for console logging. | | `logging.pattern.file` | `FILE_LOG_PATTERN` | The log pattern to use in a file (if `LOG_FILE` is enabled). | | `logging.charset.file` | `FILE_LOG_CHARSET` | The charset to use for file logging (if `LOG_FILE` is enabled). | | `logging.threshold.file` | `FILE_LOG_THRESHOLD` | The log level threshold to use for file logging. | | `logging.pattern.level` | `LOG_LEVEL_PATTERN` | The format to use when rendering the log level (default `%5p`). | | `logging.structured.format.console` | `CONSOLE_LOG_STRUCTURED_FORMAT` | The structured logging format to use for console logging. | | `logging.structured.format.file` | `FILE_LOG_STRUCTURED_FORMAT` | The structured logging format to use for file logging. | | `PID` | `PID` | The current process ID (discovered if possible and when not already defined as an OS environment variable). | If you use Logback, the following properties are also transferred: | Spring Environment | System Property | Comments | | ------------------------------------------------------ | ---------------------------------------------- | ------------------------------------------------------------------------------------ | | `logging.logback.rollingpolicy.file-name-pattern` | `LOGBACK_ROLLINGPOLICY_FILE_NAME_PATTERN` | Pattern for rolled-over log file names (default `${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz`). | | `logging.logback.rollingpolicy.clean-history-on-start` | `LOGBACK_ROLLINGPOLICY_CLEAN_HISTORY_ON_START` | Whether to clean the archive log files on startup. | | `logging.logback.rollingpolicy.max-file-size` | `LOGBACK_ROLLINGPOLICY_MAX_FILE_SIZE` | Maximum log file size. | | `logging.logback.rollingpolicy.total-size-cap` | `LOGBACK_ROLLINGPOLICY_TOTAL_SIZE_CAP` | Total size of log backups to be kept. | | `logging.logback.rollingpolicy.max-history` | `LOGBACK_ROLLINGPOLICY_MAX_HISTORY` | Maximum number of archive log files to keep. | All the supported logging systems can consult System properties when parsing their configuration files. See the default configurations in `spring-boot.jar` for examples: * [Logback](https://github.com/spring-projects/spring-boot/tree/v4.1.1/core/spring-boot/src/main/resources/org/springframework/boot/logging/logback/defaults.xml) * [Log4j 2](https://github.com/spring-projects/spring-boot/tree/v4.1.1/core/spring-boot/src/main/resources/org/springframework/boot/logging/log4j2/log4j2.xml) * [Java Util logging](https://github.com/spring-projects/spring-boot/tree/v4.1.1/core/spring-boot/src/main/resources/org/springframework/boot/logging/java/logging-file.properties) | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you want to use a placeholder in a logging property, you should use [Spring Boot’s syntax](external-config.html#features.external-config.files.property-placeholders) and not the syntax of the underlying framework. Notably, if you use Logback, you should use `:` as the delimiter between a property name and its default value and not use `:-`. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can add MDC and other ad-hoc content to log lines by overriding only the `LOG_LEVEL_PATTERN` (or `logging.pattern.level` with Logback). For example, if you use `logging.pattern.level=user:%X{user} %5p`, then the default log format contains an MDC entry for "user", if it exists, as shown in the following example.```none 2019-08-30 12:30:04.031 user:someone INFO 22174 --- [ nio-8080-exec-0] demo.Controller Handling authenticated request ``` | ## [](#features.logging.structured)Structured Logging Structured logging is a technique where the log output is written in a well-defined, often machine-readable format. Spring Boot supports structured logging and has support for the following JSON formats out of the box: * [Elastic Common Schema (ECS)](#features.logging.structured.ecs) * [Graylog Extended Log Format (GELF)](#features.logging.structured.gelf) * [Logstash](#features.logging.structured.logstash) To enable structured logging, set the property `logging.structured.format.console` (for console output) or `logging.structured.format.file` (for file output) to the id of the format you want to use. If you are using [Custom Log Configuration](#features.logging.custom-log-configuration), update your configuration to respect `CONSOLE_LOG_STRUCTURED_FORMAT` and `FILE_LOG_STRUCTURED_FORMAT` system properties. Take `CONSOLE_LOG_STRUCTURED_FORMAT` for example: * Logback * Log4j2 ```xml ${CONSOLE_LOG_STRUCTURED_FORMAT} ${CONSOLE_LOG_CHARSET} ``` You can also refer to the default configurations included in Spring Boot: * [Logback Structured Console Appender](https://github.com/spring-projects/spring-boot/tree/v4.1.1/core/spring-boot/src/main/resources/org/springframework/boot/logging/logback/structured-console-appender.xml) * [Logback Structured File Appender](https://github.com/spring-projects/spring-boot/tree/v4.1.1/core/spring-boot/src/main/resources/org/springframework/boot/logging/logback/structured-file-appender.xml) ```xml ``` You can also refer to the default configurations included in Spring Boot: * [Log4j2 Console Appender](https://github.com/spring-projects/spring-boot/tree/v4.1.1/core/spring-boot/src/main/resources/org/springframework/boot/logging/log4j2/log4j2.xml) * [Log4j2 Console and File Appender](https://github.com/spring-projects/spring-boot/tree/v4.1.1/core/spring-boot/src/main/resources/org/springframework/boot/logging/log4j2/log4j2-file.xml) ### [](#features.logging.structured.ecs)Elastic Common Schema [Elastic Common Schema](https://www.elastic.co/guide/en/ecs/8.11/ecs-reference.html) is a JSON based logging format. To enable the Elastic Common Schema log format, set the appropriate `format` property to `ecs`: * Properties * YAML ```properties logging.structured.format.console=ecs logging.structured.format.file=ecs ``` ```yaml logging: structured: format: console: ecs file: ecs ``` A log line looks like this: ```json {"@timestamp":"2024-01-01T10:15:00.067462556Z","log":{"level":"INFO","logger":"org.example.Application"},"process":{"pid":39599,"thread":{"name":"main"}},"service":{"name":"simple"},"message":"No active profile set, falling back to 1 default profile: \"default\"","ecs":{"version":"8.11"}} ``` This format also adds every key value pair contained in the MDC to the JSON object. You can also use the [SLF4J fluent logging API](https://www.slf4j.org/manual.html#fluent) to add key value pairs to the logged JSON object with the [addKeyValue](https://www.slf4j.org/apidocs/org/slf4j/spi/LoggingEventBuilder.html#addKeyValue\(java.lang.String,java.lang.Object\)) method. The `service` values can be customized using `logging.structured.ecs.service` properties: * Properties * YAML ```properties logging.structured.ecs.service.name=MyService logging.structured.ecs.service.version=1 logging.structured.ecs.service.environment=Production logging.structured.ecs.service.node-name=Primary ``` ```yaml logging: structured: ecs: service: name: MyService version: 1.0 environment: Production node-name: Primary ``` | | | | -- | ------------------------------------------------------------------------------------------------- | | ** | `logging.structured.ecs.service.name` will default to `spring.application.name` if not specified. | | | | | -- | ------------------------------------------------------------------------------------------------------- | | ** | `logging.structured.ecs.service.version` will default to `spring.application.version` if not specified. | ### [](#features.logging.structured.gelf)Graylog Extended Log Format (GELF) [Graylog Extended Log Format](https://go2docs.graylog.org/current/getting_in_log_data/gelf.html) is a JSON based logging format for the Graylog log analytics platform. To enable the Graylog Extended Log Format, set the appropriate `format` property to `gelf`: * Properties * YAML ```properties logging.structured.format.console=gelf logging.structured.format.file=gelf ``` ```yaml logging: structured: format: console: gelf file: gelf ``` A log line looks like this: ```json {"version":"1.1","short_message":"No active profile set, falling back to 1 default profile: \"default\"","timestamp":1725958035.857,"level":6,"_level_name":"INFO","_process_pid":47649,"_process_thread_name":"main","_log_logger":"org.example.Application"} ``` This format also adds every key value pair contained in the MDC to the JSON object. You can also use the [SLF4J fluent logging API](https://www.slf4j.org/manual.html#fluent) to add key value pairs to the logged JSON object with the [addKeyValue](https://www.slf4j.org/apidocs/org/slf4j/spi/LoggingEventBuilder.html#addKeyValue\(java.lang.String,java.lang.Object\)) method. Several fields can be customized using `logging.structured.gelf` properties: * Properties * YAML ```properties logging.structured.gelf.host=MyService logging.structured.gelf.service.version=1 ``` ```yaml logging: structured: gelf: host: MyService service: version: 1.0 ``` | | | | -- | ------------------------------------------------------------------------------------------ | | ** | `logging.structured.gelf.host` will default to `spring.application.name` if not specified. | | | | | -- | -------------------------------------------------------------------------------------------------------- | | ** | `logging.structured.gelf.service.version` will default to `spring.application.version` if not specified. | ### [](#features.logging.structured.logstash)Logstash JSON format The [Logstash JSON format](https://github.com/logfellow/logstash-logback-encoder?tab=readme-ov-file#standard-fields) is a JSON based logging format. To enable the Logstash JSON log format, set the appropriate `format` property to `logstash`: * Properties * YAML ```properties logging.structured.format.console=logstash logging.structured.format.file=logstash ``` ```yaml logging: structured: format: console: logstash file: logstash ``` A log line looks like this: ```json {"@timestamp":"2024-01-01T10:15:00.111037681+02:00","@version":"1","message":"No active profile set, falling back to 1 default profile: \"default\"","logger_name":"org.example.Application","thread_name":"main","level":"INFO","level_value":20000} ``` This format also adds every key value pair contained in the MDC to the JSON object. You can also use the [SLF4J fluent logging API](https://www.slf4j.org/manual.html#fluent) to add key value pairs to the logged JSON object with the [addKeyValue](https://www.slf4j.org/apidocs/org/slf4j/spi/LoggingEventBuilder.html#addKeyValue\(java.lang.String,java.lang.Object\)) method. If you add [markers](https://www.slf4j.org/api/org/slf4j/Marker.html), these will show up in a `tags` string array in the JSON. ### [](#features.logging.structured.customizing-json)Customizing Structured Logging JSON Spring Boot attempts to pick sensible defaults for the JSON names and values output for structured logging. Sometimes, however, you may want to make small adjustments to the JSON for your own needs. For example, it’s possible that you might want to change some of the names to match the expectations of your log ingestion system. You might also want to filter out certain members since you don’t find them useful. The following properties allow you to change the way that structured logging JSON is written: | Property | Description | | --------------------------------------------------------------------- | ------------------------------------- | | `logging.structured.json.include` & `logging.structured.json.exclude` | Filters specific paths from the JSON | | `logging.structured.json.rename` | Renames a specific member in the JSON | | `logging.structured.json.add` | Adds additional members to the JSON | For example, the following will exclude `log.level`, rename `process.id` to `procid` and add a fixed `corpname` field: * Properties * YAML ```properties logging.structured.json.exclude=log.level logging.structured.json.rename.process.id=procid logging.structured.json.add.corpname=mycorp ``` ```yaml logging: structured: json: exclude: log.level rename: process.id: procid add: corpname: mycorp ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | For more advanced customizations, you can use the [`StructuredLoggingJsonMembersCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/logging/structured/StructuredLoggingJsonMembersCustomizer.html) interface. You can reference one or more implementations using the `logging.structured.json.customizer` property. You can also declare implementations by listing them in a `META-INF/spring.factories` file. | ### [](#features.logging.structured.customizing-stack-traces)Customizing Structured Logging Stack Traces Complete stack traces are included in the JSON output whenever a message is logged with an exception. This amount of information may be costly to process by your log ingestion system, so you may want to tune the way that stack traces are printed. To do this, you can use one or more of the following properties: | Property | Description | | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | `logging.structured.json.stacktrace.root` | Use `last` to print the root item last (same as Java) or `first` to print the root item first. | | `logging.structured.json.stacktrace.max-length` | The maximum length that should be printed | | `logging.structured.json.stacktrace.max-throwable-depth` | The maximum number of frames to print per stack trace (including common and suppressed frames) | | `logging.structured.json.stacktrace.include-common-frames` | If common frames should be included or removed | | `logging.structured.json.stacktrace.include-hashes` | If a hash of the stack trace should be included | For example, the following will use root first stack traces, limit their length, and include hashes. * Properties * YAML ```properties logging.structured.json.stacktrace.root=first logging.structured.json.stacktrace.max-length=1024 logging.structured.json.stacktrace.include-common-frames=true logging.structured.json.stacktrace.include-hashes=true ``` ```yaml logging: structured: json: stacktrace: root: first max-length: 1024 include-common-frames: true include-hashes: true ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you need complete control over stack trace printing you can set `logging.structured.json.stacktrace.printer` to the name of a [`StackTracePrinter`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/logging/StackTracePrinter.html) implementation. You can also set it to `logging-system` to force regular logging system stack trace output to be used.Your `StackTracePrinter` implementation can also include a constructor argument that accepts a [`StandardStackTracePrinter`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/logging/StandardStackTracePrinter.html) if it wishes to apply further customization to the stack trace printer created from the properties. | ### [](#features.logging.structured.other-formats)Supporting Other Structured Logging Formats The structured logging support in Spring Boot is extensible, allowing you to define your own custom format. To do this, implement the [`StructuredLogFormatter`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/logging/structured/StructuredLogFormatter.html) interface. The generic type argument has to be [`ILoggingEvent`](https://logback.qos.ch/apidocs/ch.qos.logback.core/ch/qos/logback/classic/spi/ILoggingEvent.html) when using Logback and [`LogEvent`](https://logging.apache.org/log4j/2.x/javadoc/log4j-core/org/apache/logging/log4j/core/LogEvent.html) when using Log4j2 (that means your implementation is tied to a specific logging system). Your implementation is then called with the log event and returns the [`String`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html) to be logged, as seen in this example: * Java * Kotlin ```java import ch.qos.logback.classic.spi.ILoggingEvent; import org.springframework.boot.logging.structured.StructuredLogFormatter; class MyCustomFormat implements StructuredLogFormatter { @Override public String format(ILoggingEvent event) { return "time=" + event.getInstant() + " level=" + event.getLevel() + " message=" + event.getMessage() + "\n"; } } ``` ```kotlin import ch.qos.logback.classic.spi.ILoggingEvent import org.springframework.boot.logging.structured.StructuredLogFormatter class MyCustomFormat : StructuredLogFormatter { override fun format(event: ILoggingEvent): String { return "time=${event.instant} level=${event.level} message=${event.message}\n" } } ``` As you can see in the example, you can return any format, it doesn’t have to be JSON. To enable your custom format, set the property `logging.structured.format.console` or `logging.structured.format.file` to the fully qualified class name of your implementation. Your implementation can use some constructor parameters, which are injected automatically. Please see the JavaDoc of [`StructuredLogFormatter`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/logging/structured/StructuredLogFormatter.html) for more details. ## [](#features.logging.logback-extensions)Logback Extensions Spring Boot includes a number of extensions to Logback that can help with advanced configuration. You can use these extensions in your `logback-spring.xml` configuration file. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Because the standard `logback.xml` configuration file is loaded too early, you cannot use extensions in it. You need to either use `logback-spring.xml` or define a `logging.config` property. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The extensions cannot be used with Logback’s [configuration scanning](https://logback.qos.ch/manual/configuration.html#autoScan). If you attempt to do so, making changes to the configuration file results in an error similar to one of the following being logged: | ```none ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action for [springProperty], current ElementPath is [[configuration][springProperty]] ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action for [springProfile], current ElementPath is [[configuration][springProfile]] ``` ### [](#features.logging.logback-extensions.profile-specific)Profile-specific Configuration The `` tag lets you optionally include or exclude sections of configuration based on the active Spring profiles. Profile sections are supported anywhere within the `` element. Use the `name` attribute to specify which profile accepts the configuration. The `` tag can contain a profile name (for example `staging`) or a profile expression. A profile expression allows for more complicated profile logic to be expressed, for example `production & (eu-central | eu-west)`. Check the [Spring Framework reference guide](https://docs.spring.io/spring-framework/reference/7.0/core/beans/environment.html#beans-definition-profiles-java) for more details. The following listing shows three sample profiles: ```xml ``` ### [](#features.logging.logback-extensions.environment-properties)Environment Properties The `` tag lets you expose properties from the Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) for use within Logback. Doing so can be useful if you want to access values from your `application.properties` file in your Logback configuration. The tag works in a similar way to Logback’s standard `` tag. However, rather than specifying a direct `value`, you specify the `source` of the property (from the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html)). If you need to store the property somewhere other than in `local` scope, you can use the `scope` attribute. If you need a fallback value (in case the property is not set in the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html)), you can use the `defaultValue` attribute. The following example shows how to expose properties for use within Logback: ```xml ${fluentHost} ... ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The `source` must be specified in kebab case (such as `my.property-name`). However, properties can be added to the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) by using the relaxed rules. | ## [](#features.logging.log4j2-extensions)Log4j2 Extensions Spring Boot includes a number of extensions to Log4j2 that can help with advanced configuration. You can use these extensions in any `log4j2-spring.xml` configuration file. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Because the standard `log4j2.xml` configuration file is loaded too early, you cannot use extensions in it. You need to either use `log4j2-spring.xml` or define a `logging.config` property. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The extensions supersede the [Spring Boot support](https://logging.apache.org/log4j/2.x/log4j-spring-boot.html) provided by Log4J. You should make sure not to include the `org.apache.logging.log4j:log4j-spring-boot` module in your build. | ### [](#features.logging.log4j2-extensions.profile-specific)Profile-specific Configuration The `` tag lets you optionally include or exclude sections of configuration based on the active Spring profiles. Profile sections are supported anywhere within the `` element. Use the `name` attribute to specify which profile accepts the configuration. The `` tag can contain a profile name (for example `staging`) or a profile expression. A profile expression allows for more complicated profile logic to be expressed, for example `production & (eu-central | eu-west)`. Check the [Spring Framework reference guide](https://docs.spring.io/spring-framework/reference/7.0/core/beans/environment.html#beans-definition-profiles-java) for more details. The following listing shows three sample profiles: ```xml ``` ### [](#features.logging.log4j2-extensions.environment-properties-lookup)Environment Properties Lookup If you want to refer to properties from your Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) within your Log4j2 configuration you can use `spring:` prefixed [lookups](https://logging.apache.org/log4j/2.x/manual/lookups.html). Doing so can be useful if you want to access values from your `application.properties` file in your Log4j2 configuration. The following example shows how to set Log4j2 properties named `applicationName` and `applicationGroup` that read `spring.application.name` and `spring.application.group` from the Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html): ```xml ${spring:spring.application.name} ${spring:spring.application.group} ``` | | | | -- | ------------------------------------------------------------------------------ | | ** | The lookup key should be specified in kebab case (such as `my.property-name`). | ### [](#features.logging.log4j2-extensions.environment-property-source)Log4j2 System Properties Log4j2 supports a number of [System Properties](https://logging.apache.org/log4j/2.x/manual/systemproperties.html) that can be used to configure various items. For example, the `log4j2.skipJansi` system property can be used to configure if the [`ConsoleAppender`](https://logging.apache.org/log4j/2.x/javadoc/log4j-core/org/apache/logging/log4j/core/appender/ConsoleAppender.html) will try to use a [Jansi](https://github.com/fusesource/jansi) output stream on Windows. All system properties that are loaded after the Log4j2 initialization can be obtained from the Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html). For example, you could add `log4j2.skipJansi=false` to your `application.properties` file to have the [`ConsoleAppender`](https://logging.apache.org/log4j/2.x/javadoc/log4j-core/org/apache/logging/log4j/core/appender/ConsoleAppender.html) use Jansi on Windows. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | The Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) is only considered when system properties and OS environment variables do not contain the value being loaded. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | System properties that are loaded during early Log4j2 initialization cannot reference the Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html). For example, the property Log4j2 uses to allow the default Log4j2 implementation to be chosen is used before the Spring Environment is available. | * [Spring Boot](../../index.html) * [4.1.1](logging.html) * [4.0.8](../../4.0/reference/features/logging.html) * [3.5.16](../../3.5/reference/features/logging.html) * [3.4.13](../../3.4/reference/features/logging.html) * [3.3.13](../../3.3/reference/features/logging.html) - [4.2.0-M2](../../4.2/reference/features/logging.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/features/logging.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/features/logging.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/features/logging.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) * [Spring AI](https://docs.spring.io/spring-ai/reference/) * [Spring AMQP](https://docs.spring.io/spring-amqp/reference/) * [Spring CLI](https://docs.spring.io/spring-cli/reference/) * [Spring GraphQL](https://docs.spring.io/spring-graphql/reference/) * [Spring for Apache Kafka](https://docs.spring.io/spring-kafka/reference/) * [Spring Modulith](https://docs.spring.io/spring-modulith/reference/) * [Spring for Apache Pulsar](https://docs.spring.io/spring-pulsar/reference/) * [Spring Shell](https://docs.spring.io/spring-shell/reference/) [All Docs...](../../spring-projects.html) [Search in all Spring Docs](../../search.html) [](https://www.algolia.com/) ---- url: https://docs.spring.io/spring-boot/reference/packaging/native-image/advanced-topics.html ---- # Advanced Native Images Topics ## [](#packaging.native-image.advanced.nested-configuration-properties)Nested Configuration Properties Reflection hints are automatically created for configuration properties by the Spring ahead-of-time engine. Nested configuration properties which are not inner classes, however, **must** be annotated with [`@NestedConfigurationProperty`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/NestedConfigurationProperty.html), otherwise they won’t be detected and will not be bindable. ```java import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.context.properties.NestedConfigurationProperty; @ConfigurationProperties("my.properties") public class MyProperties { private String name; @NestedConfigurationProperty private final Nested nested = new Nested(); // getters / setters... public String getName() { return this.name; } public void setName(String name) { this.name = name; } public Nested getNested() { return this.nested; } } ``` where `Nested` is: * Java * Kotlin ```java public class Nested { private int number; // getters / setters... public int getNumber() { return this.number; } public void setNumber(int number) { this.number = number; } } ``` ```kotlin class Nested { } ``` The example above produces configuration properties for `my.properties.name` and `my.properties.nested.number`. Without the [`@NestedConfigurationProperty`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/NestedConfigurationProperty.html) annotation on the `nested` field, the `my.properties.nested.number` property would not be bindable in a native image. You can also annotate the getter method. When using constructor binding, you have to annotate the field with [`@NestedConfigurationProperty`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/NestedConfigurationProperty.html): ```java import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.context.properties.NestedConfigurationProperty; @ConfigurationProperties("my.properties") public class MyPropertiesCtor { private final String name; @NestedConfigurationProperty private final Nested nested; public MyPropertiesCtor(String name, Nested nested) { this.name = name; this.nested = nested; } // getters / setters... public String getName() { return this.name; } public Nested getNested() { return this.nested; } } ``` When using records, you have to annotate the parameter with [`@NestedConfigurationProperty`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/NestedConfigurationProperty.html): ```java import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.context.properties.NestedConfigurationProperty; @ConfigurationProperties("my.properties") public record MyPropertiesRecord(String name, @NestedConfigurationProperty Nested nested) { } ``` When using Kotlin, you need to annotate the parameter of a data class with [`@NestedConfigurationProperty`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/NestedConfigurationProperty.html): ```kotlin import org.springframework.boot.context.properties.ConfigurationProperties import org.springframework.boot.context.properties.NestedConfigurationProperty @ConfigurationProperties("my.properties") data class MyPropertiesKotlin( val name: String, @NestedConfigurationProperty val nested: Nested ) ``` | | | | -- | -------------------------------------------------------------------------------------------------- | | ** | Please use public getters and setters in all cases, otherwise the properties will not be bindable. | ## [](#packaging.native-image.advanced.converting-executable-jars)Converting a Spring Boot Executable Jar It is possible to convert a Spring Boot [executable jar](../../../specification/executable-jar/index.html) into a native image as long as the jar contains the AOT generated assets. This can be useful for a number of reasons, including: * You can keep your regular JVM pipeline and turn the JVM application into a native image on your CI/CD platform. * As `native-image` [does not support cross-compilation](https://github.com/oracle/graal/issues/407), you can keep an OS neutral deployment artifact which you convert later to different OS architectures. You can convert a Spring Boot executable jar into a native image using Cloud Native Buildpacks, or using the `native-image` tool that is shipped with GraalVM. | | | | -- | ---------------------------------------------------------------------------------------------------- | | ** | Your executable jar must include AOT generated assets such as generated classes and JSON hint files. | ### [](#packaging.native-image.advanced.converting-executable-jars.buildpacks)Using Buildpacks Spring Boot applications usually use Cloud Native Buildpacks through the Maven (`mvn spring-boot:build-image`) or Gradle (`gradle bootBuildImage`) integrations. You can, however, also use [`pack`](https://buildpacks.io/docs/for-platform-operators/how-to/integrate-ci/pack/) to turn an AOT processed Spring Boot executable jar into a native container image. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You have to build your application with at least JDK 25, because Buildpacks use the same GraalVM native-image version as the Java version used for compilation. | First, make sure that a Docker daemon is available (see [Get Docker](https://docs.docker.com/installation/#installation) for more details). [Configure it to allow non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) if you are on Linux. You also need to install `pack` by following [the installation guide on buildpacks.io](https://buildpacks.io/docs/for-platform-operators/how-to/integrate-ci/pack/#install). Assuming an AOT processed Spring Boot executable jar built as `myproject-0.0.1-SNAPSHOT.jar` is in the `target` directory, run: ```shell $ pack build --builder paketobuildpacks/builder-noble-java-tiny \ --path target/myproject-0.0.1-SNAPSHOT.jar \ --env 'BP_NATIVE_IMAGE=true' \ my-application:0.0.1-SNAPSHOT ``` | | | | -- | -------------------------------------------------------------------------------------- | | ** | You do not need to have a local GraalVM installation to generate an image in this way. | Once `pack` has finished, you can launch the application using `docker run`: ```shell $ docker run --rm -p 8080:8080 docker.io/library/myproject:0.0.1-SNAPSHOT ``` ### [](#packaging.native-image.advanced.converting-executable-jars.native-image)Using GraalVM native-image Another option to turn an AOT processed Spring Boot executable jar into a native executable is to use the GraalVM `native-image` tool. For this to work, you’ll need a GraalVM distribution on your machine. You can either download it manually on the [Liberica Native Image Kit page](https://bell-sw.com/pages/downloads/native-image-kit/#/nik-22-17) or you can use a download manager like SDKMAN!. Assuming an AOT processed Spring Boot executable jar built as `myproject-0.0.1-SNAPSHOT.jar` is in the `target` directory, run: ```shell $ rm -rf target/native $ mkdir -p target/native $ cd target/native $ jar -xvf ../myproject-0.0.1-SNAPSHOT.jar $ native-image -H:Name=myproject @META-INF/native-image/argfile -cp .:BOOT-INF/classes:`find BOOT-INF/lib | tr '\n' ':'` $ mv myproject ../ ``` | | | | -- | -------------------------------------------------------------------------------------------- | | ** | These commands work on Linux or macOS machines, but you will need to adapt them for Windows. | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The `@META-INF/native-image/argfile` might not be packaged in your jar. It is only included when reachability metadata overrides are needed. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The `native-image` `-cp` flag does not accept wildcards. You need to ensure that all jars are listed (the command above uses `find` and `tr` to do this). | ## [](#packaging.native-image.advanced.using-the-tracing-agent)Using the Tracing Agent The GraalVM native image [tracing agent](https://www.graalvm.org/25/reference-manual/native-image/metadata/AutomaticMetadataCollection) allows you to intercept reflection, resources or proxy usage on the JVM in order to generate the related hints. Spring should generate most of these hints automatically, but the tracing agent can be used to quickly identify the missing entries. When using the agent to generate hints for a native image, there are a couple of approaches: * Launch the application directly and exercise it. * Run application tests to exercise the application. The first option is interesting for identifying the missing hints when a library or a pattern is not recognized by Spring. The second option sounds more appealing for a repeatable setup, but by default the generated hints will include anything required by the test infrastructure. Some of these will be unnecessary when the application runs for real. To address this problem the agent supports an access-filter file that will cause certain data to be excluded from the generated output. ### [](#packaging.native-image.advanced.using-the-tracing-agent.launch)Launch the Application Directly Use the following command to launch the application with the native image tracing agent attached: ```shell $ java -Dspring.aot.enabled=true \ -agentlib:native-image-agent=config-output-dir=/path/to/config-dir/ \ -jar target/myproject-0.0.1-SNAPSHOT.jar ``` Now you can exercise the code paths you want to have hints for and then stop the application with `ctrl-c`. On application shutdown the native image tracing agent will write the hint files to the given config output directory. You can either manually inspect these files, or use them as input to the native image build process. To use them as input, copy them into the `src/main/resources/META-INF/native-image/` directory. The next time you build the native image, GraalVM will take these files into consideration. There are more advanced options which can be set on the native image tracing agent, for example filtering the recorded hints by caller classes, etc. For further reading, please see [the official documentation](https://www.graalvm.org/25/reference-manual/native-image/metadata/AutomaticMetadataCollection). ## [](#packaging.native-image.advanced.custom-hints)Custom Hints If you need to provide your own hints for reflection, resources, serialization, proxy usage and so on, you can use the [`RuntimeHintsRegistrar`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/aot/hint/RuntimeHintsRegistrar.html) API. Create a class that implements the [`RuntimeHintsRegistrar`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/aot/hint/RuntimeHintsRegistrar.html) interface, and then make appropriate calls to the provided [`RuntimeHints`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/aot/hint/RuntimeHints.html) instance: ```java import java.lang.reflect.Method; import org.springframework.aot.hint.ExecutableMode; import org.springframework.aot.hint.RuntimeHints; import org.springframework.aot.hint.RuntimeHintsRegistrar; import org.springframework.util.ReflectionUtils; public class MyRuntimeHints implements RuntimeHintsRegistrar { @Override public void registerHints(RuntimeHints hints, ClassLoader classLoader) { // Register method for reflection Method method = ReflectionUtils.findMethod(MyClass.class, "sayHello", String.class); hints.reflection().registerMethod(method, ExecutableMode.INVOKE); // Register type for java serialization hints.reflection().registerJavaSerialization(MySerializableClass.class); // Register resources hints.resources().registerPattern("my-resource.txt"); // Register proxy hints.proxies().registerJdkProxy(MyInterface.class); } } ``` You can then use [`@ImportRuntimeHints`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/ImportRuntimeHints.html) on any [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class (for example your [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html) annotated application class) to activate those hints. If you have classes which need binding (mostly needed when serializing or deserializing JSON), you can use [`@RegisterReflectionForBinding`](https://docs.spring.io/spring-framework/reference/7.0/core/aot.html#aot.hints.register-reflection-for-binding) on any bean. Most of the hints are automatically inferred, for example when accepting or returning data from a [`@RestController`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/RestController.html) method. But when you work with [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html), [`RestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.html) or [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html) directly, you might need to use [`@RegisterReflectionForBinding`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/aot/hint/annotation/RegisterReflectionForBinding.html). ### [](#packaging.native-image.advanced.custom-hints.testing)Testing Custom Hints The [`RuntimeHintsPredicates`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/aot/hint/predicate/RuntimeHintsPredicates.html) API can be used to test your hints. The API provides methods that build a [`Predicate`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html) that can be used to test a [`RuntimeHints`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/aot/hint/RuntimeHints.html) instance. If you’re using AssertJ, your test would look like this: ```java import org.junit.jupiter.api.Test; import org.springframework.aot.hint.RuntimeHints; import org.springframework.aot.hint.predicate.RuntimeHintsPredicates; import org.springframework.boot.docs.packaging.nativeimage.advanced.customhints.MyRuntimeHints; import static org.assertj.core.api.Assertions.assertThat; class MyRuntimeHintsTests { @Test void shouldRegisterHints() { RuntimeHints hints = new RuntimeHints(); new MyRuntimeHints().registerHints(hints, getClass().getClassLoader()); assertThat(RuntimeHintsPredicates.resource().forResource("my-resource.txt")).accepts(hints); } } ``` ### [](#packaging.native-image.advanced.custom-hints.static)Providing Hints Statically If you prefer, custom hints can be provided statically in one or more GraalVM JSON hint files. Such files should be placed in `src/main/resources/` within a `META-INF/native-image/*/*/` directory. The [hints generated during AOT processing](introducing-graalvm-native-images.html#packaging.native-image.introducing-graalvm-native-images.understanding-aot-processing) are written to a directory named `META-INF/native-image/{groupId}/{artifactId}/`. Place your static hint files in a directory that does not clash with this location, such as `META-INF/native-image/{groupId}/{artifactId}-additional-hints/`. ## [](#packaging.native-image.advanced.known-limitations)Known Limitations GraalVM native images are an evolving technology and not all libraries provide support. The GraalVM community is helping by providing [reachability metadata](https://github.com/oracle/graalvm-reachability-metadata) for projects that don’t yet ship their own. Spring itself doesn’t contain hints for 3rd party libraries and instead relies on the reachability metadata project. If you encounter problems when generating native images for Spring Boot applications, please check the [Spring Boot with GraalVM](https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-with-GraalVM) page of the Spring Boot wiki. You can also contribute issues to the [spring-aot-smoke-tests](https://github.com/spring-projects/spring-aot-smoke-tests) project on GitHub which is used to confirm that common application types are working as expected. If you find a library which doesn’t work with GraalVM, please raise an issue on the [reachability metadata project](https://github.com/oracle/graalvm-reachability-metadata). * [Spring Boot](../../../index.html) * [4.1.1](advanced-topics.html) * [4.0.8](../../../4.0/reference/packaging/native-image/advanced-topics.html) * [3.5.16](../../../3.5/reference/packaging/native-image/advanced-topics.html) * [3.4.13](../../../3.4/reference/packaging/native-image/advanced-topics.html) * [3.3.13](../../../3.3/reference/packaging/native-image/advanced-topics.html) - [4.2.0-M2](../../../4.2/reference/packaging/native-image/advanced-topics.html) * [4.2.0-SNAPSHOT](../../../4.2-SNAPSHOT/reference/packaging/native-image/advanced-topics.html) * [4.1.3-SNAPSHOT](../../../4.1-SNAPSHOT/reference/packaging/native-image/advanced-topics.html) * [4.0.10-SNAPSHOT](../../../4.0-SNAPSHOT/reference/packaging/native-image/advanced-topics.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/packaging-oci-image.html ---- # Packaging OCI Images The plugin can create an [OCI image](https://github.com/opencontainers/image-spec) from a jar or war file using [Cloud Native Buildpacks](https://buildpacks.io) (CNB). Images can be built using the `bootBuildImage` task. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | For security reasons, images build and run as non-root users. See the [CNB specification](https://buildpacks.io/docs/reference/spec/platform-api/#users) for more details. | The task is automatically created when the `java` or `war` plugin is applied and is an instance of [`BootBuildImage`](api/java/org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html). ## [](#build-image.docker-daemon)Docker Daemon The `bootBuildImage` task requires access to a Docker daemon. The task will inspect local Docker CLI [configuration files](https://docs.docker.com/engine/reference/commandline/cli/#configuration-files) to determine the current [context](https://docs.docker.com/engine/context/working-with-contexts/) and use the context connection information to communicate with a Docker daemon. If the current context can not be determined or the context does not have connection information, then the task will use a default local connection. This works with [Docker Engine](https://docs.docker.com/install/) on all supported platforms without configuration. Environment variables can be set to configure the `bootBuildImage` task to use an alternative local or remote connection. The following table shows the environment variables and their values: | Environment variable | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | DOCKER\_CONFIG | Location of Docker CLI [configuration files](https://docs.docker.com/engine/reference/commandline/cli/#configuration-files) used to determine the current context (defaults to `$HOME/.docker`) | | DOCKER\_CONTEXT | Name of a [context](https://docs.docker.com/engine/context/working-with-contexts/) that should be used to retrieve host information from Docker CLI configuration files (overrides `DOCKER_HOST`) | | DOCKER\_HOST | URL containing the host and port for the Docker daemon - for example `tcp://192.168.99.100:2376` | | DOCKER\_TLS\_VERIFY | Enable secure HTTPS protocol when set to `1` (optional) | | DOCKER\_CERT\_PATH | Path to certificate and key files for HTTPS (required if `DOCKER_TLS_VERIFY=1`, ignored otherwise) | Docker daemon connection information can also be provided using `docker` properties in the plugin configuration. The following table summarizes the available properties: | Property | Description | | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `context` | Name of a [context](https://docs.docker.com/engine/context/working-with-contexts/) that should be used to retrieve host information from Docker CLI [configuration files](https://docs.docker.com/engine/reference/commandline/cli/#configuration-files) | | `host` | URL containing the host and port for the Docker daemon - for example `tcp://192.168.99.100:2376` | | `tlsVerify` | Enable secure HTTPS protocol when set to `true` (optional) | | `certPath` | Path to certificate and key files for HTTPS (required if `tlsVerify` is `true`, ignored otherwise) | | `bindHostToBuilder` | When `true`, the value of the `host` property will be provided to the container that is created for the CNB builder (optional) | For more details, see also [examples](#build-image.examples.docker). ## [](#build-image.docker-registry)Docker Registry If the Docker images specified by the `builder` or `runImage` properties are stored in a private Docker image registry that requires authentication, the authentication credentials can be provided using `docker.builderRegistry` properties. If the generated Docker image is to be published to a Docker image registry, the authentication credentials can be provided using `docker.publishRegistry` properties. Properties are provided for user authentication or identity token authentication. Consult the documentation for the Docker registry being used to store images for further information on supported authentication methods. The following table summarizes the available properties for `docker.builderRegistry` and `docker.publishRegistry`: | Property | Description | | ---------- | ------------------------------------------------------------------------------------- | | `username` | Username for the Docker image registry user. Required for user authentication. | | `password` | Password for the Docker image registry user. Required for user authentication. | | `url` | Address of the Docker image registry. Optional for user authentication. | | `email` | E-mail address for the Docker image registry user. Optional for user authentication. | | `token` | Identity token for the Docker image registry user. Required for token authentication. | For more details, see also [examples](#build-image.examples.docker). | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If credentials are not provided, the plugin reads the user’s existing Docker configuration file (typically located at `$HOME/.docker/config.json`) to determine authentication methods. Using these methods, the plugin attempts to provide authentication credentials for the requested image.The plugin supports the following authentication methods:- **Credential Helpers**: External tools configured in the Docker configuration file to provide credentials for specific registries. For example, tools like `osxkeychain` or `ecr-login` handle authentication for certain registries. - **Credential Store**: A default fallback mechanism that securely stores and retrieves credentials (e.g., `desktop` for Docker Desktop). - **Static Credentials**: Credentials that are stored directly in the Docker configuration file under the `auths` section. | ## [](#build-image.customization)Image Customizations The plugin invokes a [builder](https://buildpacks.io/docs/for-app-developers/concepts/builder/) to orchestrate the generation of an image. The builder includes multiple [buildpacks](https://buildpacks.io/docs/for-app-developers/concepts/buildpack/) that can inspect the application to influence the generated image. By default, the plugin chooses a builder image. The name of the generated image is deduced from project properties. Task properties can be used to configure how the builder should operate on the project. The following table summarizes the available properties and their default values: | Property | Command-line option | Description | Default value | | ---------------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `builder` | `--builder` | Name of the builder image to use. | `paketobuildpacks/builder-noble-java-tiny:latest` | | `trustBuilder` | `--trustBuilder` | Whether to treat the builder as [trusted](https://buildpacks.io/docs/for-platform-operators/how-to/integrate-ci/pack/concepts/trusted_builders/#what-is-a-trusted-builder). | `true` if the builder is one of `paketobuildpacks/builder-noble-java-tiny`, `paketobuildpacks/builder-jammy-java-tiny`, `paketobuildpacks/builder-jammy-tiny`, `paketobuildpacks/builder-jammy-base`, `paketobuildpacks/builder-jammy-full`, `paketobuildpacks/builder-jammy-buildpackless-tiny`, `paketobuildpacks/builder-jammy-buildpackless-base`, `paketobuildpacks/builder-jammy-buildpackless-full`, `gcr.io/buildpacks/builder`, `heroku/builder`; `false` otherwise. | | `imagePlatform` | `--imagePlatform` | The platform (operating system and architecture) of any builder, run, and buildpack images that are pulled. Must be in the form of `OS[/architecture[/variant]]`, such as `linux/amd64`, `linux/arm64`, or `linux/arm/v5`. Refer to documentation of the builder being used to determine the image OS and architecture options available. | No default value, indicating that the platform of the host machine should be used. | | `runImage` | `--runImage` | Name of the run image to use. | No default value, indicating the run image specified in Builder metadata should be used. | | `imageName` | `--imageName` | [Image name](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/buildpack/platform/docker/type/ImageReference.html#of\(java.lang.String\)) for the generated image. | `docker.io/library/${project.name}:${project.version}` | | `pullPolicy` | `--pullPolicy` | [Policy](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/buildpack/platform/build/PullPolicy.html) used to determine when to pull the builder and run images from the registry. Acceptable values are `ALWAYS`, `NEVER`, and `IF_NOT_PRESENT`. | `ALWAYS` | | `environment` | `--environment` | Environment variables that should be passed to the builder. | Empty. | | `buildpacks` | | Buildpacks that the builder should use when building the image. Only the specified buildpacks will be used, overriding the default buildpacks included in the builder. Buildpack references must be in one of the following forms:- Buildpack in the builder - `[urn:cnb:builder:][@]` - Buildpack in a directory on the file system - `[file://]` - Buildpack in a gzipped tar (.tgz) file on the file system - `[file://]/` - Buildpack in an OCI image - `[docker://]/[:][@]` | None, indicating the builder should use the buildpacks included in it. | | `bindings` | | [Volume bind mounts](https://docs.docker.com/storage/bind-mounts/) that should be mounted to the builder container when building the image. The bindings will be passed unparsed and unvalidated to Docker when creating the builder container. Bindings must be in one of the following forms:- `:[:]` - `:[:]`Where `` can contain:- `ro` to mount the volume as read-only in the container - `rw` to mount the volume as readable and writable in the container - `volume-opt=key=value` to specify key-value pairs consisting of an option name and its value | | | `network` | `--network` | The [network driver](https://docs.docker.com/network/#network-drivers) the builder container will be configured to use. The value supplied will be passed unvalidated to Docker when creating the builder container. | | | `cleanCache` | `--cleanCache` | Whether to clean the cache before building. | `false` | | `verboseLogging` | | Enables verbose logging of builder operations. | `false` | | `publish` | `--publishImage` | Whether to publish the generated image to a Docker registry. | `false` | | `tags` | | A list of one or more additional tags to apply to the generated image. The values provided to the `tags` option should be **full** image references. See [the tags section](#build-image.customization.tags) for more details. | | | `buildWorkspace` | | A temporary workspace that will be used by the builder and buildpacks to store files during image building. The value can be a named volume or a bind mount location. | A named volume in the Docker daemon, with a name derived from the image name. | | `buildCache` | | A cache containing layers created by buildpacks and used by the image building process. The value can be a named volume or a bind mount location. | A named volume in the Docker daemon, with a name derived from the image name. | | `launchCache` | | A cache containing layers created by buildpacks and used by the image launching process. The value can be a named volume or a bind mount location. | A named volume in the Docker daemon, with a name derived from the image name. | | `createdDate` | `--createdDate` | A date that will be used to set the `Created` field in the generated image’s metadata. The value must be a string in the ISO 8601 instant format, or `now` to use the current date and time. | A fixed date that enables [build reproducibility](https://buildpacks.io/docs/for-app-developers/concepts/reproducibility/). | | `applicationDirectory` | `--applicationDirectory` | The path to a directory that application contents will be uploaded to in the builder image. Application contents will also be in this location in the generated image. | `/workspace` | | `securityOptions` | `--securityOptions` | [Security options](https://docs.docker.com/reference/cli/docker/container/run/#security-opt) that will be applied to the builder container, provided as an array of string values | `["label=disable"]` on Linux and macOS, `[]` on Windows | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The plugin detects the target Java compatibility of the project using the JavaPlugin’s `targetCompatibility` property. When using the default Paketo builder and buildpacks, the plugin instructs the buildpacks to install the same Java version. You can override this behavior as shown in the [builder configuration](#build-image.examples.builder-configuration) examples. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The default builder `paketobuildpacks/builder-noble-java-tiny:latest` contains a reduced set of system libraries and does not include a shell. Applications that require a shell to run a start script, as might be the case when the [`application` plugin](https://docs.gradle.org/current/userguide/application_plugin.html) has been applied to generate a distribution zip archive, or that depend upon a system library that is not present, should override the `runImage` configuration to use one that includes a shell and a broader set of system libraries, such as `paketobuildpacks/ubuntu-noble-run:latest`. | ## [](#build-image.examples)Examples ### [](#build-image.examples.custom-image-builder)Custom Image Builder and Run Image If you need to customize the builder used to create the image or the run image used to launch the built image, configure the task as shown in the following example: * Groovy * Kotlin ```groovy tasks.named("bootBuildImage") { builder = "mine/java-cnb-builder" runImage = "mine/java-cnb-run" } ``` ```kotlin tasks.named("bootBuildImage") { builder.set("mine/java-cnb-builder") runImage.set("mine/java-cnb-run") } ``` This configuration will use a builder image with the name `mine/java-cnb-builder` and the tag `latest`, and the run image named `mine/java-cnb-run` and the tag `latest`. The builder and run image can be specified on the command line as well, as shown in this example: ```shell $ gradle bootBuildImage --builder=mine/java-cnb-builder --runImage=mine/java-cnb-run ``` ### [](#build-image.examples.builder-configuration)Builder Configuration If the builder exposes configuration options, those can be set using the `environment` property. The following is an example of [configuring the JVM version](https://paketo.io/docs/buildpacks/language-family-buildpacks/java/#configuring-the-jvm-version) used by the Paketo Java buildpacks at build time: * Groovy * Kotlin ```groovy tasks.named("bootBuildImage") { environment["BP_JVM_VERSION"] = "17" } ``` ```kotlin tasks.named("bootBuildImage") { environment.put("BP_JVM_VERSION", "17") } ``` Environment variables can also be specified on the command line, as shown in the following example: ```shell $ gradle bootBuildImage --environment BP_JVM_VERSION=17 ``` `--environment` can be used multiple times to specify multiple environment variables. If there is a network proxy between the Docker daemon the builder runs in and network locations that buildpacks download artifacts from, you will need to configure the builder to use the proxy. When using the Paketo builder, this can be accomplished by setting the `HTTPS_PROXY` and/or `HTTP_PROXY` environment variables as show in the following example: * Groovy * Kotlin ```groovy tasks.named("bootBuildImage") { environment["HTTP_PROXY"] = "http://proxy.example.com" environment["HTTPS_PROXY"] = "https://proxy.example.com" } ``` ```kotlin tasks.named("bootBuildImage") { environment.putAll(mapOf("HTTP_PROXY" to "http://proxy.example.com", "HTTPS_PROXY" to "https://proxy.example.com")) } ``` ### [](#build-image.examples.runtime-jvm-configuration)Runtime JVM Configuration Paketo Java buildpacks [configure the JVM runtime environment](https://paketo.io/docs/buildpacks/language-family-buildpacks/java/#runtime-jvm-configuration) by setting the `JAVA_TOOL_OPTIONS` environment variable. The buildpack-provided `JAVA_TOOL_OPTIONS` value can be modified to customize JVM runtime behavior when the application image is launched in a container. Environment variable modifications that should be stored in the image and applied to every deployment can be set as described in the [Paketo documentation](https://paketo.io/docs/buildpacks/configuration/#environment-variables) and shown in the following example: * Groovy * Kotlin ```groovy tasks.named("bootBuildImage") { environment["BPE_DELIM_JAVA_TOOL_OPTIONS"] = " " environment["BPE_APPEND_JAVA_TOOL_OPTIONS"] = "-XX:+HeapDumpOnOutOfMemoryError" } ``` ```kotlin tasks.named("bootBuildImage") { environment.putAll(mapOf( "BPE_DELIM_JAVA_TOOL_OPTIONS" to " ", "BPE_APPEND_JAVA_TOOL_OPTIONS" to "-XX:+HeapDumpOnOutOfMemoryError" )) } ``` ### [](#build-image.examples.custom-image-name)Custom Image Name By default, the image name is inferred from the `name` and the `version` of the project, something like `docker.io/library/${project.name}:${project.version}`. You can take control over the name by setting task properties, as shown in the following example: * Groovy * Kotlin ```groovy tasks.named("bootBuildImage") { imageName = "example.com/library/${project.name}" } ``` ```kotlin tasks.named("bootBuildImage") { imageName.set("example.com/library/${project.name}") } ``` Note that this configuration does not provide an explicit tag so `latest` is used. It is possible to specify a tag as well, either using `${project.version}`, any property available in the build or a hardcoded version. The image name can be specified on the command line as well, as shown in this example: ```shell $ gradle bootBuildImage --imageName=example.com/library/my-app:v1 ``` ### [](#build-image.examples.buildpacks)Buildpacks By default, the builder will use buildpacks included in the builder image and apply them in a pre-defined order. An alternative set of buildpacks can be provided to apply buildpacks that are not included in the builder, or to change the order of included buildpacks. When one or more buildpacks are provided, only the specified buildpacks will be applied. The following example instructs the builder to use a custom buildpack packaged in a `.tgz` file, followed by a buildpack included in the builder. * Groovy * Kotlin ```groovy tasks.named("bootBuildImage") { buildpacks = ["file:///path/to/example-buildpack.tgz", "urn:cnb:builder:paketo-buildpacks/java"] } ``` ```kotlin tasks.named("bootBuildImage") { buildpacks.set(listOf("file:///path/to/example-buildpack.tgz", "urn:cnb:builder:paketo-buildpacks/java")) } ``` If the Docker registry requires authentication, the credentials can be configured using `docker.publishRegistry` properties. If the Docker registry does not require authentication, the `docker.publishRegistry` configuration can be omitted. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The registry that the image will be published to is determined by the registry part of the image name (`docker.example.com` in these examples). If `docker.publishRegistry` credentials are configured and include a `url` property, this value is passed to the registry but is not used to determine the publishing registry location. | * Groovy * Kotlin ```groovy tasks.named("bootBuildImage") { imageName.set("docker.example.com/library/${project.name}") publish = true docker { publishRegistry { username = "user" password = "secret" } } } ``` ```kotlin tasks.named("bootBuildImage") { imageName.set("docker.example.com/library/${project.name}") publish.set(true) docker { publishRegistry { username.set("user") password.set("secret") } } } ``` The publish option can be specified on the command line as well, as shown in this example: ```shell $ gradle bootBuildImage --imageName=docker.example.com/library/my-app:v1 --publishImage ``` ### [](#build-image.examples.caches)Builder Cache and Workspace Configuration The CNB builder caches layers that are used when building and launching an image. By default, these caches are stored as named volumes in the Docker daemon with names that are derived from the full name of the target image. If the image name changes frequently, for example when the project version is used as a tag in the image name, then the caches can be invalidated frequently. The cache volumes can be configured to use alternative names to give more control over cache lifecycle as shown in the following example: * Groovy * Kotlin ```groovy tasks.named("bootBuildImage") { buildCache { volume { name = "cache-${rootProject.name}.build" } } launchCache { volume { name = "cache-${rootProject.name}.launch" } } } ``` ```kotlin tasks.named("bootBuildImage") { buildCache { volume { name.set("cache-${rootProject.name}.build") } } launchCache { volume { name.set("cache-${rootProject.name}.launch") } } } ``` Builders and buildpacks need a location to store temporary files during image building. By default, this temporary build workspace is stored in a named volume. The caches and the build workspace can be configured to use bind mounts instead of named volumes, as shown in the following example: * Groovy * Kotlin ```groovy tasks.named("bootBuildImage") { buildWorkspace { bind { source = "/tmp/cache-${rootProject.name}.work" } } buildCache { bind { source = "/tmp/cache-${rootProject.name}.build" } } launchCache { bind { source = "/tmp/cache-${rootProject.name}.launch" } } } ``` ```kotlin tasks.named("bootBuildImage") { buildWorkspace { bind { source.set("/tmp/cache-${rootProject.name}.work") } } buildCache { bind { source.set("/tmp/cache-${rootProject.name}.build") } } launchCache { bind { source.set("/tmp/cache-${rootProject.name}.launch") } } } ``` ### [](#build-image.examples.docker)Docker Configuration #### [](#build-image.examples.docker.minikube)Docker Configuration for minikube The plugin can communicate with the [Docker daemon provided by minikube](https://minikube.sigs.k8s.io/docs/tasks/docker_daemon/) instead of the default local connection. On Linux and macOS, environment variables can be set using the command `eval $(minikube docker-env)` after minikube has been started. The plugin can also be configured to use the minikube daemon by providing connection details similar to those shown in the following example: * Groovy * Kotlin ```groovy tasks.named("bootBuildImage") { docker { host = "tcp://192.168.99.100:2376" tlsVerify = true certPath = "/home/user/.minikube/certs" } } ``` ```kotlin tasks.named("bootBuildImage") { docker { host.set("tcp://192.168.99.100:2376") tlsVerify.set(true) certPath.set("/home/user/.minikube/certs") } } ``` #### [](#build-image.examples.docker.podman)Docker Configuration for podman The plugin can communicate with a [podman container engine](https://podman.io/). The plugin can be configured to use podman local connection by providing connection details similar to those shown in the following example: * Groovy * Kotlin ```groovy tasks.named("bootBuildImage") { docker { host = "unix:///run/user/1000/podman/podman.sock" bindHostToBuilder = true } } ``` ```kotlin tasks.named("bootBuildImage") { docker { host.set("unix:///run/user/1000/podman/podman.sock") bindHostToBuilder.set(true) } } ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | With the `podman` CLI installed, the command `podman info --format='{{.Host.RemoteSocket.Path}}'` can be used to get the value for the `docker.host` configuration property shown in this example. | #### [](#build-image.examples.docker.colima)Docker Configuration for Colima The plugin can communicate with the Docker daemon provided by [Colima](https://github.com/abiosoft/colima). The `DOCKER_HOST` environment variable can be set by using the following command: ```shell $ export DOCKER_HOST=$(docker context inspect colima -f '{{.Endpoints.docker.Host}}') ``` The plugin can also be configured to use Colima daemon by providing connection details similar to those shown in the following example: * Groovy * Kotlin ```groovy tasks.named("bootBuildImage") { docker { host = "unix://${System.properties['user.home']}/.colima/docker.sock" } } ``` ```kotlin tasks.named("bootBuildImage") { docker { host.set("unix://${System.getProperty("user.home")}/.colima/docker.sock") } } ``` #### [](#build-image.examples.docker.auth)Docker Configuration for Authentication If the builder or run image are stored in a private Docker registry that supports user authentication, authentication details can be provided using `docker.builderRegistry` properties as shown in the following example: * Groovy * Kotlin ```groovy tasks.named("bootBuildImage") { docker { builderRegistry { username = "user" password = "secret" url = "https://docker.example.com/v1/" email = "[email protected]" } } } ``` ```kotlin tasks.named("bootBuildImage") { docker { builderRegistry { username.set("user") password.set("secret") url.set("https://docker.example.com/v1/") email.set("[email protected]") } } } ``` If the builder or run image is stored in a private Docker registry that supports token authentication, the token value can be provided using `docker.builderRegistry` as shown in the following example: * Groovy * Kotlin ```groovy tasks.named("bootBuildImage") { docker { builderRegistry { token = "9cbaf023786cd7..." } } } ``` ```kotlin tasks.named("bootBuildImage") { docker { builderRegistry { token.set("9cbaf023786cd7...") } } } ``` * [Spring Boot](../index.html) * [4.1.1](packaging-oci-image.html) * [4.0.8](../4.0/gradle-plugin/packaging-oci-image.html) * [3.5.16](../3.5/gradle-plugin/packaging-oci-image.html) * [3.4.13](../3.4/gradle-plugin/packaging-oci-image.html) * [3.3.13](../3.3/gradle-plugin/packaging-oci-image.html) - [4.2.0-M2](../4.2/gradle-plugin/packaging-oci-image.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/gradle-plugin/packaging-oci-image.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/gradle-plugin/packaging-oci-image.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/gradle-plugin/packaging-oci-image.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter.html ---- # Class AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.shared.artifact.filter.collection.AbstractArtifactsFilter org.apache.maven.shared.artifact.filter.collection.AbstractArtifactFeatureFilter org.springframework.boot.maven.AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter * All Implemented Interfaces: `org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter` - Enclosing class: `AbstractDependencyFilterMojo` *** protected static class AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter extends org.apache.maven.shared.artifact.filter.collection.AbstractArtifactFeatureFilter `ArtifactFilter` to exclude test scope dependencies. * Since: 1.1.0 * Author: Stephane Nicoll, David Turanski * ## Method Details * ### getArtifactFeature protected [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getArtifactFeature​(org.apache.maven.artifact.Artifact artifact) * Specified by: `getArtifactFeature` in class `org.apache.maven.shared.artifact.filter.collection.AbstractArtifactFeatureFilter` ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/plugin/package-tree.html ---- # Hierarchy For Package org.springframework.boot.gradle.plugin Package Hierarchies: * [All Packages](../../../../../overview-tree.html) ## Class Hierarchy * java.lang.[Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") * org.gradle.api.internal.AbstractTask (implements org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal) * org.gradle.api.[DefaultTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/DefaultTask.html "class or interface in org.gradle.api") (implements org.gradle.api.[Task](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api")) * org.springframework.boot.gradle.plugin.[ResolveMainClassName](ResolveMainClassName.html "class in org.springframework.boot.gradle.plugin") * org.springframework.boot.gradle.plugin.[SpringBootAotPlugin](SpringBootAotPlugin.html "class in org.springframework.boot.gradle.plugin") (implements org.gradle.api.[Plugin](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Plugin.html "class or interface in org.gradle.api")\) * org.springframework.boot.gradle.plugin.[SpringBootPlugin](SpringBootPlugin.html "class in org.springframework.boot.gradle.plugin") (implements org.gradle.api.[Plugin](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Plugin.html "class or interface in org.gradle.api")\) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-7.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## G * [generateAotAssets(URL\[\], String, String...)](../org/springframework/boot/maven/AbstractAotMojo.html#generateAotAssets\(java.net.URL%5B%5D,java.lang.String,java.lang.String...\)) - Method in class org.springframework.boot.maven.[AbstractAotMojo](../org/springframework/boot/maven/AbstractAotMojo.html "class in org.springframework.boot.maven")   * [getApplicationDirectory()](../org/springframework/boot/maven/Image.html#getApplicationDirectory\(\)) - Method in class org.springframework.boot.maven.[Image](../org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven") Returns the application content directory for the image. * [getArtifactFeature(Artifact)](../org/springframework/boot/maven/AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter.html#getArtifactFeature\(org.apache.maven.artifact.Artifact\)) - Method in class org.springframework.boot.maven.[AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter](../org/springframework/boot/maven/AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter.html "class in org.springframework.boot.maven")   * [getArtifactFeature(Artifact)](../org/springframework/boot/maven/MatchingGroupIdFilter.html#getArtifactFeature\(org.apache.maven.artifact.Artifact\)) - Method in class org.springframework.boot.maven.[MatchingGroupIdFilter](../org/springframework/boot/maven/MatchingGroupIdFilter.html "class in org.springframework.boot.maven")   * [getBuilder()](../org/springframework/boot/maven/Image.html#getBuilder\(\)) - Method in class org.springframework.boot.maven.[Image](../org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven") The name of the builder image to use to create the image. * [getCertPath()](../org/springframework/boot/maven/Docker.html#getCertPath\(\)) - Method in class org.springframework.boot.maven.[Docker](../org/springframework/boot/maven/Docker.html "class in org.springframework.boot.maven") The path to TLS certificate and key files required for TLS communication with the Docker daemon. * [getClassesDirectories()](../org/springframework/boot/maven/AbstractRunMojo.html#getClassesDirectories\(\)) - Method in class org.springframework.boot.maven.[AbstractRunMojo](../org/springframework/boot/maven/AbstractRunMojo.html "class in org.springframework.boot.maven") Returns the directories that contain the application's classes and resources. * [getClassesDirectories()](../org/springframework/boot/maven/TestRunMojo.html#getClassesDirectories\(\)) - Method in class org.springframework.boot.maven.[TestRunMojo](../org/springframework/boot/maven/TestRunMojo.html "class in org.springframework.boot.maven")   * [getClassPath(boolean)](../org/springframework/boot/maven/ProcessTestAotMojo.html#getClassPath\(boolean\)) - Method in class org.springframework.boot.maven.[ProcessTestAotMojo](../org/springframework/boot/maven/ProcessTestAotMojo.html "class in org.springframework.boot.maven")   * [getClassPath(File\[\], ArtifactsFilter...)](../org/springframework/boot/maven/AbstractAotMojo.html#getClassPath\(java.io.File%5B%5D,org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter...\)) - Method in class org.springframework.boot.maven.[AbstractAotMojo](../org/springframework/boot/maven/AbstractAotMojo.html "class in org.springframework.boot.maven")   * [getClassPathUrls()](../org/springframework/boot/maven/AbstractRunMojo.html#getClassPathUrls\(\)) - Method in class org.springframework.boot.maven.[AbstractRunMojo](../org/springframework/boot/maven/AbstractRunMojo.html "class in org.springframework.boot.maven")   * [getCleanCache()](../org/springframework/boot/maven/Image.html#getCleanCache\(\)) - Method in class org.springframework.boot.maven.[Image](../org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven") If the cache should be cleaned before building. * [getConfiguration()](../org/springframework/boot/maven/Layers.html#getConfiguration\(\)) - Method in class org.springframework.boot.maven.[Layers](../org/springframework/boot/maven/Layers.html "class in org.springframework.boot.maven") The location of the layers configuration file. * [getConfigurationName()](../org/springframework/boot/maven/Layers.html#getConfigurationName\(\)) - Method in class org.springframework.boot.maven.[Layers](../org/springframework/boot/maven/Layers.html "class in org.springframework.boot.maven") The name of the layers configuration to load from the classpath. * [getConfiguredPackager(Supplier)](../org/springframework/boot/maven/AbstractPackagerMojo.html#getConfiguredPackager\(java.util.function.Supplier\)) - Method in class org.springframework.boot.maven.[AbstractPackagerMojo](../org/springframework/boot/maven/AbstractPackagerMojo.html "class in org.springframework.boot.maven") Return a `Packager` configured for this MOJO. * [getContext()](../org/springframework/boot/maven/Docker.html#getContext\(\)) - Method in class org.springframework.boot.maven.[Docker](../org/springframework/boot/maven/Docker.html "class in org.springframework.boot.maven") The Docker context to use to retrieve host configuration. * [getCreatedDate()](../org/springframework/boot/maven/Image.html#getCreatedDate\(\)) - Method in class org.springframework.boot.maven.[Image](../org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven") Returns the created date for the image. * [getData()](../org/springframework/boot/maven/PropertiesMergingResourceTransformer.html#getData\(\)) - Method in class org.springframework.boot.maven.[PropertiesMergingResourceTransformer](../org/springframework/boot/maven/PropertiesMergingResourceTransformer.html "class in org.springframework.boot.maven") Return the data the properties being merged. * [getDependencyURLs(ArtifactsFilter...)](../org/springframework/boot/maven/AbstractDependencyFilterMojo.html#getDependencyURLs\(org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter...\)) - Method in class org.springframework.boot.maven.[AbstractDependencyFilterMojo](../org/springframework/boot/maven/AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven")   * [getEmail()](../org/springframework/boot/maven/Docker.DockerRegistry.html#getEmail\(\)) - Method in class org.springframework.boot.maven.[Docker.DockerRegistry](../org/springframework/boot/maven/Docker.DockerRegistry.html "class in org.springframework.boot.maven") The email address that will be used for user authentication to the registry. * [getEnv()](../org/springframework/boot/maven/Image.html#getEnv\(\)) - Method in class org.springframework.boot.maven.[Image](../org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven") Environment properties that should be passed to the builder. * [getFilters()](../org/springframework/boot/maven/DependencyFilter.html#getFilters\(\)) - Method in class org.springframework.boot.maven.[DependencyFilter](../org/springframework/boot/maven/DependencyFilter.html "class in org.springframework.boot.maven")   * [getHost()](../org/springframework/boot/maven/Docker.html#getHost\(\)) - Method in class org.springframework.boot.maven.[Docker](../org/springframework/boot/maven/Docker.html "class in org.springframework.boot.maven") The host address of the Docker daemon. * [getImagePlatform()](../org/springframework/boot/maven/Image.html#getImagePlatform\(\)) - Method in class org.springframework.boot.maven.[Image](../org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven") Returns the platform (os/architecture/variant) that will be used for all pulled images. * [getLayout()](../org/springframework/boot/maven/AbstractPackagerMojo.html#getLayout\(\)) - Method in class org.springframework.boot.maven.[AbstractPackagerMojo](../org/springframework/boot/maven/AbstractPackagerMojo.html "class in org.springframework.boot.maven") Return the type of archive that should be packaged by this MOJO. * [getLayout()](../org/springframework/boot/maven/BuildImageMojo.html#getLayout\(\)) - Method in class org.springframework.boot.maven.[BuildImageMojo](../org/springframework/boot/maven/BuildImageMojo.html "class in org.springframework.boot.maven") Return the type of archive that should be used when building the image. * [getLayout()](../org/springframework/boot/maven/RepackageMojo.html#getLayout\(\)) - Method in class org.springframework.boot.maven.[RepackageMojo](../org/springframework/boot/maven/RepackageMojo.html "class in org.springframework.boot.maven") Return the type of archive that should be packaged by this MOJO. * [getLayoutFactory()](../org/springframework/boot/maven/AbstractPackagerMojo.html#getLayoutFactory\(\)) - Method in class org.springframework.boot.maven.[AbstractPackagerMojo](../org/springframework/boot/maven/AbstractPackagerMojo.html "class in org.springframework.boot.maven") Return the layout factory that will be used to determine the [`AbstractPackagerMojo.LayoutType`](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") if no explicit layout is set. * [getLayoutFactory()](../org/springframework/boot/maven/BuildImageMojo.html#getLayoutFactory\(\)) - Method in class org.springframework.boot.maven.[BuildImageMojo](../org/springframework/boot/maven/BuildImageMojo.html "class in org.springframework.boot.maven") Return the layout factory that will be used to determine the [`AbstractPackagerMojo.LayoutType`](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") if no explicit layout is set. * [getLayoutFactory()](../org/springframework/boot/maven/RepackageMojo.html#getLayoutFactory\(\)) - Method in class org.springframework.boot.maven.[RepackageMojo](../org/springframework/boot/maven/RepackageMojo.html "class in org.springframework.boot.maven") Return the layout factory that will be used to determine the [`AbstractPackagerMojo.LayoutType`](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") if no explicit layout is set. * [getLibraries(Collection)](../org/springframework/boot/maven/AbstractPackagerMojo.html#getLibraries\(java.util.Collection\)) - Method in class org.springframework.boot.maven.[AbstractPackagerMojo](../org/springframework/boot/maven/AbstractPackagerMojo.html "class in org.springframework.boot.maven") Return `Libraries` that the packager can use. * [getName()](../org/springframework/boot/maven/CacheInfo.VolumeCacheInfo.html#getName\(\)) - Method in class org.springframework.boot.maven.[CacheInfo.VolumeCacheInfo](../org/springframework/boot/maven/CacheInfo.VolumeCacheInfo.html "class in org.springframework.boot.maven")   * [getName()](../org/springframework/boot/maven/Image.html#getName\(\)) - Method in class org.springframework.boot.maven.[Image](../org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven") The name of the created image. * [getNetwork()](../org/springframework/boot/maven/Image.html#getNetwork\(\)) - Method in class org.springframework.boot.maven.[Image](../org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven") Returns the network the build container will connect to. * [getPassword()](../org/springframework/boot/maven/Docker.DockerRegistry.html#getPassword\(\)) - Method in class org.springframework.boot.maven.[Docker.DockerRegistry](../org/springframework/boot/maven/Docker.DockerRegistry.html "class in org.springframework.boot.maven") The password that will be used for user authentication to the registry. * [getPublish()](../org/springframework/boot/maven/Image.html#getPublish\(\)) - Method in class org.springframework.boot.maven.[Image](../org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven") If the built image should be pushed to a registry. * [getPullPolicy()](../org/springframework/boot/maven/Image.html#getPullPolicy\(\)) - Method in class org.springframework.boot.maven.[Image](../org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven") If images should be pulled from a remote repository during image build. * [getResource()](../org/springframework/boot/maven/PropertiesMergingResourceTransformer.html#getResource\(\)) - Method in class org.springframework.boot.maven.[PropertiesMergingResourceTransformer](../org/springframework/boot/maven/PropertiesMergingResourceTransformer.html "class in org.springframework.boot.maven")   * [getRunImage()](../org/springframework/boot/maven/Image.html#getRunImage\(\)) - Method in class org.springframework.boot.maven.[Image](../org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven") The name of the run image to use to create the image. * [getSession()](../org/springframework/boot/maven/AbstractAotMojo.html#getSession\(\)) - Method in class org.springframework.boot.maven.[AbstractAotMojo](../org/springframework/boot/maven/AbstractAotMojo.html "class in org.springframework.boot.maven") Return Maven execution session. * [getSource()](../org/springframework/boot/maven/CacheInfo.BindCacheInfo.html#getSource\(\)) - Method in class org.springframework.boot.maven.[CacheInfo.BindCacheInfo](../org/springframework/boot/maven/CacheInfo.BindCacheInfo.html "class in org.springframework.boot.maven")   * [getSourceArtifact(String)](../org/springframework/boot/maven/AbstractPackagerMojo.html#getSourceArtifact\(java.lang.String\)) - Method in class org.springframework.boot.maven.[AbstractPackagerMojo](../org/springframework/boot/maven/AbstractPackagerMojo.html "class in org.springframework.boot.maven") Return the source `Artifact` to repackage. * [getTargetFile(String, String, File)](../org/springframework/boot/maven/AbstractPackagerMojo.html#getTargetFile\(java.lang.String,java.lang.String,java.io.File\)) - Method in class org.springframework.boot.maven.[AbstractPackagerMojo](../org/springframework/boot/maven/AbstractPackagerMojo.html "class in org.springframework.boot.maven")   * [getToken()](../org/springframework/boot/maven/Docker.DockerRegistry.html#getToken\(\)) - Method in class org.springframework.boot.maven.[Docker.DockerRegistry](../org/springframework/boot/maven/Docker.DockerRegistry.html "class in org.springframework.boot.maven") The token that will be used for token authentication to the registry. * [getTrustBuilder()](../org/springframework/boot/maven/Image.html#getTrustBuilder\(\)) - Method in class org.springframework.boot.maven.[Image](../org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven") If the builder should be treated as trusted. * [getUsername()](../org/springframework/boot/maven/Docker.DockerRegistry.html#getUsername\(\)) - Method in class org.springframework.boot.maven.[Docker.DockerRegistry](../org/springframework/boot/maven/Docker.DockerRegistry.html "class in org.springframework.boot.maven") The username that will be used for user authentication to the registry. [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/class-use/LayeredSpec.ApplicationSpec.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.bundling.LayeredSpec.ApplicationSpec ========================================================================== Packages that use [LayeredSpec.ApplicationSpec](../LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Package Description [org.springframework.boot.gradle.tasks.bundling](#org.springframework.boot.gradle.tasks.bundling) Support for creating executable jars and wars. * ## Uses of [LayeredSpec.ApplicationSpec](../LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) Methods in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) that return [LayeredSpec.ApplicationSpec](../LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Modifier and Type Method Description `LayeredSpec.ApplicationSpec` LayeredSpec.`getApplication()` Returns the [`LayeredSpec.ApplicationSpec`](../LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which application classes and resources belong. Methods in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) with parameters of type [LayeredSpec.ApplicationSpec](../LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Modifier and Type Method Description `void` LayeredSpec.`setApplication(LayeredSpec.ApplicationSpec spec)` Sets the [`LayeredSpec.ApplicationSpec`](../LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which application classes are resources belong. Method parameters in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) with type arguments of type [LayeredSpec.ApplicationSpec](../LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Modifier and Type Method Description `void` LayeredSpec.`application(Action action)` Customizes the [`LayeredSpec.ApplicationSpec`](../LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") using the given `action`. ---- url: https://docs.spring.io/spring-boot/cli/using-the-cli.html ---- # Using the CLI Once you have installed the CLI, you can run it by typing `spring` and pressing Enter at the command line. If you run `spring` without any arguments, a help screen is displayed, as follows: ```shell $ spring usage: spring [--help] [--version] [] Available commands are: init [options] [location] Initialize a new project using Spring Initializr (start.spring.io) encodepassword [options] Encode a password for use with Spring Security shell Start a nested shell Common options: --debug Verbose mode Print additional status information for the command you are running See 'spring help ' for more information on a specific command. ``` You can type `spring help` to get more details about any of the supported commands, as shown in the following example: ```shell $ spring help init spring init - Initialize a new project using Spring Initializr (start.spring.io) usage: spring init [options] [location] Option Description ------ ----------- -a, --artifact-id Project coordinates; infer archive name (for example 'test') -b, --boot-version Spring Boot version (for example '1.2.0.RELEASE') --build Build system to use (for example 'maven' or 'gradle') (default: maven) -d, --dependencies Comma-separated list of dependency identifiers to include in the generated project --description Project description -f, --force Force overwrite of existing files --format Format of the generated content (for example 'build' for a build file, 'project' for a project archive) (default: project) -g, --group-id Project coordinates (for example 'org.test') -j, --java-version Language level (for example '1.8') -l, --language Programming language (for example 'java') --list List the capabilities of the service. Use it to discover the dependencies and the types that are available -n, --name Project name; infer application name -p, --packaging Project packaging (for example 'jar') --package-name Package name -t, --type Project type. Not normally needed if you use -- build and/or --format. Check the capabilities of the service (--list) for more details --target URL of the service to use (default: https://start. spring.io) -v, --version Project version (for example '0.0.1-SNAPSHOT') -x, --extract Extract the project archive. Inferred if a location is specified without an extension examples: To list all the capabilities of the service: $ spring init --list To creates a default project: $ spring init To create a web my-app.zip: $ spring init -d=web my-app.zip To create a web/data-jpa gradle project unpacked: $ spring init -d=web,jpa --build=gradle my-dir ``` The `version` command provides a quick way to check which version of Spring Boot you are using, as follows: ```shell $ spring version Spring CLI v4.1.1 ``` ## [](#cli.using-the-cli.initialize-new-project)Initialize a New Project The `init` command lets you create a new project by using [start.spring.io](https://start.spring.io) without leaving the shell, as shown in the following example: ```shell $ spring init --dependencies=web,data-jpa my-project Using service at https://start.spring.io Project extracted to '/Users/developer/example/my-project' ``` The preceding example creates a `my-project` directory with a Maven-based project that uses `spring-boot-starter-web` and `spring-boot-starter-data-jpa`. You can list the capabilities of the service by using the `--list` flag, as shown in the following example: ```shell $ spring init --list ======================================= Capabilities of https://start.spring.io ======================================= Available dependencies: ----------------------- actuator - Actuator: Production ready features to help you monitor and manage your application ... web - Web: Support for full-stack web development, including Tomcat and spring-webmvc websocket - Websocket: Support for WebSocket development ws - WS: Support for Spring Web Services Available project types: ------------------------ gradle-build - Gradle Config [format:build, build:gradle] gradle-project - Gradle Project [format:project, build:gradle] maven-build - Maven POM [format:build, build:maven] maven-project - Maven Project [format:project, build:maven] (default) ... ``` The `init` command supports many options. See the `help` output for more details. For instance, the following command creates a Gradle project that uses Java 17 and `war` packaging: ```shell $ spring init --build=gradle --java-version=17 --dependencies=websocket --packaging=war sample-app.zip Using service at https://start.spring.io Content saved to 'sample-app.zip' ``` ## [](#cli.using-the-cli.embedded-shell)Using the Embedded Shell Spring Boot includes command-line completion scripts for the BASH and zsh shells. If you do not use either of these shells (perhaps you are a Windows user), you can use the `shell` command to launch an integrated shell, as shown in the following example: ```shell $ spring shell Spring Boot (v4.1.1) Hit TAB to complete. Type \'help' and hit RETURN for help, and \'exit' to quit. ``` From inside the embedded shell, you can run other commands directly: ```shell $ version Spring CLI v4.1.1 ``` The embedded shell supports ANSI color output as well as `tab` completion. If you need to run a native command, you can use the `!` prefix. To exit the embedded shell, press `ctrl-c`. * [Spring Boot](../index.html) * [4.1.1](using-the-cli.html) * [4.0.8](../4.0/cli/using-the-cli.html) * [3.5.16](../3.5/cli/using-the-cli.html) * [3.4.13](../3.4/cli/using-the-cli.html) * [3.3.13](../3.3/cli/using-the-cli.html) - [4.2.0-M2](../4.2/cli/using-the-cli.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/cli/using-the-cli.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/cli/using-the-cli.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/cli/using-the-cli.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/packaging/container-images/index.html ---- # Container Images Spring Boot applications can be containerized [using Dockerfiles](dockerfiles.html), or by [using Cloud Native Buildpacks](cloud-native-buildpacks.html) to create optimized docker compatible container images that you can run anywhere. * [Spring Boot](../../../index.html) * [4.1.1](index.html) * [4.0.8](../../../4.0/reference/packaging/container-images/index.html) * [3.5.16](../../../3.5/reference/packaging/container-images/index.html) * [3.4.13](../../../3.4/reference/packaging/container-images/index.html) * [3.3.13](../../../3.3/reference/packaging/container-images/index.html) - [4.2.0-M2](../../../4.2/reference/packaging/container-images/index.html) * [4.2.0-SNAPSHOT](../../../4.2-SNAPSHOT/reference/packaging/container-images/index.html) * [4.1.3-SNAPSHOT](../../../4.1-SNAPSHOT/reference/packaging/container-images/index.html) * [4.0.10-SNAPSHOT](../../../4.0-SNAPSHOT/reference/packaging/container-images/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/aot.html ---- # Ahead-of-Time Processing Spring AOT is a process that analyzes your code at build-time in order to generate an optimized version of it. It is most often used to help generate GraalVM native images. The `org.springframework.boot.aot` Gradle plugin provides tasks that can be used to perform AOT processing on both application and test code. The plugin is applied automatically when the [GraalVM Native Image plugin](https://graalvm.github.io/native-build-tools/1.1.8/gradle-plugin.html) is applied: * Groovy * Kotlin ```groovy plugins { id 'org.springframework.boot' version '4.1.1' id 'org.graalvm.buildtools.native' version '1.1.8' id 'java' } ``` ```kotlin plugins { id("org.springframework.boot") version "4.1.1" id("org.graalvm.buildtools.native") version "1.1.8" java } ``` If you want to [run an AOT-processed application on the JVM](../reference/packaging/aot.html) rather than as a native image, apply the `org.springframework.boot.aot` plugin directly: * Groovy * Kotlin ```groovy plugins { id 'org.springframework.boot' version '4.1.1' id 'java' } apply plugin: 'org.springframework.boot.aot' ``` ```kotlin plugins { id("org.springframework.boot") version "4.1.1" java } apply(plugin = "org.springframework.boot.aot") ``` ## [](#aot.processing-applications)Processing Applications Based on your `@SpringBootApplication`-annotated main class, the `processAot` task generates a persistent view of the beans that are going to be contributed at runtime in a way that bean instantiation is as straightforward as possible. Additional post-processing of the factory is possible using callbacks. For instance, these are used to generate the necessary reflection configuration that GraalVM needs to initialize the context in a native image. As the `BeanFactory` is fully prepared at build-time, conditions are also evaluated. This has an important difference compared to what a regular Spring Boot application does at runtime. For instance, if you want to opt-in or opt-out for certain features, you need to configure the environment used at build time to do so. To this end, the `processAot` task is a [`JavaExec`](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.JavaExec.html) task and can be configured with environment variables, system properties, and arguments as needed. The `nativeCompile` task of the GraalVM Native Image plugin is automatically configured to use the output of the `processAot` task. ## [](#aot.processing-tests)Processing Tests The AOT engine can be applied to JUnit 5 tests that use Spring’s Test Context Framework. Suitable tests are processed by the `processTestAot` task to generate `ApplicationContextInitializer` code. As with application AOT processing, the `BeanFactory` is fully prepared at build-time. As with `processAot`, the `processTestAot` task is `JavaExec` subclass and can be configured as needed to influence this processing. The `nativeTest` task of the GraalVM Native Image plugin is automatically configured to use the output of the `processAot` and `processTestAot` tasks. * [Spring Boot](../index.html) * [4.1.1](aot.html) * [4.0.8](../4.0/gradle-plugin/aot.html) * [3.5.16](../3.5/gradle-plugin/aot.html) * [3.4.13](../3.4/gradle-plugin/aot.html) * [3.3.13](../3.3/gradle-plugin/aot.html) - [4.2.0-M2](../4.2/gradle-plugin/aot.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/gradle-plugin/aot.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/gradle-plugin/aot.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/gradle-plugin/aot.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/messaging/jms.html ---- # JMS The [`ConnectionFactory`](https://jakarta.ee/specifications/messaging/3.1/apidocs/jakarta.messaging/jakarta/jms/ConnectionFactory.html) interface provides a standard method of creating a [`Connection`](https://jakarta.ee/specifications/messaging/3.1/apidocs/jakarta.messaging/jakarta/jms/Connection.html) for interacting with a JMS broker. Although Spring needs a [`ConnectionFactory`](https://jakarta.ee/specifications/messaging/3.1/apidocs/jakarta.messaging/jakarta/jms/ConnectionFactory.html) to work with JMS, you generally need not use it directly yourself and can instead rely on higher level messaging abstractions. (See the [relevant section](https://docs.spring.io/spring-framework/reference/7.0/integration/jms.html) of the Spring Framework reference documentation for details.) Spring Boot also auto-configures the necessary infrastructure to send and receive messages. ## [](#messaging.jms.activemq)ActiveMQ "Classic" Support When [ActiveMQ "Classic"](https://activemq.apache.org/components/classic) is available on the classpath, Spring Boot can configure a [`ConnectionFactory`](https://jakarta.ee/specifications/messaging/3.1/apidocs/jakarta.messaging/jakarta/jms/ConnectionFactory.html). If the broker is present, an embedded broker is automatically started and configured (provided no broker URL is specified through configuration and the embedded broker is not disabled in the configuration). | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | If you use `spring-boot-starter-activemq`, the necessary dependencies to connect to an ActiveMQ "Classic" instance are provided, as is the Spring infrastructure to integrate with JMS. Adding `org.apache.activemq:activemq-broker` to your application lets you use the embedded broker. | ActiveMQ "Classic" configuration is controlled by external configuration properties in `spring.activemq.*`. If `activemq-broker` is on the classpath, ActiveMQ "Classic" is auto-configured to use the [VM transport](https://activemq.apache.org/vm-transport-reference.html), which starts a broker embedded in the same JVM instance. You can disable the embedded broker by configuring the `spring.activemq.embedded.enabled` property, as shown in the following example: * Properties * YAML ```properties spring.activemq.embedded.enabled=false ``` ```yaml spring: activemq: embedded: enabled: false ``` The embedded broker will also be disabled if you configure the broker URL, as shown in the following example: * Properties * YAML ```properties spring.activemq.broker-url=tcp://192.168.1.210:9876 spring.activemq.user=admin spring.activemq.password=secret ``` ```yaml spring: activemq: broker-url: "tcp://192.168.1.210:9876" user: "admin" password: "secret" ``` If you want to take full control over the embedded broker, see [the ActiveMQ "Classic" documentation](https://activemq.apache.org/how-do-i-embed-a-broker-inside-a-connection.html) for further information. By default, a [`CachingConnectionFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/connection/CachingConnectionFactory.html) wraps the native [`ConnectionFactory`](https://jakarta.ee/specifications/messaging/3.1/apidocs/jakarta.messaging/jakarta/jms/ConnectionFactory.html) with sensible settings that you can control by external configuration properties in `spring.jms.*`: * Properties * YAML ```properties spring.jms.cache.session-cache-size=5 ``` ```yaml spring: jms: cache: session-cache-size: 5 ``` If you’d rather use native pooling, you can do so by adding a dependency to `org.messaginghub:pooled-jms` and configuring the [`JmsPoolConnectionFactory`](https://javadoc.io/doc/org.messaginghub/pooled-jms/3.2.3/org/messaginghub/pooled/jms/JmsPoolConnectionFactory.html) accordingly, as shown in the following example: * Properties * YAML ```properties spring.activemq.pool.enabled=true spring.activemq.pool.max-connections=50 ``` ```yaml spring: activemq: pool: enabled: true max-connections: 50 ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | See [`ActiveMQProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/activemq/autoconfigure/ActiveMQProperties.html) for more of the supported options. You can also register an arbitrary number of beans that implement [`ActiveMQConnectionFactoryCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/activemq/autoconfigure/ActiveMQConnectionFactoryCustomizer.html) for more advanced customizations. | By default, ActiveMQ "Classic" creates a destination if it does not yet exist so that destinations are resolved against their provided names. ## [](#messaging.jms.artemis)ActiveMQ Artemis Support Spring Boot can auto-configure a [`ConnectionFactory`](https://jakarta.ee/specifications/messaging/3.1/apidocs/jakarta.messaging/jakarta/jms/ConnectionFactory.html) when it detects that [ActiveMQ Artemis](https://activemq.apache.org/components/artemis/) is available on the classpath. If the broker is present, an embedded broker is automatically started and configured (unless the mode property has been explicitly set). The supported modes are `embedded` (to make explicit that an embedded broker is required and that an error should occur if the broker is not available on the classpath) and `native` (to connect to a broker using the `netty` transport protocol). When the latter is configured, Spring Boot configures a [`ConnectionFactory`](https://jakarta.ee/specifications/messaging/3.1/apidocs/jakarta.messaging/jakarta/jms/ConnectionFactory.html) that connects to a broker running on the local machine with the default settings. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | If you use `spring-boot-starter-artemis`, the necessary dependencies to connect to an existing ActiveMQ Artemis instance are provided, as well as the Spring infrastructure to integrate with JMS. Adding `org.apache.activemq:artemis-jakarta-server` to your application lets you use embedded mode. | ActiveMQ Artemis configuration is controlled by external configuration properties in `spring.artemis.*`. For example, you might declare the following section in `application.properties`: * Properties * YAML ```properties spring.artemis.mode=native spring.artemis.broker-url=tcp://192.168.1.210:9876 spring.artemis.user=admin spring.artemis.password=secret ``` ```yaml spring: artemis: mode: native broker-url: "tcp://192.168.1.210:9876" user: "admin" password: "secret" ``` When embedding the broker, you can choose if you want to enable persistence and list the destinations that should be made available. These can be specified as a comma-separated list to create them with the default options, or you can define bean(s) of type [`JMSQueueConfiguration`](https://javadoc.io/doc/org.apache.activemq/artemis-jms-server/2.53.0/org/apache/activemq/artemis/jms/server/config/JMSQueueConfiguration.html) or [`TopicConfiguration`](https://javadoc.io/doc/org.apache.activemq/artemis-jms-server/2.53.0/org/apache/activemq/artemis/jms/server/config/TopicConfiguration.html), for advanced queue and topic configurations, respectively. By default, a [`CachingConnectionFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/connection/CachingConnectionFactory.html) wraps the native [`ConnectionFactory`](https://jakarta.ee/specifications/messaging/3.1/apidocs/jakarta.messaging/jakarta/jms/ConnectionFactory.html) with sensible settings that you can control by external configuration properties in `spring.jms.*`: * Properties * YAML ```properties spring.jms.cache.session-cache-size=5 ``` ```yaml spring: jms: cache: session-cache-size: 5 ``` If you’d rather use native pooling, you can do so by adding a dependency on `org.messaginghub:pooled-jms` and configuring the [`JmsPoolConnectionFactory`](https://javadoc.io/doc/org.messaginghub/pooled-jms/3.2.3/org/messaginghub/pooled/jms/JmsPoolConnectionFactory.html) accordingly, as shown in the following example: * Properties * YAML ```properties spring.artemis.pool.enabled=true spring.artemis.pool.max-connections=50 ``` ```yaml spring: artemis: pool: enabled: true max-connections: 50 ``` See [`ArtemisProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/artemis/autoconfigure/ArtemisProperties.html) for more supported options. No JNDI lookup is involved, and destinations are resolved against their names, using either the `name` attribute in the ActiveMQ Artemis configuration or the names provided through configuration. ## [](#messaging.jms.jndi)Using a JNDI ConnectionFactory If you are running your application in an application server, Spring Boot tries to locate a JMS [`ConnectionFactory`](https://jakarta.ee/specifications/messaging/3.1/apidocs/jakarta.messaging/jakarta/jms/ConnectionFactory.html) by using JNDI. By default, the `java:/JmsXA` and `java:/XAConnectionFactory` location are checked. You can use the `spring.jms.jndi-name` property if you need to specify an alternative location, as shown in the following example: * Properties * YAML ```properties spring.jms.jndi-name=java:/MyConnectionFactory ``` ```yaml spring: jms: jndi-name: "java:/MyConnectionFactory" ``` ## [](#messaging.jms.sending)Sending a Message Spring’s [`JmsClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/core/JmsClient.html) is auto-configured, and you can autowire it directly into your own beans, as shown in the following example: * Java * Kotlin ```java import org.springframework.jms.core.JmsClient; import org.springframework.stereotype.Component; @Component public class MyBean { private final JmsClient jmsClient; public MyBean(JmsClient jmsClient) { this.jmsClient = jmsClient; } // ... public void someMethod() { this.jmsClient.destination("myQueue").send("hello"); } } ``` ```kotlin import org.springframework.jms.core.JmsClient import org.springframework.stereotype.Component @Component class MyBean(private val jmsClient: JmsClient) { // ... fun someMethod() { jmsClient.destination("myQueue").send("hello") } } ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | [`JmsMessagingTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/core/JmsMessagingTemplate.html) can be injected in a similar manner, and both use the traditional [`JmsTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/core/JmsTemplate.html) that can be injected as well. If a [`DestinationResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/support/destination/DestinationResolver.html) or a [`MessageConverter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/support/converter/MessageConverter.html) bean is defined, it is associated automatically to the auto-configured [`JmsTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/core/JmsTemplate.html). | ## [](#messaging.jms.receiving)Receiving a Message When the JMS infrastructure is present, any bean can be annotated with [`@JmsListener`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/annotation/JmsListener.html) to create a listener endpoint. If no [`JmsListenerContainerFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/config/JmsListenerContainerFactory.html) has been defined, a default one is configured automatically. If a [`DestinationResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/support/destination/DestinationResolver.html), a [`MessageConverter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/support/converter/MessageConverter.html), or a [`ExceptionListener`](https://jakarta.ee/specifications/messaging/3.1/apidocs/jakarta.messaging/jakarta/jms/ExceptionListener.html) beans are defined, they are associated automatically with the default factory. In most scenarios, message listener containers should be configured against the native [`ConnectionFactory`](https://jakarta.ee/specifications/messaging/3.1/apidocs/jakarta.messaging/jakarta/jms/ConnectionFactory.html). This way each listener container has its own connection and this gives full responsibility to it in terms of local recovery. The auto-configuration uses [`ConnectionFactoryUnwrapper`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jms/ConnectionFactoryUnwrapper.html) to unwrap the native connection factory from the auto-configured one. | | | | -- | -------------------------------------------------------------- | | ** | The auto-configuration only unwraps `CachedConnectionFactory`. | By default, the default factory is transactional. If you run in an infrastructure where a [`JtaTransactionManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/transaction/jta/JtaTransactionManager.html) is present, it is associated to the listener container by default. If not, the `sessionTransacted` flag is enabled. In that latter scenario, you can associate your local data store transaction to the processing of an incoming message by adding [`@Transactional`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/transaction/annotation/Transactional.html) on your listener method (or a delegate thereof). This ensures that the incoming message is acknowledged, once the local transaction has completed. This also includes sending response messages that have been performed on the same JMS session. The following component creates a listener endpoint on the `someQueue` destination: * Java * Kotlin ```java import org.springframework.jms.annotation.JmsListener; import org.springframework.stereotype.Component; @Component public class MyBean { @JmsListener(destination = "someQueue") public void processMessage(String content) { // ... } } ``` ```kotlin import org.springframework.jms.annotation.JmsListener import org.springframework.stereotype.Component @Component class MyBean { @JmsListener(destination = "someQueue") fun processMessage(content: String?) { // ... } } ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | See the [`@EnableJms`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/annotation/EnableJms.html) API documentation for more details. | If you need to create more [`JmsListenerContainerFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/config/JmsListenerContainerFactory.html) instances or if you want to override the default, Spring Boot provides a [`DefaultJmsListenerContainerFactoryConfigurer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jms/autoconfigure/DefaultJmsListenerContainerFactoryConfigurer.html) that you can use to initialize a [`DefaultJmsListenerContainerFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/config/DefaultJmsListenerContainerFactory.html) with the same settings as the one that is auto-configured. For instance, the following example exposes another factory that uses a specific [`MessageConverter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/support/converter/MessageConverter.html): * Java * Kotlin ```java import jakarta.jms.ConnectionFactory; import org.springframework.boot.jms.ConnectionFactoryUnwrapper; import org.springframework.boot.jms.autoconfigure.DefaultJmsListenerContainerFactoryConfigurer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.jms.config.DefaultJmsListenerContainerFactory; @Configuration(proxyBeanMethods = false) public class MyJmsConfiguration { @Bean public DefaultJmsListenerContainerFactory myFactory(DefaultJmsListenerContainerFactoryConfigurer configurer, ConnectionFactory connectionFactory) { DefaultJmsListenerContainerFactory factory = new DefaultJmsListenerContainerFactory(); configurer.configure(factory, ConnectionFactoryUnwrapper.unwrapCaching(connectionFactory)); factory.setMessageConverter(new MyMessageConverter()); return factory; } } ``` ```kotlin import jakarta.jms.ConnectionFactory import org.springframework.boot.jms.ConnectionFactoryUnwrapper import org.springframework.boot.jms.autoconfigure.DefaultJmsListenerContainerFactoryConfigurer import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.jms.config.DefaultJmsListenerContainerFactory @Configuration(proxyBeanMethods = false) class MyJmsConfiguration { @Bean fun myFactory(configurer: DefaultJmsListenerContainerFactoryConfigurer, connectionFactory: ConnectionFactory): DefaultJmsListenerContainerFactory { val factory = DefaultJmsListenerContainerFactory() configurer.configure(factory, ConnectionFactoryUnwrapper.unwrapCaching(connectionFactory)) factory.setMessageConverter(MyMessageConverter()) return factory } } ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | In the example above, the customization uses [`ConnectionFactoryUnwrapper`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jms/ConnectionFactoryUnwrapper.html) to associate the native connection factory to the message listener container the same way the auto-configured factory does. | Then you can use the factory in any [`@JmsListener`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/annotation/JmsListener.html)-annotated method as follows: * Java * Kotlin ```java import org.springframework.jms.annotation.JmsListener; import org.springframework.stereotype.Component; @Component public class MyBean { @JmsListener(destination = "someQueue", containerFactory = "myFactory") public void processMessage(String content) { // ... } } ``` ```kotlin import org.springframework.jms.annotation.JmsListener import org.springframework.stereotype.Component @Component class MyBean { @JmsListener(destination = "someQueue", containerFactory = "myFactory") fun processMessage(content: String?) { // ... } } ``` Analogous to `DefaultJmsListenerContainerFactoryConfigurer`, Spring Boot also provides a [`SimpleJmsListenerContainerFactoryConfigurer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jms/autoconfigure/SimpleJmsListenerContainerFactoryConfigurer.html) that you can use to initialize a [`SimpleJmsListenerContainerFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/config/SimpleJmsListenerContainerFactory.html) and apply the related settings that auto-configuration provides. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | In contrast to [`DefaultMessageListenerContainer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/listener/DefaultMessageListenerContainer.html) that uses a pull-based mechanism (polling) to process messages, [`SimpleMessageListenerContainer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/listener/SimpleMessageListenerContainer.html) uses a push-based mechanism that’s very close to the spirit of the standalone JMS specification. To learn more about the differences between the two listener containers, consult their respective javadocs and [Spring Framework reference documentation](https://docs.spring.io/spring-framework/reference/7.0/integration/jms/using.html#jms-mdp). | * [Spring Boot](../../index.html) * [4.1.1](jms.html) * [4.0.8](../../4.0/reference/messaging/jms.html) * [3.5.16](../../3.5/reference/messaging/jms.html) * [3.4.13](../../3.4/reference/messaging/jms.html) * [3.3.13](../../3.3/reference/messaging/jms.html) - [4.2.0-M2](../../4.2/reference/messaging/jms.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/messaging/jms.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/messaging/jms.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/messaging/jms.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/publishing.html ---- # Publishing your Application ## [](#publishing-your-application.maven-publish)Publishing with the Maven-publish Plugin To publish your Spring Boot jar or war, add it to the publication using the `artifact` method on `MavenPublication`. Pass the task that produces that artifact that you wish to publish to the `artifact` method. For example, to publish the artifact produced by the default `bootJar` task: * Groovy * Kotlin ```groovy publishing { publications { bootJava(MavenPublication) { artifact tasks.named("bootJar") } } repositories { maven { url = 'https://repo.example.com' } } } ``` ```kotlin publishing { publications { create("bootJava") { artifact(tasks.named("bootJar")) } } repositories { maven { url = uri("https://repo.example.com") } } } ``` ## [](#publishing-your-application.distribution)Distributing with the Application Plugin When the [`application` plugin](https://docs.gradle.org/current/userguide/application_plugin.html) is applied a distribution named `boot` is created. This distribution contains the archive produced by the `bootJar` or `bootWar` task and scripts to launch it on Unix-like platforms and Windows. Zip and tar distributions can be built by the `bootDistZip` and `bootDistTar` tasks respectively. To use the `application` plugin, its `mainClassName` property must be configured with the name of your application’s main class. * [Spring Boot](../index.html) * [4.1.1](publishing.html) * [4.0.8](../4.0/gradle-plugin/publishing.html) * [3.5.16](../3.5/gradle-plugin/publishing.html) * [3.4.13](../3.4/gradle-plugin/publishing.html) * [3.3.13](../3.3/gradle-plugin/publishing.html) - [4.2.0-M2](../4.2/gradle-plugin/publishing.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/gradle-plugin/publishing.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/gradle-plugin/publishing.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/gradle-plugin/publishing.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-13.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## N * [NONE](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html#NONE) - Enum constant in enum class org.springframework.boot.maven.[AbstractPackagerMojo.LayoutType](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") No Layout. [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-5.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## E * [equals(Artifact, FilterableDependency)](../org/springframework/boot/maven/DependencyFilter.html#equals\(org.apache.maven.artifact.Artifact,org.springframework.boot.maven.FilterableDependency\)) - Method in class org.springframework.boot.maven.[DependencyFilter](../org/springframework/boot/maven/DependencyFilter.html "class in org.springframework.boot.maven") Check if the specified `Artifact` matches the specified [`FilterableDependency`](../org/springframework/boot/maven/FilterableDependency.html "class in org.springframework.boot.maven"). * [Errors()](../org/springframework/boot/maven/AbstractAotMojo.Errors.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.maven.[AbstractAotMojo.Errors](../org/springframework/boot/maven/AbstractAotMojo.Errors.html "class in org.springframework.boot.maven")   * [exclude(Predicate)](../org/springframework/boot/maven/DependencyFilter.html#exclude\(java.util.function.Predicate\)) - Static method in class org.springframework.boot.maven.[DependencyFilter](../org/springframework/boot/maven/DependencyFilter.html "class in org.springframework.boot.maven") Return a new [`DependencyFilter`](../org/springframework/boot/maven/DependencyFilter.html "class in org.springframework.boot.maven") the excludes artifacts based on the given predicate. * [Exclude](../org/springframework/boot/maven/Exclude.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) A model for a dependency to exclude. * [Exclude()](../org/springframework/boot/maven/Exclude.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.maven.[Exclude](../org/springframework/boot/maven/Exclude.html "class in org.springframework.boot.maven")   * [ExcludeFilter](../org/springframework/boot/maven/ExcludeFilter.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) An {DependencyFilter} that filters out any artifact matching an [`Exclude`](../org/springframework/boot/maven/Exclude.html "class in org.springframework.boot.maven"). * [ExcludeFilter(List)](../org/springframework/boot/maven/ExcludeFilter.html#%3Cinit%3E\(java.util.List\)) - Constructor for class org.springframework.boot.maven.[ExcludeFilter](../org/springframework/boot/maven/ExcludeFilter.html "class in org.springframework.boot.maven")   * [ExcludeFilter(Exclude...)](../org/springframework/boot/maven/ExcludeFilter.html#%3Cinit%3E\(org.springframework.boot.maven.Exclude...\)) - Constructor for class org.springframework.boot.maven.[ExcludeFilter](../org/springframework/boot/maven/ExcludeFilter.html "class in org.springframework.boot.maven")   * [execute()](../org/springframework/boot/maven/AbstractAotMojo.html#execute\(\)) - Method in class org.springframework.boot.maven.[AbstractAotMojo](../org/springframework/boot/maven/AbstractAotMojo.html "class in org.springframework.boot.maven")   * [execute()](../org/springframework/boot/maven/AbstractRunMojo.html#execute\(\)) - Method in class org.springframework.boot.maven.[AbstractRunMojo](../org/springframework/boot/maven/AbstractRunMojo.html "class in org.springframework.boot.maven")   * [execute()](../org/springframework/boot/maven/BuildImageMojo.html#execute\(\)) - Method in class org.springframework.boot.maven.[BuildImageMojo](../org/springframework/boot/maven/BuildImageMojo.html "class in org.springframework.boot.maven")   * [execute()](../org/springframework/boot/maven/BuildInfoMojo.html#execute\(\)) - Method in class org.springframework.boot.maven.[BuildInfoMojo](../org/springframework/boot/maven/BuildInfoMojo.html "class in org.springframework.boot.maven")   * * [execute()](../org/springframework/boot/maven/HelpMojo.html#execute\(\)) - Method in class org.springframework.boot.maven.[HelpMojo](../org/springframework/boot/maven/HelpMojo.html "class in org.springframework.boot.maven") * [execute()](../org/springframework/boot/maven/RepackageMojo.html#execute\(\)) - Method in class org.springframework.boot.maven.[RepackageMojo](../org/springframework/boot/maven/RepackageMojo.html "class in org.springframework.boot.maven")   * [execute()](../org/springframework/boot/maven/StopMojo.html#execute\(\)) - Method in class org.springframework.boot.maven.[StopMojo](../org/springframework/boot/maven/StopMojo.html "class in org.springframework.boot.maven")   * [execute(long, int, Callable)](../org/springframework/boot/maven/StartMojo.html#execute\(long,int,java.util.concurrent.Callable\)) - Method in class org.springframework.boot.maven.[StartMojo](../org/springframework/boot/maven/StartMojo.html "class in org.springframework.boot.maven") Execute a task, retrying it on failure. * [executeAot()](../org/springframework/boot/maven/AbstractAotMojo.html#executeAot\(\)) - Method in class org.springframework.boot.maven.[AbstractAotMojo](../org/springframework/boot/maven/AbstractAotMojo.html "class in org.springframework.boot.maven")   * [executeAot()](../org/springframework/boot/maven/ProcessAotMojo.html#executeAot\(\)) - Method in class org.springframework.boot.maven.[ProcessAotMojo](../org/springframework/boot/maven/ProcessAotMojo.html "class in org.springframework.boot.maven")   * [executeAot()](../org/springframework/boot/maven/ProcessTestAotMojo.html#executeAot\(\)) - Method in class org.springframework.boot.maven.[ProcessTestAotMojo](../org/springframework/boot/maven/ProcessTestAotMojo.html "class in org.springframework.boot.maven")   [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/class-use/DockerSpec.DockerRegistrySpec.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.bundling.DockerSpec.DockerRegistrySpec ============================================================================ Packages that use [DockerSpec.DockerRegistrySpec](../DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") Package Description [org.springframework.boot.gradle.tasks.bundling](#org.springframework.boot.gradle.tasks.bundling) Support for creating executable jars and wars. * ## Uses of [DockerSpec.DockerRegistrySpec](../DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) Methods in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) that return [DockerSpec.DockerRegistrySpec](../DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") Modifier and Type Method Description `DockerSpec.DockerRegistrySpec` DockerSpec.`getBuilderRegistry()` Returns the [`DockerSpec.DockerRegistrySpec`](../DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") that configures authentication to the builder registry. `DockerSpec.DockerRegistrySpec` DockerSpec.`getPublishRegistry()` Returns the [`DockerSpec.DockerRegistrySpec`](../DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") that configures authentication to the publishing registry. Method parameters in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) with type arguments of type [DockerSpec.DockerRegistrySpec](../DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") Modifier and Type Method Description `void` DockerSpec.`builderRegistry(Action action)` Customizes the [`DockerSpec.DockerRegistrySpec`](../DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") that configures authentication to the builder registry. `void` DockerSpec.`publishRegistry(Action action)` Customizes the [`DockerSpec.DockerRegistrySpec`](../DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") that configures authentication to the publishing registry. ---- url: https://docs.spring.io/spring-boot/how-to/deployment/installing.html ---- # Installing Spring Boot Applications In addition to running Spring Boot applications by using `java -jar` directly, it is also possible to run them as services. ## [](#howto.deployment.installing.system-d)Installation as a systemd Service `systemd` is the successor of the System V init system and is now being used by many modern Linux distributions. Spring Boot applications can be launched by using `systemd` ‘service’ scripts. Assuming that you have a Spring Boot application packaged as an uber jar in `/var/myapp`, to install it as a `systemd` service, create a script named `myapp.service` and place it in `/etc/systemd/system` directory. The following script offers an example: ```none [Unit] Description=myapp After=syslog.target network.target [Service] User=myapp Group=myapp Type=exec ExecStart=/path/to/java/home/bin/java -jar /var/myapp/myapp.jar WorkingDirectory=/var/myapp SuccessExitStatus=143 [Install] WantedBy=multi-user.target ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------- | | ** | Remember to change the `Description`, `User`, `Group`, `ExecStart` and `WorkingDirectory` fields for your application. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------ | | ** | The `ExecStart` field does not declare the script action command, which means that the `run` command is used by default. | The user that runs the application, the PID file, and the console log file are managed by `systemd` itself and therefore must be configured by using appropriate fields in the ‘service’ script. Consult the [service unit configuration man page](https://www.freedesktop.org/software/systemd/man/systemd.service.html) for more details. To flag the application to start automatically on system boot, use the following command: ```shell $ systemctl enable myapp.service ``` Run `man systemctl` for more details. ## [](#howto.deployment.installing.windows-services)Microsoft Windows Services A Spring Boot application can be started as a Windows service by using [`winsw`](https://github.com/kohsuke/winsw). A ([separately maintained sample](https://github.com/snicoll/spring-boot-daemon)) describes step-by-step how you can create a Windows service for your Spring Boot application. * [Spring Boot](../../index.html) * [4.1.1](installing.html) * [4.0.8](../../4.0/how-to/deployment/installing.html) * [3.5.16](../../3.5/how-to/deployment/installing.html) * [3.4.13](../../3.4/how-to/deployment/installing.html) * [3.3.13](../../3.3/how-to/deployment/installing.html) - [4.2.0-M2](../../4.2/how-to/deployment/installing.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/how-to/deployment/installing.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/how-to/deployment/installing.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/how-to/deployment/installing.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/how-to/aot-cache.html ---- # AOT Cache This section includes information about using AOT cache with Spring Boot applications. For an overview of Spring Boot support for AOT cache, see [AOT Cache](../reference/packaging/aot-cache.html). ## [](#howto.aot-cache.buildpacks)Packaging an Application Using AOT Cache and Buildpacks Spring Boot’s [support for Cloud Native Buildpacks](../reference/packaging/container-images/cloud-native-buildpacks.html) along with the [Paketo Java buildpack](https://paketo.io/docs/reference/java-reference) and its [Spring Boot support](https://paketo.io/docs/reference/java-reference/#spring-boot-applications) can be used to generate a Docker image containing an AOT Cache-optimized application. To enable the AOT Cache in a generated Docker image, you have to use Java 25 or later, and the buildpack environment variable `BP_JVM_AOTCACHE_ENABLED` should be set to `true` when building the image as described in the [Maven plugin](../maven-plugin/build-image.html#build-image.examples.builder-configuration) and [Gradle plugin](../gradle-plugin/packaging-oci-image.html#build-image.examples.builder-configuration) documentation. This will cause the buildpack to do a training run of the application, save the AOT Cache in the image, and use the AOT Cache when launching the application. The Paketo Buildpack for Spring Boot [documentation](https://github.com/paketo-buildpacks/spring-boot?tab=readme-ov-file#configuration) has information on other configuration options that can be enabled with builder environment variables, like `TRAINING_RUN_JAVA_TOOL_OPTIONS` that allows to override the default `JAVA_TOOL_OPTIONS`, only for the AOT Cache training run. ## [](#howto.aot-cache.dockerfiles)Packaging an Application Using AOT Cache and Dockerfiles If you don’t want to use Cloud Native Buildpacks, it is possible to use AOT cache (or CDS) with a `Dockerfile`. For more information about that, please see the [Dockerfiles reference documentation](../reference/packaging/container-images/dockerfiles.html#packaging.container-images.dockerfiles.aot-cache). ## [](#howto.aot-cache.training-run-configuration)Preventing Remote Services Interaction During the Training Run When performing the training run, it may be needed to customize the Spring Boot application configuration to prevent connections to remote services that may happen before the Spring lifecycle is started. This can typically happen with early database interactions and can be handled via related configuration that can be applied by default to your application (or specifically to the training run) to prevent such interactions, see [related documentation](https://github.com/spring-projects/spring-lifecycle-smoke-tests/blob/main/README.adoc#training-run-configuration). * [Spring Boot](../index.html) * [4.1.1](aot-cache.html) * [4.0.8](../4.0/how-to/aot-cache.html) * [3.5.16](../3.5/how-to/class-data-sharing.html) * [3.4.13](../3.4/how-to/class-data-sharing.html) * [3.3.13](../3.3/how-to/class-data-sharing.html) - [4.2.0-M2](../4.2/how-to/aot-cache.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/aot-cache.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/aot-cache.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/aot-cache.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/help-doc.html ---- # JavaDoc Help *** *** ## Kinds of Pages The following sections describe the different kinds of pages in this collection. ### Deprecated API The [Deprecated API](deprecated-list.html) page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to shortcomings, and a replacement API is usually given. Deprecated APIs may be removed in future implementations. *** ## Release Details The details for each module, package, class or interface normally include the release in which the declaration was introduced. When a member is added after the initial introduction of the enclosing class or interface, the details of the member include the release in which it was introduced. Some summary pages (New API, Deprecated) allow you to filter the contents of the page according to the release in which the declaration was introduced or deprecated. *** This help file applies to API documentation generated by the standard doclet. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html ---- # Enum Class AbstractPackagerMojo.LayoutType [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") [java.lang.Enum](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html "class or interface in java.lang")<[AbstractPackagerMojo.LayoutType](AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven")> org.springframework.boot.maven.AbstractPackagerMojo.LayoutType * All Implemented Interfaces: `Serializable, Comparable, Constable` - Enclosing class: `AbstractPackagerMojo` *** public static enum AbstractPackagerMojo.LayoutType extends [Enum](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html "class or interface in java.lang")<[AbstractPackagerMojo.LayoutType](AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven")> Archive layout types. * Since: 2.3.0 * Author: Phillip Webb, Scott Frederick, Moritz Halbritter `DIR` Directory Layout. `JAR` Jar Layout. `NONE` No Layout. `WAR` War Layout. `ZIP` Zip Layout. - ## Method Summary Modifier and Type Method Description `org.springframework.boot.loader.tools.Layout` `layout()`   `static AbstractPackagerMojo.LayoutType` `valueOf(String name)` Returns the enum constant of this class with the specified name. `static AbstractPackagerMojo.LayoutType[]` * ### JAR public static final [AbstractPackagerMojo.LayoutType](AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") JAR Jar Layout. * ### WAR public static final [AbstractPackagerMojo.LayoutType](AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") WAR War Layout. * ### ZIP public static final [AbstractPackagerMojo.LayoutType](AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") ZIP Zip Layout. * ### DIR public static final [AbstractPackagerMojo.LayoutType](AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") DIR Directory Layout. * ### NONE public static final [AbstractPackagerMojo.LayoutType](AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") NONE No Layout. * ## Method Details * ### values public static [AbstractPackagerMojo.LayoutType](AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven")\[] values() Returns an array containing the constants of this enum class, in the order they are declared. * Returns: an array containing the constants of this enum class, in the order they are declared * ### valueOf public static [AbstractPackagerMojo.LayoutType](AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") valueOf​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") name) Returns the enum constant of this class with the specified name. The string must match *exactly* an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.) * Parameters: `name` - the name of the enum constant to be returned. * Returns: the enum constant with the specified name * Throws: * `IllegalArgumentException` - if this enum class has no constant with the specified name * `NullPointerException` - if the argument is null * ### layout public org.springframework.boot.loader.tools.Layout layout() ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/util/package-summary.html ---- # Package org.springframework.boot.gradle.util *** @NullMarked package org.springframework.boot.gradle.util Shared utility classes. * Classes Class Description [VersionExtractor](VersionExtractor.html "class in org.springframework.boot.gradle.util") Extracts version information for a Class. ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/aot/AbstractAot.html ---- # Class AbstractAot [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.gradle.api.internal.AbstractTask [org.gradle.api.DefaultTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/DefaultTask.html "class or interface in org.gradle.api") org.gradle.api.internal.ConventionTask [org.gradle.api.tasks.JavaExec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") org.springframework.boot.gradle.tasks.aot.AbstractAot * All Implemented Interfaces: `Comparable, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Task, BaseExecSpec, JavaExecSpec, JavaForkOptions, ProcessForkOptions, Configurable` - Direct Known Subclasses: `ProcessAot, ProcessTestAot` *** [@DisableCachingByDefault](https://docs.gradle.org/9.7.0/javadoc/org/gradle/work/DisableCachingByDefault.html "class or interface in org.gradle.work")([because](https://docs.gradle.org/9.7.0/javadoc/org/gradle/work/DisableCachingByDefault.html#because\(\) "class or interface in org.gradle.work")="Cacheability can only be determined by a concrete implementation") public abstract class AbstractAot extends [JavaExec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") Specialization of [`JavaExec`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") to be used as a base class for tasks that perform ahead-of-time processing. * Since: 3.0.0 Modifier Constructor Description `protected` `AbstractAot()`   - ## Method Summary Modifier and Type Method Description `final Property` `getArtifactId()` The artifact ID of the application that is to be processed ahead-of-time. `final DirectoryProperty` `getClassesOutput()` The directory to which AOT-generated classes should be written. `final Property` `getGroupId()` The group ID of the application that is to be processed ahead-of-time. `final DirectoryProperty` `getResourcesOutput()` The directory to which AOT-generated resources should be written. `final DirectoryProperty` `getSourcesOutput()` The directory to which AOT-generated sources should be written. ### Methods inherited from class [JavaExec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html#method-summary "class or interface in org.gradle.api.tasks") `args, args, bootstrapClasspath, classpath, copyTo, copyTo, debugOptions, environment, environment, exec, executable, getAllJvmArgs, getArgs, getArgumentProviders, getBootstrapClasspath, getClasspath, getCommandLine, getDebug, getDebugOptions, getDefaultCharacterEncoding, getEnableAssertions, getEnvironment, getErrorOutput, getExecActionFactory, getExecutable, getExecutionResult, getJavaLauncher, getJavaToolchainService, getJavaVersion, getJvmArgs, getJvmArgumentProviders, getJvmArguments, getMainClass, getMainModule, getMaxHeapSize, getMinHeapSize, getModularity, getObjectFactory, getPropertyFactory, getProviderFactory, getStandardInput, getStandardOutput, getSystemProperties, getWorkingDir, getWorkingDirectory, isIgnoreExitValue, jvmArgs, jvmArgs, setAllJvmArgs, setAllJvmArgs, setArgs, setArgs, setArgsString, setBootstrapClasspath, setClasspath, setDebug, setDefaultCharacterEncoding, setEnableAssertions, setEnvironment, setErrorOutput, setExecutable, setExecutable, setIgnoreExitValue, setJvmArgs, setJvmArgs, setMaxHeapSize, setMinHeapSize, setStandardInput, setStandardOutput, setSystemProperties, setWorkingDir, setWorkingDir, systemProperties, systemProperty, workingDir` * ### AbstractAot protected AbstractAot() * ## Method Details * ### getGroupId [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") public final [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getGroupId() The group ID of the application that is to be processed ahead-of-time. * Returns: the group ID property * ### getArtifactId [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") public final [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getArtifactId() The artifact ID of the application that is to be processed ahead-of-time. * Returns: the artifact ID property * ### getSourcesOutput [@OutputDirectory](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/OutputDirectory.html "class or interface in org.gradle.api.tasks") public final [DirectoryProperty](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/DirectoryProperty.html "class or interface in org.gradle.api.file") getSourcesOutput() The directory to which AOT-generated sources should be written. * Returns: the sources directory property * ### getResourcesOutput [@OutputDirectory](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/OutputDirectory.html "class or interface in org.gradle.api.tasks") public final [DirectoryProperty](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/DirectoryProperty.html "class or interface in org.gradle.api.file") getResourcesOutput() The directory to which AOT-generated resources should be written. * Returns: the resources directory property * ### getClassesOutput [@OutputDirectory](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/OutputDirectory.html "class or interface in org.gradle.api.tasks") public final [DirectoryProperty](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/DirectoryProperty.html "class or interface in org.gradle.api.file") getClassesOutput() The directory to which AOT-generated classes should be written. * Returns: the classes directory property ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/index-files/index-5.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ## E * [exclude(String...)](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayerSpec.html#exclude\(java.lang.String...\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.IntoLayerSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Adds patterns that control the content that is excluded from the layer. * [excludeProjectDependencies()](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesIntoLayerSpec.html#excludeProjectDependencies\(\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.DependenciesIntoLayerSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesIntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Configures the layer to exclude project dependencies. * [exec()](../org/springframework/boot/gradle/tasks/aot/ProcessAot.html#exec\(\)) - Method in class org.springframework.boot.gradle.tasks.aot.[ProcessAot](../org/springframework/boot/gradle/tasks/aot/ProcessAot.html "class in org.springframework.boot.gradle.tasks.aot")   * [exec()](../org/springframework/boot/gradle/tasks/aot/ProcessTestAot.html#exec\(\)) - Method in class org.springframework.boot.gradle.tasks.aot.[ProcessTestAot](../org/springframework/boot/gradle/tasks/aot/ProcessTestAot.html "class in org.springframework.boot.gradle.tasks.aot")   * [exec()](../org/springframework/boot/gradle/tasks/run/BootRun.html#exec\(\)) - Method in class org.springframework.boot.gradle.tasks.run.[BootRun](../org/springframework/boot/gradle/tasks/run/BootRun.html "class in org.springframework.boot.gradle.tasks.run")   [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/allpackages-index.html ---- # All Packages Package Summary Package Description [org.springframework.boot.maven](org/springframework/boot/maven/package-summary.html) Maven plugin for Spring Boot. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/CacheInfo.VolumeCacheInfo.html ---- Uses of Class\ org.springframework.boot.maven.CacheInfo.VolumeCacheInfo ======================================================== * ## Uses of [CacheInfo.VolumeCacheInfo](../CacheInfo.VolumeCacheInfo.html "class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Methods in [org.springframework.boot.maven](../package-summary.html) with parameters of type [CacheInfo.VolumeCacheInfo](../CacheInfo.VolumeCacheInfo.html "class in org.springframework.boot.maven") Modifier and Type Method Description `void` CacheInfo.`setVolume(CacheInfo.VolumeCacheInfo info)` ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html ---- # Class BootBuildImage [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.gradle.api.internal.AbstractTask [org.gradle.api.DefaultTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/DefaultTask.html "class or interface in org.gradle.api") org.springframework.boot.gradle.tasks.bundling.BootBuildImage * All Implemented Interfaces: `Comparable, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Task, Configurable` *** [@DisableCachingByDefault](https://docs.gradle.org/9.7.0/javadoc/org/gradle/work/DisableCachingByDefault.html "class or interface in org.gradle.work") public abstract class BootBuildImage extends [DefaultTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/DefaultTask.html "class or interface in org.gradle.api") A [`Task`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") for bundling an application into an OCI image using a [buildpack](https://buildpacks.io). * Since: 2.3.0 * Author: Andy Wilkinson, Scott Frederick, Rafael Ceccone, Jeroen Meijer, Julian Liebig `BootBuildImage()`   - ## Method Summary Modifier and Type Method Description `void` `buildCache(Action action)` Customizes the [`CacheSpec`](CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") for the build cache using the given `action`. `void` `buildWorkspace(Action action)` Customizes the [`CacheSpec`](CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") for the build temporary workspace using the given `action`. `void` `docker(Action action)` Configures the Docker connection using the given `action`. `abstract Property` `getApplicationDirectory()` Returns the directory that contains application content in the image. `abstract RegularFileProperty` `getArchiveFile()` Returns the property for the archive file from which the image will be built. `abstract ListProperty` `getBindings()` Returns the volume bindings that will be mounted to the container when building the image. `CacheSpec` `getBuildCache()` Returns the build cache that will be used when building the image. `abstract Property` `getBuilder()` Returns the builder that will be used to build the image. `abstract ListProperty` `getBuildpacks()` Returns the buildpacks that will be used when building the image. `CacheSpec` `getBuildWorkspace()` Returns the build temporary workspace that will be used when building the image. `abstract Property` `getCleanCache()` Returns whether caches should be cleaned before packaging. `abstract Property` `getCreatedDate()` Returns the date that will be used as the `Created` date of the image. `DockerSpec` `getDocker()` Returns the Docker configuration the builder will use. `abstract MapProperty` `getEnvironment()` Returns the environment that will be used when building the image. `abstract Property` `getImageName()` Returns the name of the image that will be built. `abstract Property` `getImagePlatform()` Returns the platform (os/architecture/variant) that will be used for all pulled images. `CacheSpec` `getLaunchCache()` Returns the launch cache that will be used when building the image. `abstract Property` `getNetwork()` Returns the network the build container will connect to. `abstract Property` `getPublish()` Whether the built image should be pushed to a registry. `Property` `getPullPolicy()` Returns image pull policy that will be used when building the image. `abstract Property` `getRunImage()` Returns the run image that will be included in the built image. `abstract ListProperty` `getSecurityOptions()` Returns the security options that will be applied to the builder container. `abstract ListProperty` `getTags()` Returns the tags that will be created for the built image. `abstract Property` `getTrustBuilder()` Whether to treat the builder as trusted. `abstract Property` `getVerboseLogging()` Whether verbose logging should be enabled while building the image. `void` `launchCache(Action action)` Customizes the [`CacheSpec`](CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") for the launch cache using the given `action`. `void` `setPullPolicy(String pullPolicy)` Sets image pull policy that will be used when building the image. * ### BootBuildImage public BootBuildImage() * ## Method Details * ### getArchiveFile [@InputFile](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/InputFile.html "class or interface in org.gradle.api.tasks") [@PathSensitive](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/PathSensitive.html "class or interface in org.gradle.api.tasks")([RELATIVE](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/PathSensitivity.html#RELATIVE "class or interface in org.gradle.api.tasks")) public abstract [RegularFileProperty](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/RegularFileProperty.html "class or interface in org.gradle.api.file") getArchiveFile() Returns the property for the archive file from which the image will be built. * Returns: the archive file property * ### getImageName [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getImageName() Returns the name of the image that will be built. When `null`, the name will be derived from the [`Project's`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Project.html "class or interface in org.gradle.api") [`name`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Project.html#getName\(\) "class or interface in org.gradle.api") and [`version`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Project.html#getVersion\(\) "class or interface in org.gradle.api"). * Returns: name of the image * ### getBuilder [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getBuilder() Returns the builder that will be used to build the image. When `null`, the default builder will be used. * Returns: the builder * ### getTrustBuilder [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[Boolean](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html "class or interface in java.lang")> getTrustBuilder() Whether to treat the builder as trusted. * Returns: whether to trust the builder * Since: 3.4.0 * ### getRunImage [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getRunImage() Returns the run image that will be included in the built image. When `null`, the run image bundled with the builder will be used. * Returns: the run image * ### getEnvironment [@Internal](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Internal.html "class or interface in org.gradle.api.tasks") public abstract [MapProperty](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/MapProperty.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang"),​[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getEnvironment() Returns the environment that will be used when building the image. * Returns: the environment * ### getCleanCache [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[Boolean](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html "class or interface in java.lang")> getCleanCache() Returns whether caches should be cleaned before packaging. * Returns: whether caches should be cleaned * Since: 3.0.0 * ### getVerboseLogging [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[Boolean](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html "class or interface in java.lang")> getVerboseLogging() Whether verbose logging should be enabled while building the image. * Returns: whether verbose logging should be enabled * Since: 3.0.0 * ### getPullPolicy [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")\ getPullPolicy() Returns image pull policy that will be used when building the image. * Returns: whether images should be pulled * ### setPullPolicy public void setPullPolicy​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") pullPolicy) Sets image pull policy that will be used when building the image. * Parameters: `pullPolicy` - the pull policy to use * ### getPublish [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[Boolean](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html "class or interface in java.lang")> getPublish() Whether the built image should be pushed to a registry. * Returns: whether the built image should be pushed * Since: 3.0.0 * ### getBuildpacks [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [ListProperty](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/ListProperty.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getBuildpacks() Returns the buildpacks that will be used when building the image. * Returns: the buildpack references * ### getBindings [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [ListProperty](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/ListProperty.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getBindings() Returns the volume bindings that will be mounted to the container when building the image. * Returns: the bindings * ### getTags [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [ListProperty](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/ListProperty.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getTags() Returns the tags that will be created for the built image. * Returns: the tags * ### getNetwork [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getNetwork() Returns the network the build container will connect to. * Returns: the network * ### getBuildWorkspace [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public [CacheSpec](CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") getBuildWorkspace() Returns the build temporary workspace that will be used when building the image. * Returns: the cache * Since: 3.2.0 * ### buildWorkspace public void buildWorkspace​([Action](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Action.html "class or interface in org.gradle.api")<[CacheSpec](CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling")> action) Customizes the [`CacheSpec`](CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") for the build temporary workspace using the given `action`. * Parameters: `action` - the action * Since: 3.2.0 * ### getBuildCache [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public [CacheSpec](CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") getBuildCache() Returns the build cache that will be used when building the image. * Returns: the cache * ### buildCache public void buildCache​([Action](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Action.html "class or interface in org.gradle.api")<[CacheSpec](CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling")> action) Customizes the [`CacheSpec`](CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") for the build cache using the given `action`. * Parameters: `action` - the action * ### getLaunchCache [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public [CacheSpec](CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") getLaunchCache() Returns the launch cache that will be used when building the image. * Returns: the cache * ### launchCache public void launchCache​([Action](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Action.html "class or interface in org.gradle.api")<[CacheSpec](CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling")> action) Customizes the [`CacheSpec`](CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") for the launch cache using the given `action`. * Parameters: `action` - the action * ### getCreatedDate [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getCreatedDate() Returns the date that will be used as the `Created` date of the image. When `null`, a fixed date that enables build reproducibility will be used. * Returns: the created date * ### getApplicationDirectory [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getApplicationDirectory() Returns the directory that contains application content in the image. When `null`, a default location will be used. * Returns: the application directory * ### getSecurityOptions [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [ListProperty](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/ListProperty.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getSecurityOptions() Returns the security options that will be applied to the builder container. * Returns: the security options * ### getImagePlatform [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getImagePlatform() Returns the platform (os/architecture/variant) that will be used for all pulled images. When `null`, the system will choose a platform based on the host operating system and architecture. * Returns: the image platform * ### getDocker public [DockerSpec](DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") getDocker() Returns the Docker configuration the builder will use. * Returns: docker configuration. * Since: 2.4.0 * ### docker public void docker​([Action](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Action.html "class or interface in org.gradle.api")<[DockerSpec](DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling")> action) Configures the Docker connection using the given `action`. * Parameters: `action` - the action to apply * Since: 2.4.0 ---- url: https://docs.spring.io/spring-boot/reference/io/index.html ---- # IO Most applications will need to deal with input and output concerns at some point. Spring Boot provides utilities and integrations with a range of technologies to help when you need IO capabilities. This section covers standard IO features such as caching and validation as well as more advanced topics such as batch, scheduling, and distributed transactions. We will also cover calling remote REST or SOAP services and sending email. * [Spring Boot](../../index.html) * [4.1.1](index.html) * [4.0.8](../../4.0/reference/io/index.html) * [3.5.16](../../3.5/reference/io/index.html) * [3.4.13](../../3.4/reference/io/index.html) * [3.3.13](../../3.3/reference/io/index.html) - [4.2.0-M2](../../4.2/reference/io/index.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/io/index.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/io/index.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/io/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/dsl/package-summary.html ---- # Package org.springframework.boot.gradle.dsl *** @NullMarked package org.springframework.boot.gradle.dsl Spring Boot Gradle DSL. * Classes Class Description [SpringBootExtension](SpringBootExtension.html "class in org.springframework.boot.gradle.dsl") Entry point to Spring Boot's Gradle DSL. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-2.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## B * [BindCacheInfo()](../org/springframework/boot/maven/CacheInfo.BindCacheInfo.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.maven.[CacheInfo.BindCacheInfo](../org/springframework/boot/maven/CacheInfo.BindCacheInfo.html "class in org.springframework.boot.maven")   * [BuildImageForkMojo](../org/springframework/boot/maven/BuildImageForkMojo.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Package an application into an OCI image using a buildpack, forking the lifecycle to make sure that `package` ran. * [BuildImageForkMojo(MavenProjectHelper)](../org/springframework/boot/maven/BuildImageForkMojo.html#%3Cinit%3E\(org.apache.maven.project.MavenProjectHelper\)) - Constructor for class org.springframework.boot.maven.[BuildImageForkMojo](../org/springframework/boot/maven/BuildImageForkMojo.html "class in org.springframework.boot.maven")   * [BuildImageMojo](../org/springframework/boot/maven/BuildImageMojo.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Package an application into an OCI image using a buildpack. * [BuildImageMojo(MavenProjectHelper)](../org/springframework/boot/maven/BuildImageMojo.html#%3Cinit%3E\(org.apache.maven.project.MavenProjectHelper\)) - Constructor for class org.springframework.boot.maven.[BuildImageMojo](../org/springframework/boot/maven/BuildImageMojo.html "class in org.springframework.boot.maven")   * [BuildImageNoForkMojo](../org/springframework/boot/maven/BuildImageNoForkMojo.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Package an application into an OCI image using a buildpack, but without forking the lifecycle. * [BuildImageNoForkMojo(MavenProjectHelper)](../org/springframework/boot/maven/BuildImageNoForkMojo.html#%3Cinit%3E\(org.apache.maven.project.MavenProjectHelper\)) - Constructor for class org.springframework.boot.maven.[BuildImageNoForkMojo](../org/springframework/boot/maven/BuildImageNoForkMojo.html "class in org.springframework.boot.maven")   * [BuildInfoMojo](../org/springframework/boot/maven/BuildInfoMojo.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Generate a `build-info.properties` file based on the content of the current `MavenProject`. * [BuildInfoMojo(BuildContext)](../org/springframework/boot/maven/BuildInfoMojo.html#%3Cinit%3E\(org.sonatype.plexus.build.incremental.BuildContext\)) - Constructor for class org.springframework.boot.maven.[BuildInfoMojo](../org/springframework/boot/maven/BuildInfoMojo.html "class in org.springframework.boot.maven")   [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/overview-tree.html ---- # Hierarchy For All Packages Package Hierarchies: * [org.springframework.boot.maven](org/springframework/boot/maven/package-tree.html) ## Class Hierarchy * java.lang.[Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") * org.springframework.boot.maven.[AbstractAotMojo.Errors](org/springframework/boot/maven/AbstractAotMojo.Errors.html "class in org.springframework.boot.maven") (implements javax.tools.[DiagnosticListener](https://docs.oracle.com/en/java/javase/17/docs/api/java.compiler/javax/tools/DiagnosticListener.html "class or interface in javax.tools")\) * org.apache.maven.shared.artifact.filter.collection.AbstractArtifactsFilter (implements org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter) * org.apache.maven.shared.artifact.filter.collection.AbstractArtifactFeatureFilter * org.springframework.boot.maven.[AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter](org/springframework/boot/maven/AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[MatchingGroupIdFilter](org/springframework/boot/maven/MatchingGroupIdFilter.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[DependencyFilter](org/springframework/boot/maven/DependencyFilter.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[ExcludeFilter](org/springframework/boot/maven/ExcludeFilter.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[IncludeFilter](org/springframework/boot/maven/IncludeFilter.html "class in org.springframework.boot.maven") * org.apache.maven.plugin.AbstractMojo (implements org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo) * org.springframework.boot.maven.[AbstractDependencyFilterMojo](org/springframework/boot/maven/AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[AbstractAotMojo](org/springframework/boot/maven/AbstractAotMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[ProcessAotMojo](org/springframework/boot/maven/ProcessAotMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[ProcessTestAotMojo](org/springframework/boot/maven/ProcessTestAotMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[AbstractPackagerMojo](org/springframework/boot/maven/AbstractPackagerMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[BuildImageMojo](org/springframework/boot/maven/BuildImageMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[BuildImageForkMojo](org/springframework/boot/maven/BuildImageForkMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[BuildImageNoForkMojo](org/springframework/boot/maven/BuildImageNoForkMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[RepackageMojo](org/springframework/boot/maven/RepackageMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[AbstractRunMojo](org/springframework/boot/maven/AbstractRunMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[RunMojo](org/springframework/boot/maven/RunMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[StartMojo](org/springframework/boot/maven/StartMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[TestRunMojo](org/springframework/boot/maven/TestRunMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[BuildInfoMojo](org/springframework/boot/maven/BuildInfoMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[HelpMojo](org/springframework/boot/maven/HelpMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[StopMojo](org/springframework/boot/maven/StopMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[ArtifactsLibraries](org/springframework/boot/maven/ArtifactsLibraries.html "class in org.springframework.boot.maven") (implements org.springframework.boot.loader.tools.Libraries) * org.springframework.boot.maven.[CacheInfo](org/springframework/boot/maven/CacheInfo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[CacheInfo.BindCacheInfo](org/springframework/boot/maven/CacheInfo.BindCacheInfo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[CacheInfo.VolumeCacheInfo](org/springframework/boot/maven/CacheInfo.VolumeCacheInfo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[Docker](org/springframework/boot/maven/Docker.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[Docker.DockerRegistry](org/springframework/boot/maven/Docker.DockerRegistry.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[FilterableDependency](org/springframework/boot/maven/FilterableDependency.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[Exclude](org/springframework/boot/maven/Exclude.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[Include](org/springframework/boot/maven/Include.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[Image](org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[Layers](org/springframework/boot/maven/Layers.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[PropertiesMergingResourceTransformer](org/springframework/boot/maven/PropertiesMergingResourceTransformer.html "class in org.springframework.boot.maven") (implements org.apache.maven.plugins.shade.resource.ReproducibleResourceTransformer) ## Enum Class Hierarchy * java.lang.[Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") * java.lang.[Enum](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html "class or interface in java.lang")\ (implements java.lang.[Comparable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html "class or interface in java.lang")\, java.lang.constant.[Constable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html "class or interface in java.lang.constant"), java.io.[Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io")) * org.springframework.boot.maven.[AbstractPackagerMojo.LayoutType](org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/PropertiesMergingResourceTransformer.html ---- Uses of Class\ org.springframework.boot.maven.PropertiesMergingResourceTransformer =================================================================== No usage of org.springframework.boot.maven.PropertiesMergingResourceTransformer ---- url: https://docs.spring.io/spring-boot/reference/using/configuration-classes.html ---- # Configuration Classes Spring Boot favors Java-based configuration. Although it is possible to use [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) with XML sources, we generally recommend that your primary source be a single [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class. Usually the class that defines the `main` method is a good candidate as the primary [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html). | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Many Spring configuration examples have been published on the Internet that use XML configuration. If possible, always try to use the equivalent Java-based configuration. Searching for `Enable*` annotations can be a good starting point. | ## [](#using.configuration-classes.importing-additional-configuration)Importing Additional Configuration Classes You need not put all your [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) into a single class. The [`@Import`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Import.html) annotation can be used to import additional configuration classes. Alternatively, you can use [`@ComponentScan`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/ComponentScan.html) to automatically pick up all Spring components, including [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) classes. ## [](#using.configuration-classes.importing-xml-configuration)Importing XML Configuration If you absolutely must use XML based configuration, we recommend that you still start with a [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class. You can then use an [`@ImportResource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/ImportResource.html) annotation to load XML configuration files. * [Spring Boot](../../index.html) * [4.1.1](configuration-classes.html) * [4.0.8](../../4.0/reference/using/configuration-classes.html) * [3.5.16](../../3.5/reference/using/configuration-classes.html) * [3.4.13](../../3.4/reference/using/configuration-classes.html) * [3.3.13](../../3.3/reference/using/configuration-classes.html) - [4.2.0-M2](../../4.2/reference/using/configuration-classes.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/using/configuration-classes.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/using/configuration-classes.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/using/configuration-classes.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/web/spring-graphql.html ---- # Spring for GraphQL If you want to build GraphQL applications, you can take advantage of Spring Boot’s auto-configuration for [Spring for GraphQL](https://spring.io/projects/spring-graphql). The Spring for GraphQL project is based on [GraphQL Java](https://github.com/graphql-java/graphql-java). You’ll need the `spring-boot-starter-graphql` starter at a minimum. Because GraphQL is transport-agnostic, you’ll also need to have one or more additional starters in your application to expose your GraphQL API over the web: | Starter | Transport | Implementation | | ------------------------------- | --------------- | ------------------------------- | | `spring-boot-starter-web` | HTTP | Spring MVC | | `spring-boot-starter-websocket` | WebSocket | WebSocket for Servlet apps | | `spring-boot-starter-webflux` | HTTP, WebSocket | Spring WebFlux | | `spring-boot-starter-rsocket` | TCP, WebSocket | Spring WebFlux on Reactor Netty | ## [](#web.graphql.schema)GraphQL Schema A Spring GraphQL application requires a defined schema at startup. By default, you can write ".graphqls" or ".gqls" schema files under `src/main/resources/graphql/**` and Spring Boot will pick them up automatically. You can customize the locations with `spring.graphql.schema.locations` and the file extensions with `spring.graphql.schema.file-extensions`. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you want Spring Boot to detect schema files in all your application modules and dependencies for that location, you can set `spring.graphql.schema.locations` to `"classpath*:graphql/**/"` (note the `classpath*:` prefix). | In the following sections, we’ll consider this sample GraphQL schema, defining two types and two queries: ```json type Query { greeting(name: String! = "Spring"): String! project(slug: ID!): Project } """ A Project in the Spring portfolio """ type Project { """ Unique string id used in URLs """ slug: ID! """ Project name """ name: String! """ URL of the git repository """ repositoryUrl: String! """ Current support status """ status: ProjectStatus! } enum ProjectStatus { """ Actively supported by the Spring team """ ACTIVE """ Supported by the community """ COMMUNITY """ Prototype, not officially supported yet """ INCUBATING """ Project being retired, in maintenance mode """ ATTIC """ End-Of-Lifed """ EOL } ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | By default, [field introspection](https://spec.graphql.org/draft/#sec-Introspection) will be allowed on the schema as it is required for tools such as GraphiQL. If you wish to not expose information about the schema, you can disable introspection by setting `spring.graphql.schema.introspection.enabled` to `false`. | ## [](#web.graphql.runtimewiring)GraphQL RuntimeWiring The GraphQL Java [`RuntimeWiring.Builder`](https://javadoc.io/doc/com.graphql-java/graphql-java/25.0/graphql/schema/idl/RuntimeWiring.Builder.html) can be used to register custom scalar types, directives, type resolvers, [`DataFetcher`](https://javadoc.io/doc/com.graphql-java/graphql-java/25.0/graphql/schema/DataFetcher.html), and more. You can declare [`RuntimeWiringConfigurer`](https://docs.spring.io/spring-graphql/docs/2.0.x/api/org/springframework/graphql/execution/RuntimeWiringConfigurer.html) beans in your Spring config to get access to the [`RuntimeWiring.Builder`](https://javadoc.io/doc/com.graphql-java/graphql-java/25.0/graphql/schema/idl/RuntimeWiring.Builder.html). Spring Boot detects such beans and adds them to the [GraphQlSource builder](https://docs.spring.io/spring-graphql/reference/2.0/request-execution.html#execution.graphqlsource). Typically, however, applications will not implement [`DataFetcher`](https://javadoc.io/doc/com.graphql-java/graphql-java/25.0/graphql/schema/DataFetcher.html) directly and will instead create [annotated controllers](https://docs.spring.io/spring-graphql/reference/2.0/controllers.html). Spring Boot will automatically detect [`@Controller`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Controller.html) classes with annotated handler methods and register those as `DataFetcher`s. Here’s a sample implementation for our greeting query with a [`@Controller`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Controller.html) class: * Java * Kotlin ```java import org.springframework.graphql.data.method.annotation.Argument; import org.springframework.graphql.data.method.annotation.QueryMapping; import org.springframework.stereotype.Controller; @Controller public class GreetingController { @QueryMapping public String greeting(@Argument String name) { return "Hello, " + name + "!"; } } ``` ```kotlin import org.springframework.graphql.data.method.annotation.Argument import org.springframework.graphql.data.method.annotation.QueryMapping import org.springframework.stereotype.Controller @Controller class GreetingController { @QueryMapping fun greeting(@Argument name: String): String { return "Hello, $name!" } } ``` ## [](#web.graphql.data-query)Querydsl and QueryByExample Repositories Support Spring Data offers support for both Querydsl and QueryByExample repositories. Spring GraphQL can [configure Querydsl and QueryByExample repositories as ](https://docs.spring.io/spring-graphql/reference/2.0/data.html)[`DataFetcher`](https://javadoc.io/doc/com.graphql-java/graphql-java/25.0/graphql/schema/DataFetcher.html). Spring Data repositories annotated with [`@GraphQlRepository`](https://docs.spring.io/spring-graphql/docs/2.0.x/api/org/springframework/graphql/data/GraphQlRepository.html) and extending one of: * [`QuerydslPredicateExecutor`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/querydsl/QuerydslPredicateExecutor.html) * [`ReactiveQuerydslPredicateExecutor`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/querydsl/ReactiveQuerydslPredicateExecutor.html) * [`QueryByExampleExecutor`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/query/QueryByExampleExecutor.html) * [`ReactiveQueryByExampleExecutor`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/query/ReactiveQueryByExampleExecutor.html) are detected by Spring Boot and considered as candidates for [`DataFetcher`](https://javadoc.io/doc/com.graphql-java/graphql-java/25.0/graphql/schema/DataFetcher.html) for matching top-level queries. ## [](#web.graphql.transports)Transports ### [](#web.graphql.transports.http-websocket)HTTP and WebSocket The GraphQL HTTP endpoint is at HTTP POST `/graphql` by default. It also supports the `"text/event-stream"` media type over Server Sent Events for subscriptions only. The path can be customized with `spring.graphql.http.path`. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The HTTP endpoint for both Spring MVC and Spring WebFlux is provided by a `RouterFunction` bean with an [`@Order`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/annotation/Order.html) of `0`. If you define your own `RouterFunction` beans, you may want to add appropriate [`@Order`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/annotation/Order.html) annotations to ensure that they are sorted correctly. | The GraphQL WebSocket endpoint is off by default. To enable it: * For a Servlet application, add the WebSocket starter `spring-boot-starter-websocket` * For a WebFlux application, no additional dependency is required * For both, the `spring.graphql.websocket.path` application property must be set Spring GraphQL provides a [Web Interception](https://docs.spring.io/spring-graphql/reference/2.0/transports.html#server.interception) model. This is quite useful for retrieving information from an HTTP request header and set it in the GraphQL context or fetching information from the same context and writing it to a response header. With Spring Boot, you can declare a [`WebGraphQlInterceptor`](https://docs.spring.io/spring-graphql/docs/2.0.x/api/org/springframework/graphql/server/WebGraphQlInterceptor.html) bean to have it registered with the web transport. [Spring MVC](https://docs.spring.io/spring-framework/reference/7.0/web/webmvc-cors.html) and [Spring WebFlux](https://docs.spring.io/spring-framework/reference/7.0/web/webflux-cors.html) support CORS (Cross-Origin Resource Sharing) requests. CORS is a critical part of the web config for GraphQL applications that are accessed from browsers using different domains. Spring Boot supports many configuration properties under the `spring.graphql.cors.*` namespace; here’s a short configuration sample: * Properties * YAML ```properties spring.graphql.cors.allowed-origins=https://example.org spring.graphql.cors.allowed-methods=GET,POST spring.graphql.cors.max-age=1800s ``` ```yaml spring: graphql: cors: allowed-origins: "https://example.org" allowed-methods: GET,POST max-age: 1800s ``` ### [](#web.graphql.transports.rsocket)RSocket RSocket is also supported as a transport, on top of WebSocket or TCP. Once the [RSocket server is configured](../messaging/rsocket.html#messaging.rsocket.server-auto-configuration), we can configure our GraphQL handler on a particular route using `spring.graphql.rsocket.mapping`. For example, configuring that mapping as `"graphql"` means we can use that as a route when sending requests with the [`RSocketGraphQlClient`](https://docs.spring.io/spring-graphql/docs/2.0.x/api/org/springframework/graphql/client/RSocketGraphQlClient.html). Spring Boot auto-configures a `RSocketGraphQlClient.Builder` bean that you can inject in your components: * Java * Kotlin ```java @Component public class RSocketGraphQlClientExample { private final RSocketGraphQlClient graphQlClient; public RSocketGraphQlClientExample(RSocketGraphQlClient.Builder builder) { this.graphQlClient = builder.tcp("example.spring.io", 8181).route("graphql").build(); } ``` ```kotlin @Component class RSocketGraphQlClientExample(private val builder: RSocketGraphQlClient.Builder<*>) { ``` And then send a request: include-code::RSocketGraphQlClientExample\[tag=request] ## [](#web.graphql.exception-handling)Exception Handling Spring GraphQL enables applications to register one or more Spring [`DataFetcherExceptionResolver`](https://docs.spring.io/spring-graphql/docs/2.0.x/api/org/springframework/graphql/execution/DataFetcherExceptionResolver.html) components that are invoked sequentially. The Exception must be resolved to a list of [`GraphQLError`](https://javadoc.io/doc/com.graphql-java/graphql-java/25.0/graphql/GraphQLError.html) objects, see [Spring GraphQL exception handling documentation](https://docs.spring.io/spring-graphql/reference/2.0/controllers.html#controllers.exception-handler). Spring Boot will automatically detect [`DataFetcherExceptionResolver`](https://docs.spring.io/spring-graphql/docs/2.0.x/api/org/springframework/graphql/execution/DataFetcherExceptionResolver.html) beans and register them with the [`GraphQlSource.Builder`](https://docs.spring.io/spring-graphql/docs/2.0.x/api/org/springframework/graphql/execution/GraphQlSource.Builder.html). ## [](#web.graphql.graphiql)GraphiQL and Schema Printer Spring GraphQL offers infrastructure for helping developers when consuming or developing a GraphQL API. Spring GraphQL ships with a default [GraphiQL](https://github.com/graphql/graphiql) page that is exposed at `"/graphiql"` by default. This page is disabled by default and can be turned on with the `spring.graphql.graphiql.enabled` property. Many applications exposing such a page will prefer a custom build. A default implementation is very useful during development, this is why it is exposed automatically with [`spring-boot-devtools`](../using/devtools.html) during development. You can also choose to expose the GraphQL schema in text format at `/graphql/schema` when the `spring.graphql.schema.printer.enabled` property is enabled. * [Spring Boot](../../index.html) * [4.1.1](spring-graphql.html) * [4.0.8](../../4.0/reference/web/spring-graphql.html) * [3.5.16](../../3.5/reference/web/spring-graphql.html) * [3.4.13](../../3.4/reference/web/spring-graphql.html) * [3.3.13](../../3.3/reference/web/spring-graphql.html) - [4.2.0-M2](../../4.2/reference/web/spring-graphql.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/web/spring-graphql.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/web/spring-graphql.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/web/spring-graphql.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/io/quartz.html ---- # Quartz Scheduler Spring Boot offers several conveniences for working with the [Quartz scheduler](https://www.quartz-scheduler.org/), including the `spring-boot-starter-quartz` starter. If Quartz is available, a [`Scheduler`](https://javadoc.io/doc/org.quartz-scheduler/quartz/2.5.2/org/quartz/Scheduler.html) is auto-configured (through the [`SchedulerFactoryBean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/quartz/SchedulerFactoryBean.html) abstraction). Beans of the following types are automatically picked up and associated with the [`Scheduler`](https://javadoc.io/doc/org.quartz-scheduler/quartz/2.5.2/org/quartz/Scheduler.html): * [`JobDetail`](https://javadoc.io/doc/org.quartz-scheduler/quartz/2.5.2/org/quartz/JobDetail.html): defines a particular Job. [`JobDetail`](https://javadoc.io/doc/org.quartz-scheduler/quartz/2.5.2/org/quartz/JobDetail.html) instances can be built with the [`JobBuilder`](https://javadoc.io/doc/org.quartz-scheduler/quartz/2.5.2/org/quartz/JobBuilder.html) API. * [`Calendar`](https://javadoc.io/doc/org.quartz-scheduler/quartz/2.5.2/org/quartz/Calendar.html). * [`Trigger`](https://javadoc.io/doc/org.quartz-scheduler/quartz/2.5.2/org/quartz/Trigger.html): defines when a particular job is triggered. By default, an in-memory [`JobStore`](https://javadoc.io/doc/org.quartz-scheduler/quartz/2.5.2/org/quartz/spi/JobStore.html) is used. However, it is possible to configure a JDBC-based store if a [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) bean is available in your application and if the `spring.quartz.job-store-type` property is configured accordingly, as shown in the following example: * Properties * YAML ```properties spring.quartz.job-store-type=jdbc ``` ```yaml spring: quartz: job-store-type: "jdbc" ``` When the JDBC store is used, the schema can be initialized on startup, as shown in the following example: * Properties * YAML ```properties spring.quartz.jdbc.initialize-schema=always ``` ```yaml spring: quartz: jdbc: initialize-schema: "always" ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | By default, the database is detected and initialized by using the standard scripts provided with the Quartz library. These scripts drop existing tables, deleting all triggers on every restart. To use a custom script, set the `spring.quartz.jdbc.schema` property. Some of the standard scripts – such as those for SQL Server, Azure SQL, and Sybase – cannot be used without modification. In these cases, make a copy of the script and edit it as directed in the script’s comments then set `spring.quartz.jdbc.schema` to use your customized script. | To have Quartz use a [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) other than the application’s main [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html), declare a [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) bean, annotating its [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) method with [`@QuartzDataSource`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/quartz/autoconfigure/QuartzDataSource.html). Doing so ensures that the Quartz-specific [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) is used by both the [`SchedulerFactoryBean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/quartz/SchedulerFactoryBean.html) and for schema initialization. Similarly, to have Quartz use a [`TransactionManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/transaction/TransactionManager.html) other than the application’s main [`TransactionManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/transaction/TransactionManager.html) declare a [`TransactionManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/transaction/TransactionManager.html) bean, annotating its [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) method with [`@QuartzTransactionManager`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/quartz/autoconfigure/QuartzTransactionManager.html). By default, jobs created by configuration will not overwrite already registered jobs that have been read from a persistent job store. To enable overwriting existing job definitions set the `spring.quartz.overwrite-existing-jobs` property. Quartz Scheduler configuration can be customized using `spring.quartz` properties and [`SchedulerFactoryBeanCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/quartz/autoconfigure/SchedulerFactoryBeanCustomizer.html) beans, which allow programmatic [`SchedulerFactoryBean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/quartz/SchedulerFactoryBean.html) customization. Advanced Quartz configuration properties can be customized using `spring.quartz.properties.*`. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | In particular, an [`Executor`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Executor.html) bean is not associated with the scheduler as Quartz offers a way to configure the scheduler through `spring.quartz.properties`. If you need to customize the task executor, consider implementing [`SchedulerFactoryBeanCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/quartz/autoconfigure/SchedulerFactoryBeanCustomizer.html). | Jobs can define setters to inject data map properties. Regular beans can also be injected in a similar manner, as shown in the following example: * Java * Kotlin ```java import org.quartz.JobExecutionContext; import org.quartz.JobExecutionException; import org.springframework.scheduling.quartz.QuartzJobBean; public class MySampleJob extends QuartzJobBean { // fields ... private MyService myService; private String name; // Inject "MyService" bean public void setMyService(MyService myService) { this.myService = myService; } // Inject the "name" job data property public void setName(String name) { this.name = name; } @Override protected void executeInternal(JobExecutionContext context) throws JobExecutionException { this.myService.someMethod(context.getFireTime(), this.name); } } ``` ```kotlin import org.quartz.JobExecutionContext import org.springframework.scheduling.quartz.QuartzJobBean class MySampleJob : QuartzJobBean() { // fields ... private var myService: MyService? = null private var name: String? = null // Inject "MyService" bean fun setMyService(myService: MyService?) { this.myService = myService } // Inject the "name" job data property fun setName(name: String?) { this.name = name } override fun executeInternal(context: JobExecutionContext) { myService!!.someMethod(context.fireTime, name) } } ``` * [Spring Boot](../../index.html) * [4.1.1](quartz.html) * [4.0.8](../../4.0/reference/io/quartz.html) * [3.5.16](../../3.5/reference/io/quartz.html) * [3.4.13](../../3.4/reference/io/quartz.html) * [3.3.13](../../3.3/reference/io/quartz.html) - [4.2.0-M2](../../4.2/reference/io/quartz.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/io/quartz.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/io/quartz.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/io/quartz.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/index-files/index-11.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ## P * [PROCESS\_AOT\_TASK\_NAME](../org/springframework/boot/gradle/plugin/SpringBootAotPlugin.html#PROCESS_AOT_TASK_NAME) - Static variable in class org.springframework.boot.gradle.plugin.[SpringBootAotPlugin](../org/springframework/boot/gradle/plugin/SpringBootAotPlugin.html "class in org.springframework.boot.gradle.plugin") Name of the default [`ProcessAot`](../org/springframework/boot/gradle/tasks/aot/ProcessAot.html "class in org.springframework.boot.gradle.tasks.aot") task. * [PROCESS\_TEST\_AOT\_TASK\_NAME](../org/springframework/boot/gradle/plugin/SpringBootAotPlugin.html#PROCESS_TEST_AOT_TASK_NAME) - Static variable in class org.springframework.boot.gradle.plugin.[SpringBootAotPlugin](../org/springframework/boot/gradle/plugin/SpringBootAotPlugin.html "class in org.springframework.boot.gradle.plugin") Name of the default [`ProcessAot`](../org/springframework/boot/gradle/tasks/aot/ProcessAot.html "class in org.springframework.boot.gradle.tasks.aot") task. * [ProcessAot](../org/springframework/boot/gradle/tasks/aot/ProcessAot.html "class in org.springframework.boot.gradle.tasks.aot") - Class in [org.springframework.boot.gradle.tasks.aot](../org/springframework/boot/gradle/tasks/aot/package-summary.html) Custom [`JavaExec`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") task for ahead-of-time processing of a Spring Boot application. * [ProcessAot()](../org/springframework/boot/gradle/tasks/aot/ProcessAot.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.gradle.tasks.aot.[ProcessAot](../org/springframework/boot/gradle/tasks/aot/ProcessAot.html "class in org.springframework.boot.gradle.tasks.aot")   * [ProcessTestAot](../org/springframework/boot/gradle/tasks/aot/ProcessTestAot.html "class in org.springframework.boot.gradle.tasks.aot") - Class in [org.springframework.boot.gradle.tasks.aot](../org/springframework/boot/gradle/tasks/aot/package-summary.html) Custom [`JavaExec`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") task for ahead-of-time processing of a Spring Boot application's tests. * [ProcessTestAot()](../org/springframework/boot/gradle/tasks/aot/ProcessTestAot.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.gradle.tasks.aot.[ProcessTestAot](../org/springframework/boot/gradle/tasks/aot/ProcessTestAot.html "class in org.springframework.boot.gradle.tasks.aot")   * [PRODUCTION\_RUNTIME\_CLASSPATH\_CONFIGURATION\_NAME](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html#PRODUCTION_RUNTIME_CLASSPATH_CONFIGURATION_NAME) - Static variable in class org.springframework.boot.gradle.plugin.[SpringBootPlugin](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html "class in org.springframework.boot.gradle.plugin") The name of the `productionRuntimeClasspath` configuration. * [properties(Action)](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html#properties\(org.gradle.api.Action\)) - Method in class org.springframework.boot.gradle.tasks.buildinfo.[BuildInfo](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") Executes the given `action` on the [`BuildInfo.getProperties()`](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html#getProperties\(\)) properties. * [providedClasspath(Object...)](../org/springframework/boot/gradle/tasks/bundling/BootWar.html#providedClasspath\(java.lang.Object...\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootWar](../org/springframework/boot/gradle/tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling") Adds files to the provided classpath to include in the `WEB-INF/lib-provided` directory of the war. * [publishRegistry(Action)](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html#publishRegistry\(org.gradle.api.Action\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[DockerSpec](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Customizes the [`DockerSpec.DockerRegistrySpec`](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") that configures authentication to the publishing registry. [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/BuildImageForkMojo.html ---- Uses of Class\ org.springframework.boot.maven.BuildImageForkMojo ================================================= No usage of org.springframework.boot.maven.BuildImageForkMojo ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/ArtifactsLibraries.html ---- Uses of Class\ org.springframework.boot.maven.ArtifactsLibraries ================================================= No usage of org.springframework.boot.maven.ArtifactsLibraries ---- url: https://docs.spring.io/spring-boot/reference/features/task-execution-and-scheduling.html ---- # Task Execution and Scheduling In the absence of an [`Executor`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Executor.html) bean in the context, Spring Boot auto-configures an [`AsyncTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/AsyncTaskExecutor.html). When virtual threads are enabled (using Java 21+ and `spring.threads.virtual.enabled` set to `true`) this will be a [`SimpleAsyncTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/SimpleAsyncTaskExecutor.html) that uses virtual threads. Otherwise, it will be a [`ThreadPoolTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/concurrent/ThreadPoolTaskExecutor.html) with sensible defaults. The auto-configured [`AsyncTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/AsyncTaskExecutor.html) is used for the following integrations unless a custom [`Executor`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Executor.html) bean is defined: * Execution of asynchronous tasks using [`@EnableAsync`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/annotation/EnableAsync.html), unless a bean of type [`AsyncConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/annotation/AsyncConfigurer.html) is defined. * Asynchronous handling of [`Callable`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Callable.html) return values from controller methods in Spring for GraphQL. * Asynchronous request handling in Spring MVC. * Support for blocking execution in Spring WebFlux. * Utilized for inbound and outbound message channels in Spring WebSocket. * Bootstrap executor for JPA, based on the bootstrap mode of JPA repositories. * Bootstrap executor for [background initialization](https://docs.spring.io/spring-framework/reference/7.0/core/beans/java/composing-configuration-classes.html#beans-java-startup-background) of beans in the `ApplicationContext`. While this approach works in most scenarios, Spring Boot allows you to override the auto-configured [`AsyncTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/AsyncTaskExecutor.html). By default, when a custom [`Executor`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Executor.html) bean is registered, the auto-configured [`AsyncTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/AsyncTaskExecutor.html) backs off, and the custom [`Executor`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Executor.html) is used for regular task execution (via [`@EnableAsync`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/annotation/EnableAsync.html)). However, Spring MVC, Spring WebFlux, and Spring GraphQL all require a bean named `applicationTaskExecutor`. For Spring MVC and Spring WebFlux, this bean must be of type [`AsyncTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/AsyncTaskExecutor.html), whereas Spring GraphQL does not enforce this type requirement. Spring WebSocket and JPA will use [`AsyncTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/AsyncTaskExecutor.html) if either a single bean of this type is available or a bean named `applicationTaskExecutor` is defined. Finally, the boostrap executor of the `ApplicationContext` uses a bean named `applicationTaskExecutor` unless a bean named `bootstrapExecutor` is defined. The following code snippet demonstrates how to register a custom [`AsyncTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/AsyncTaskExecutor.html) to be used with Spring MVC, Spring WebFlux, Spring GraphQL, Spring WebSocket, JPA, and background initialization of beans. * Java * Kotlin ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.core.task.SimpleAsyncTaskExecutor; @Configuration(proxyBeanMethods = false) public class MyTaskExecutorConfiguration { @Bean("applicationTaskExecutor") SimpleAsyncTaskExecutor applicationTaskExecutor() { return new SimpleAsyncTaskExecutor("app-"); } } ``` ```kotlin import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.core.task.SimpleAsyncTaskExecutor @Configuration(proxyBeanMethods = false) class MyTaskExecutorConfiguration { @Bean("applicationTaskExecutor") fun applicationTaskExecutor(): SimpleAsyncTaskExecutor { return SimpleAsyncTaskExecutor("app-") } } ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The `applicationTaskExecutor` bean will also be used for regular task execution if there is no [`@Primary`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Primary.html) bean or a bean named `taskExecutor` of type [`Executor`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Executor.html) or [`AsyncConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/annotation/AsyncConfigurer.html) present in the application context. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If neither the auto-configured `AsyncTaskExecutor` nor the `applicationTaskExecutor` bean is defined, the application defaults to a bean named `taskExecutor` for regular task execution ([`@EnableAsync`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/annotation/EnableAsync.html)), following Spring Framework’s behavior. However, this bean will not be used for Spring MVC, Spring WebFlux, Spring GraphQL. It could, however, be used for Spring WebSocket or JPA if the bean’s type is [`AsyncTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/AsyncTaskExecutor.html). | If your application needs multiple `Executor` beans for different integrations, such as one for regular task execution with [`@EnableAsync`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/annotation/EnableAsync.html) and other for Spring MVC, Spring WebFlux, Spring WebSocket and JPA, you can configure them as follows. * Java * Kotlin ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.core.task.SimpleAsyncTaskExecutor; import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; @Configuration(proxyBeanMethods = false) public class MyTaskExecutorConfiguration { @Bean("applicationTaskExecutor") SimpleAsyncTaskExecutor applicationTaskExecutor() { return new SimpleAsyncTaskExecutor("app-"); } @Bean("taskExecutor") ThreadPoolTaskExecutor taskExecutor() { ThreadPoolTaskExecutor threadPoolTaskExecutor = new ThreadPoolTaskExecutor(); threadPoolTaskExecutor.setThreadNamePrefix("async-"); return threadPoolTaskExecutor; } } ``` ```kotlin import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.core.task.SimpleAsyncTaskExecutor import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor @Configuration(proxyBeanMethods = false) class MyTaskExecutorConfiguration { @Bean("applicationTaskExecutor") fun applicationTaskExecutor(): SimpleAsyncTaskExecutor { return SimpleAsyncTaskExecutor("app-") } @Bean("taskExecutor") fun taskExecutor(): ThreadPoolTaskExecutor { val threadPoolTaskExecutor = ThreadPoolTaskExecutor() threadPoolTaskExecutor.setThreadNamePrefix("async-") return threadPoolTaskExecutor } } ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The auto-configured [`ThreadPoolTaskExecutorBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/task/ThreadPoolTaskExecutorBuilder.html) or [`SimpleAsyncTaskExecutorBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/task/SimpleAsyncTaskExecutorBuilder.html) allow you to easily create instances of type [`AsyncTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/AsyncTaskExecutor.html) that replicate the default behavior of auto-configuration.- Java - Kotlin```java import org.springframework.boot.task.SimpleAsyncTaskExecutorBuilder; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.core.task.SimpleAsyncTaskExecutor; @Configuration(proxyBeanMethods = false) public class MyTaskExecutorConfiguration { @Bean SimpleAsyncTaskExecutor taskExecutor(SimpleAsyncTaskExecutorBuilder builder) { return builder.build(); } } ``````kotlin import org.springframework.boot.task.SimpleAsyncTaskExecutorBuilder import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.core.task.SimpleAsyncTaskExecutor @Configuration(proxyBeanMethods = false) class MyTaskExecutorConfiguration { @Bean fun taskExecutor(builder: SimpleAsyncTaskExecutorBuilder): SimpleAsyncTaskExecutor { return builder.build() } } ``` | If a `taskExecutor` named bean is not an option, you can mark your bean as [`@Primary`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Primary.html) or define an [`AsyncConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/annotation/AsyncConfigurer.html) bean to specify the `Executor` responsible for handling regular task execution with [`@EnableAsync`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/annotation/EnableAsync.html). The following example demonstrates how to achieve this. * Java * Kotlin ```java import java.util.concurrent.Executor; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.scheduling.annotation.AsyncConfigurer; @Configuration(proxyBeanMethods = false) public class MyTaskExecutorConfiguration { @Bean AsyncConfigurer asyncConfigurer(ExecutorService executorService) { return new AsyncConfigurer() { @Override public Executor getAsyncExecutor() { return executorService; } }; } @Bean ExecutorService executorService() { return Executors.newCachedThreadPool(); } } ``` ```kotlin import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.scheduling.annotation.AsyncConfigurer import java.util.concurrent.Executor import java.util.concurrent.ExecutorService import java.util.concurrent.Executors @Configuration(proxyBeanMethods = false) class MyTaskExecutorConfiguration { @Bean fun asyncConfigurer(executorService: ExecutorService): AsyncConfigurer { return object : AsyncConfigurer { override fun getAsyncExecutor(): Executor { return executorService } } } @Bean fun executorService(): ExecutorService { return Executors.newCachedThreadPool() } } ``` To register a custom [`Executor`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Executor.html) while keeping the auto-configured [`AsyncTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/AsyncTaskExecutor.html), you can create a custom [`Executor`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Executor.html) bean and set the `defaultCandidate=false` attribute in its [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) annotation, as demonstrated in the following example: * Java * Kotlin ```java import java.util.concurrent.Executors; import java.util.concurrent.ScheduledExecutorService; import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyTaskExecutorConfiguration { @Bean(defaultCandidate = false) @Qualifier("scheduledExecutorService") ScheduledExecutorService scheduledExecutorService() { return Executors.newSingleThreadScheduledExecutor(); } } ``` ```kotlin import org.springframework.beans.factory.annotation.Qualifier import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import java.util.concurrent.Executors import java.util.concurrent.ScheduledExecutorService @Configuration(proxyBeanMethods = false) class MyTaskExecutorConfiguration { @Bean(defaultCandidate = false) @Qualifier("scheduledExecutorService") fun scheduledExecutorService(): ScheduledExecutorService { return Executors.newSingleThreadScheduledExecutor() } } ``` In that case, you will be able to autowire your custom [`Executor`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Executor.html) into other components while retaining the auto-configured [`AsyncTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/AsyncTaskExecutor.html). However, remember to use the [`@Qualifier`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Qualifier.html) annotation alongside [`@Autowired`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Autowired.html). If this is not possible for you, you can request Spring Boot to auto-configure an [`AsyncTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/AsyncTaskExecutor.html) anyway, as follows: * Properties * YAML ```properties spring.task.execution.mode=force ``` ```yaml spring: task: execution: mode: force ``` The auto-configured [`AsyncTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/AsyncTaskExecutor.html) will be used automatically for all integrations, even if a custom [`Executor`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Executor.html) bean is registered, including those marked as [`@Primary`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Primary.html). These integrations include: * Asynchronous task execution ([`@EnableAsync`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/annotation/EnableAsync.html)), unless an [`AsyncConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/annotation/AsyncConfigurer.html) bean is present. * Spring for GraphQL’s asynchronous handling of [`Callable`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Callable.html) return values from controller methods. * Spring MVC’s asynchronous request processing. * Spring WebFlux’s blocking execution support. * Utilized for inbound and outbound message channels in Spring WebSocket. * Bootstrap executor for JPA, based on the bootstrap mode of JPA repositories. * Bootstrap executor for [background initialization](https://docs.spring.io/spring-framework/reference/7.0/core/beans/java/composing-configuration-classes.html#beans-java-startup-background) of beans in the `ApplicationContext`, unless a bean named `bootstrapExecutor` is defined. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Depending on your target arrangement, you could set `spring.task.execution.mode` to `force` to auto-configure an `applicationTaskExecutor`, change your [`Executor`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Executor.html) into an [`AsyncTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/AsyncTaskExecutor.html) or define both an [`AsyncTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/AsyncTaskExecutor.html) and an [`AsyncConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/annotation/AsyncConfigurer.html) wrapping your custom [`Executor`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Executor.html). | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | When `force` mode is enabled, `applicationTaskExecutor` will also be configured for regular task execution with [`@EnableAsync`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/annotation/EnableAsync.html), even if a [`@Primary`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Primary.html) bean or a bean named `taskExecutor` of type [`Executor`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Executor.html) is present. The only way to override the `Executor` for regular tasks is by registering an [`AsyncConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/annotation/AsyncConfigurer.html) bean. | When a [`ThreadPoolTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/concurrent/ThreadPoolTaskExecutor.html) is auto-configured, the thread pool uses 8 core threads that can grow and shrink according to the load. Those default settings can be fine-tuned using the `spring.task.execution` namespace, as shown in the following example: * Properties * YAML ```properties spring.task.execution.pool.max-size=16 spring.task.execution.pool.queue-capacity=100 spring.task.execution.pool.keep-alive=10s ``` ```yaml spring: task: execution: pool: max-size: 16 queue-capacity: 100 keep-alive: "10s" ``` This changes the thread pool to use a bounded queue so that when the queue is full (100 tasks), the thread pool increases to maximum 16 threads. Shrinking of the pool is more aggressive as threads are reclaimed when they are idle for 10 seconds (rather than 60 seconds by default). A scheduler can also be auto-configured if it needs to be associated with scheduled task execution (using [`@EnableScheduling`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/annotation/EnableScheduling.html) for instance). If virtual threads are enabled (using Java 21+ and `spring.threads.virtual.enabled` set to `true`) this will be a [`SimpleAsyncTaskScheduler`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/concurrent/SimpleAsyncTaskScheduler.html) that uses virtual threads. This [`SimpleAsyncTaskScheduler`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/concurrent/SimpleAsyncTaskScheduler.html) will ignore any pooling related properties. If virtual threads are not enabled, it will be a [`ThreadPoolTaskScheduler`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/concurrent/ThreadPoolTaskScheduler.html) with sensible defaults. The [`ThreadPoolTaskScheduler`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/concurrent/ThreadPoolTaskScheduler.html) uses one thread by default and its settings can be fine-tuned using the `spring.task.scheduling` namespace, as shown in the following example: * Properties * YAML ```properties spring.task.scheduling.thread-name-prefix=scheduling- spring.task.scheduling.pool.size=2 ``` ```yaml spring: task: scheduling: thread-name-prefix: "scheduling-" pool: size: 2 ``` A [`ThreadPoolTaskExecutorBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/task/ThreadPoolTaskExecutorBuilder.html) bean, a [`SimpleAsyncTaskExecutorBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/task/SimpleAsyncTaskExecutorBuilder.html) bean, a [`ThreadPoolTaskSchedulerBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/task/ThreadPoolTaskSchedulerBuilder.html) bean and a [`SimpleAsyncTaskSchedulerBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/task/SimpleAsyncTaskSchedulerBuilder.html) are made available in the context if a custom executor or scheduler needs to be created. The [`SimpleAsyncTaskExecutorBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/task/SimpleAsyncTaskExecutorBuilder.html) and [`SimpleAsyncTaskSchedulerBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/task/SimpleAsyncTaskSchedulerBuilder.html) beans are auto-configured to use virtual threads if they are enabled (using Java 21+ and `spring.threads.virtual.enabled` set to `true`). * [Spring Boot](../../index.html) * [4.1.1](task-execution-and-scheduling.html) * [4.0.8](../../4.0/reference/features/task-execution-and-scheduling.html) * [3.5.16](../../3.5/reference/features/task-execution-and-scheduling.html) * [3.4.13](../../3.4/reference/features/task-execution-and-scheduling.html) * [3.3.13](../../3.3/reference/features/task-execution-and-scheduling.html) - [4.2.0-M2](../../4.2/reference/features/task-execution-and-scheduling.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/features/task-execution-and-scheduling.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/features/task-execution-and-scheduling.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/features/task-execution-and-scheduling.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/aot/package-summary.html ---- # Package org.springframework.boot.gradle.tasks.aot *** @NullMarked package org.springframework.boot.gradle.tasks.aot Support for ahead-of-time processing of an application built with Gradle. * Classes Class Description [AbstractAot](AbstractAot.html "class in org.springframework.boot.gradle.tasks.aot") Specialization of [`JavaExec`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") to be used as a base class for tasks that perform ahead-of-time processing. [ProcessAot](ProcessAot.html "class in org.springframework.boot.gradle.tasks.aot") Custom [`JavaExec`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") task for ahead-of-time processing of a Spring Boot application. [ProcessTestAot](ProcessTestAot.html "class in org.springframework.boot.gradle.tasks.aot") Custom [`JavaExec`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") task for ahead-of-time processing of a Spring Boot application's tests. ---- url: https://docs.spring.io/spring-boot/reference/web/spring-security.html ---- # Spring Security If [Spring Security](https://spring.io/projects/spring-security) is on the classpath, then web applications are secured by default. This includes securing Spring Boot’s `/error` endpoint. Spring Boot relies on Spring Security’s content-negotiation strategy to determine whether to use `httpBasic` or `formLogin`. To add method-level security to a web application, you can also add [`@EnableMethodSecurity`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/config/annotation/method/configuration/EnableMethodSecurity.html) with your desired settings. Additional information can be found in the [Spring Security Reference Guide](https://docs.spring.io/spring-security/reference/7.1/servlet/authorization/method-security.html). The default [`UserDetailsService`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/core/userdetails/UserDetailsService.html) has a single user. The user name is `user`, and the password is random and is printed at WARN level when the application starts, as shown in the following example: ```none Using generated security password: 78fa095d-3f4c-48b1-ad50-e24c31d5cf35 This generated password is for development use only. Your security configuration must be updated before running your application in production. ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | If you fine-tune your logging configuration, ensure that the `org.springframework.boot.security.autoconfigure` category is set to log `WARN`-level messages. Otherwise, the default password is not printed. | You can change the username and password by providing a `spring.security.user.name` and `spring.security.user.password`. The basic features you get by default in a web application are: * A [`UserDetailsService`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/core/userdetails/UserDetailsService.html) (or [`ReactiveUserDetailsService`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/core/userdetails/ReactiveUserDetailsService.html) in case of a WebFlux application) bean with in-memory store and a single user with a generated password (see [`SecurityProperties.User`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/security/autoconfigure/SecurityProperties.User.html) for the properties of the user). * Form-based login or HTTP Basic security (depending on the `Accept` header in the request) for the entire application (including actuator endpoints if actuator is on the classpath). * A [`DefaultAuthenticationEventPublisher`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/authentication/DefaultAuthenticationEventPublisher.html) for publishing authentication events. You can provide a different [`AuthenticationEventPublisher`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/authentication/AuthenticationEventPublisher.html) by adding a bean for it. ## [](#web.security.spring-mvc)MVC Security The default security configuration is implemented in [`SecurityAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/security/autoconfigure/SecurityAutoConfiguration.html) and [`UserDetailsServiceAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/security/autoconfigure/UserDetailsServiceAutoConfiguration.html). [`SecurityAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/security/autoconfigure/SecurityAutoConfiguration.html) imports `SpringBootWebSecurityConfiguration` for web security and [`UserDetailsServiceAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/security/autoconfigure/UserDetailsServiceAutoConfiguration.html) for authentication. To completely switch off the default web application security configuration, including Actuator security, or to combine multiple Spring Security components such as OAuth2 Client and Resource Server, add a bean of type [`SecurityFilterChain`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/SecurityFilterChain.html) (doing so does not disable the [`UserDetailsService`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/core/userdetails/UserDetailsService.html) configuration). To also switch off the [`UserDetailsService`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/core/userdetails/UserDetailsService.html) configuration, add a bean of type [`UserDetailsService`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/core/userdetails/UserDetailsService.html), [`AuthenticationProvider`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/authentication/AuthenticationProvider.html), or [`AuthenticationManager`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/authentication/AuthenticationManager.html). The auto-configuration of a [`UserDetailsService`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/core/userdetails/UserDetailsService.html) will also back off when any of the following Spring Security modules is on the classpath: * `spring-security-oauth2-client` * `spring-security-oauth2-resource-server` * `spring-security-saml2-service-provider` To use [`UserDetailsService`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/core/userdetails/UserDetailsService.html) in addition to one or more of these dependencies, define your own [`InMemoryUserDetailsManager`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/provisioning/InMemoryUserDetailsManager.html) bean. Access rules can be overridden by adding a custom [`SecurityFilterChain`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/SecurityFilterChain.html) bean. Spring Boot provides convenience methods that can be used to override access rules for actuator endpoints and static resources. [`EndpointRequest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/security/autoconfigure/actuate/web/servlet/EndpointRequest.html) can be used to create a [`RequestMatcher`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/util/matcher/RequestMatcher.html) that is based on the `management.endpoints.web.base-path` property. [`PathRequest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/security/autoconfigure/web/servlet/PathRequest.html) can be used to create a [`RequestMatcher`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/util/matcher/RequestMatcher.html) for resources in commonly used locations. ## [](#web.security.spring-webflux)WebFlux Security Similar to Spring MVC applications, you can secure your WebFlux applications by adding the `spring-boot-starter-security` dependency. The default security configuration is implemented in [`ReactiveWebSecurityAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/security/autoconfigure/web/reactive/ReactiveWebSecurityAutoConfiguration.html) and [`ReactiveUserDetailsServiceAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/security/autoconfigure/ReactiveUserDetailsServiceAutoConfiguration.html). In addition to reactive web applications, the latter is also auto-configured when RSocket is in use. [`ReactiveWebSecurityAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/security/autoconfigure/web/reactive/ReactiveWebSecurityAutoConfiguration.html) imports `WebFluxSecurityConfiguration` for web security. [`ReactiveUserDetailsServiceAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/security/autoconfigure/ReactiveUserDetailsServiceAutoConfiguration.html) auto-configures authentication. To completely switch off the default web application security configuration, including Actuator security, add a bean of type [`WebFilterChainProxy`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/server/WebFilterChainProxy.html) (doing so does not disable the [`ReactiveUserDetailsService`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/core/userdetails/ReactiveUserDetailsService.html) configuration). To also switch off the [`ReactiveUserDetailsService`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/core/userdetails/ReactiveUserDetailsService.html) configuration, add a bean of type [`ReactiveUserDetailsService`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/core/userdetails/ReactiveUserDetailsService.html) or [`ReactiveAuthenticationManager`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/authentication/ReactiveAuthenticationManager.html). The auto-configuration will also back off when any of the following Spring Security modules is on the classpath: * `spring-security-oauth2-client` * `spring-security-oauth2-resource-server` To use [`ReactiveUserDetailsService`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/core/userdetails/ReactiveUserDetailsService.html) in addition to one or more of these dependencies, define your own [`MapReactiveUserDetailsService`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/core/userdetails/MapReactiveUserDetailsService.html) bean. Access rules and the use of multiple Spring Security components such as OAuth 2 Client and Resource Server can be configured by adding a custom [`SecurityWebFilterChain`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/server/SecurityWebFilterChain.html) bean. Spring Boot provides convenience methods that can be used to override access rules for actuator endpoints and static resources. [`EndpointRequest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/security/autoconfigure/actuate/web/reactive/EndpointRequest.html) can be used to create a [`ServerWebExchangeMatcher`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/server/util/matcher/ServerWebExchangeMatcher.html) that is based on the `management.endpoints.web.base-path` property. [`PathRequest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/security/autoconfigure/web/reactive/PathRequest.html) can be used to create a [`ServerWebExchangeMatcher`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/server/util/matcher/ServerWebExchangeMatcher.html) for resources in commonly used locations. For example, you can customize your security configuration by adding something like: ```java import org.springframework.boot.security.autoconfigure.web.reactive.PathRequest; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.security.config.web.server.ServerHttpSecurity; import org.springframework.security.web.server.SecurityWebFilterChain; import static org.springframework.security.config.Customizer.withDefaults; @Configuration(proxyBeanMethods = false) public class MyWebFluxSecurityConfiguration { @Bean public SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) { http.authorizeExchange((exchange) -> { exchange.matchers(PathRequest.toStaticResources().atCommonLocations()).permitAll(); exchange.pathMatchers("/foo", "/bar").authenticated(); }); http.formLogin(withDefaults()); return http.build(); } } ``` ## [](#web.security.oauth2)[]()[]()[]()[]()OAuth2 [OAuth2](https://oauth.net/2/) is a widely used authorization framework. For details of how to configure and use OAuth2 with your web applications, see the [“OAuth2” section](../security/oauth2.html#security.oauth2) of under “Security”. ## [](#web.security.saml2)[]()[]()[]()[]()SAML 2.0 [SAML v2.0](https://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html) is a widely adopted framework for exchanging security information between online business partners. For details of how to configure and use SAML 2.0 with your web applications, see the [“SAML 2.0” section](../security/saml2.html#security.saml2) under “Security”. * [Spring Boot](../../index.html) * [4.1.1](spring-security.html) * [4.0.8](../../4.0/reference/web/spring-security.html) * [3.5.16](../../3.5/reference/web/spring-security.html) * [3.4.13](../../3.4/reference/web/spring-security.html) * [3.3.13](../../3.3/reference/web/spring-security.html) - [4.2.0-M2](../../4.2/reference/web/spring-security.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/web/spring-security.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/web/spring-security.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/web/spring-security.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/web/reactive.html ---- # Reactive Web Applications Spring Boot simplifies development of reactive web applications by providing auto-configuration for Spring Webflux. ## [](#web.reactive.webflux)The “Spring WebFlux Framework” Spring WebFlux is the new reactive web framework introduced in Spring Framework 5.0. Unlike Spring MVC, it does not require the servlet API, is fully asynchronous and non-blocking, and implements the [Reactive Streams](https://www.reactive-streams.org/) specification through [the Reactor project](https://projectreactor.io/). Spring WebFlux comes in two flavors: functional and annotation-based. The annotation-based one is quite close to the Spring MVC model, as shown in the following example: * Java * Kotlin ```java import reactor.core.publisher.Flux; import reactor.core.publisher.Mono; import org.springframework.web.bind.annotation.DeleteMapping; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController @RequestMapping("/users") public class MyRestController { private final UserRepository userRepository; private final CustomerRepository customerRepository; public MyRestController(UserRepository userRepository, CustomerRepository customerRepository) { this.userRepository = userRepository; this.customerRepository = customerRepository; } @GetMapping("/{userId}") public Mono getUser(@PathVariable Long userId) { return this.userRepository.findById(userId); } @GetMapping("/{userId}/customers") public Flux getUserCustomers(@PathVariable Long userId) { return this.userRepository.findById(userId).flatMapMany(this.customerRepository::findByUser); } @DeleteMapping("/{userId}") public Mono deleteUser(@PathVariable Long userId) { return this.userRepository.deleteById(userId); } } ``` ```kotlin import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController import reactor.core.publisher.Flux import reactor.core.publisher.Mono @RestController @RequestMapping("/users") class MyRestController(private val userRepository: UserRepository, private val customerRepository: CustomerRepository) { @GetMapping("/{userId}") fun getUser(@PathVariable userId: Long): Mono { return userRepository.findById(userId) } @GetMapping("/{userId}/customers") fun getUserCustomers(@PathVariable userId: Long): Flux { return userRepository.findById(userId).flatMapMany { user: User -> customerRepository.findByUser(user) } } @DeleteMapping("/{userId}") fun deleteUser(@PathVariable userId: Long): Mono { return userRepository.deleteById(userId) } } ``` WebFlux is part of the Spring Framework and detailed information is available in its [reference documentation](https://docs.spring.io/spring-framework/reference/7.0/web/webflux.html). “WebFlux.fn”, the functional variant, separates the routing configuration from the actual handling of the requests, as shown in the following example: * Java * Kotlin ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.http.MediaType; import org.springframework.web.reactive.function.server.RequestPredicate; import org.springframework.web.reactive.function.server.RouterFunction; import org.springframework.web.reactive.function.server.ServerResponse; import static org.springframework.web.reactive.function.server.RequestPredicates.accept; import static org.springframework.web.reactive.function.server.RouterFunctions.route; @Configuration(proxyBeanMethods = false) public class MyRoutingConfiguration { private static final RequestPredicate ACCEPT_JSON = accept(MediaType.APPLICATION_JSON); @Bean public RouterFunction monoRouterFunction(MyUserHandler userHandler) { return route() .GET("/{user}", ACCEPT_JSON, userHandler::getUser) .GET("/{user}/customers", ACCEPT_JSON, userHandler::getUserCustomers) .DELETE("/{user}", ACCEPT_JSON, userHandler::deleteUser) .build(); } } ``` ```kotlin import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.http.MediaType import org.springframework.web.reactive.function.server.RequestPredicates.DELETE import org.springframework.web.reactive.function.server.RequestPredicates.GET import org.springframework.web.reactive.function.server.RequestPredicates.accept import org.springframework.web.reactive.function.server.RouterFunction import org.springframework.web.reactive.function.server.RouterFunctions import org.springframework.web.reactive.function.server.ServerResponse @Configuration(proxyBeanMethods = false) class MyRoutingConfiguration { @Bean fun monoRouterFunction(userHandler: MyUserHandler): RouterFunction { return RouterFunctions.route( GET("/{user}").and(ACCEPT_JSON), userHandler::getUser).andRoute( GET("/{user}/customers").and(ACCEPT_JSON), userHandler::getUserCustomers).andRoute( DELETE("/{user}").and(ACCEPT_JSON), userHandler::deleteUser) } companion object { private val ACCEPT_JSON = accept(MediaType.APPLICATION_JSON) } } ``` * Java * Kotlin ```java import reactor.core.publisher.Mono; import org.springframework.stereotype.Component; import org.springframework.web.reactive.function.server.ServerRequest; import org.springframework.web.reactive.function.server.ServerResponse; @Component public class MyUserHandler { public Mono getUser(ServerRequest request) { ... } public Mono getUserCustomers(ServerRequest request) { ... } public Mono deleteUser(ServerRequest request) { ... } } ``` ```kotlin import org.springframework.stereotype.Component import org.springframework.web.reactive.function.server.ServerRequest import org.springframework.web.reactive.function.server.ServerResponse import reactor.core.publisher.Mono @Component class MyUserHandler { fun getUser(request: ServerRequest?): Mono { ... } fun getUserCustomers(request: ServerRequest?): Mono { ... } fun deleteUser(request: ServerRequest?): Mono { ... } } ``` “WebFlux.fn” is part of the Spring Framework and detailed information is available in its [reference documentation](https://docs.spring.io/spring-framework/reference/7.0/web/webflux-functional.html). | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can define as many [`RouterFunction`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/server/RouterFunction.html) beans as you like to modularize the definition of the router. Beans can be ordered if you need to apply a precedence. | To get started, add the `spring-boot-starter-webflux` module to your application. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Adding both `spring-boot-starter-web` and `spring-boot-starter-webflux` modules in your application results in Spring Boot auto-configuring Spring MVC, not WebFlux. This behavior has been chosen because many Spring developers add `spring-boot-starter-webflux` to their Spring MVC application to use the reactive [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html). You can still enforce your choice by setting the chosen application type to `SpringApplication.setWebApplicationType(WebApplicationType.REACTIVE)`. | ### [](#web.reactive.webflux.auto-configuration)Spring WebFlux Auto-configuration Spring Boot provides auto-configuration for Spring WebFlux that works well with most applications. The auto-configuration adds the following features on top of Spring’s defaults: * Configuring codecs for [`HttpMessageReader`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/codec/HttpMessageReader.html) and [`HttpMessageWriter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/codec/HttpMessageWriter.html) instances (described [later in this document](#web.reactive.webflux.httpcodecs)). * Support for serving static resources, including support for WebJars (described [later in this document](servlet.html#web.servlet.spring-mvc.static-content)). If you want to keep Spring Boot WebFlux features and you want to add additional [WebFlux configuration](https://docs.spring.io/spring-framework/reference/7.0/web/webflux/config.html), you can add your own [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class of type [`WebFluxConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/config/WebFluxConfigurer.html) but **without** [`@EnableWebFlux`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/config/EnableWebFlux.html). If you want to add additional customization to the auto-configured [`HttpHandler`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/server/reactive/HttpHandler.html), you can define beans of type [`WebHttpHandlerBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webflux/autoconfigure/WebHttpHandlerBuilderCustomizer.html) and use them to modify the [`WebHttpHandlerBuilder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/server/adapter/WebHttpHandlerBuilder.html). If you want to take complete control of Spring WebFlux, you can add your own [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) annotated with [`@EnableWebFlux`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/config/EnableWebFlux.html). ### [](#web.reactive.webflux.conversion-service)Spring WebFlux Conversion Service If you want to customize the [`ConversionService`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/convert/ConversionService.html) used by Spring WebFlux, you can provide a [`WebFluxConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/config/WebFluxConfigurer.html) bean with an `addFormatters` method. Conversion can also be customized using the `spring.webflux.format.*` configuration properties. When not configured, the following defaults are used: | Property | `DateTimeFormatter` | Formats | | --------------------------------- | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `spring.webflux.format.date` | `ofLocalizedDate(FormatStyle.SHORT)` | `java.util.Date` and [`LocalDate`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/LocalDate.html) | | `spring.webflux.format.time` | `ofLocalizedTime(FormatStyle.SHORT)` | java.time’s [`LocalTime`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/LocalTime.html) and [`OffsetTime`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/OffsetTime.html) | | `spring.webflux.format.date-time` | `ofLocalizedDateTime(FormatStyle.SHORT)` | java.time’s [`LocalDateTime`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/LocalDateTime.html), [`OffsetDateTime`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/OffsetDateTime.html), and [`ZonedDateTime`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/ZonedDateTime.html) | ### [](#web.reactive.webflux.httpcodecs)HTTP Codecs with HttpMessageReaders and HttpMessageWriters Spring WebFlux uses the [`HttpMessageReader`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/codec/HttpMessageReader.html) and [`HttpMessageWriter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/codec/HttpMessageWriter.html) interfaces to convert HTTP requests and responses. They are configured with [`CodecConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/codec/CodecConfigurer.html) to have sensible defaults by looking at the libraries available in your classpath. Spring Boot provides dedicated configuration properties for codecs, `spring.http.codecs.*`. It also applies further customization by using [`CodecCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/http/codec/CodecCustomizer.html) instances. For example, `spring.jackson.*` configuration keys are applied to the Jackson codec. If you need to add or customize codecs, you can create a custom [`CodecCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/http/codec/CodecCustomizer.html) component, as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.http.codec.CodecCustomizer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.http.codec.ServerSentEventHttpMessageReader; @Configuration(proxyBeanMethods = false) public class MyCodecsConfiguration { @Bean public CodecCustomizer myCodecCustomizer() { return (configurer) -> { configurer.registerDefaults(false); configurer.customCodecs().register(new ServerSentEventHttpMessageReader()); // ... }; } } ``` ```kotlin import org.springframework.boot.http.codec.CodecCustomizer import org.springframework.context.annotation.Bean import org.springframework.http.codec.CodecConfigurer import org.springframework.http.codec.ServerSentEventHttpMessageReader class MyCodecsConfiguration { @Bean fun myCodecCustomizer(): CodecCustomizer { return CodecCustomizer { configurer: CodecConfigurer -> configurer.registerDefaults(false) configurer.customCodecs().register(ServerSentEventHttpMessageReader()) } } } ``` You can also leverage [Boot’s custom JSON serializers and deserializers](../features/json.html#features.json.jackson.custom-serializers-and-deserializers). ### [](#web.reactive.webflux.static-content)Static Content By default, Spring Boot serves static content from a directory called `/static` (or `/public` or `/resources` or `/META-INF/resources`) in the classpath. It uses the [`ResourceWebHandler`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/resource/ResourceWebHandler.html) from Spring WebFlux so that you can modify that behavior by adding your own [`WebFluxConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/config/WebFluxConfigurer.html) and overriding the `addResourceHandlers` method. By default, resources are mapped on `/**`, but you can tune that by setting the `spring.webflux.static-path-pattern` property. For instance, relocating all resources to `/resources/**` can be achieved as follows: * Properties * YAML ```properties spring.webflux.static-path-pattern=/resources/** ``` ```yaml spring: webflux: static-path-pattern: "/resources/**" ``` You can also customize the static resource locations by using `spring.web.resources.static-locations`. Doing so replaces the default values with a list of directory locations. If you do so, the default welcome page detection switches to your custom locations. So, if there is an `index.html` in any of your locations on startup, it is the home page of the application. In addition to the “standard” static resource locations listed earlier, a special case is made for [Webjars content](https://www.webjars.org/). By default, any resources with a path in `/webjars/**` are served from jar files if they are packaged in the Webjars format. The path can be customized with the `spring.webflux.webjars-path-pattern` property. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Spring WebFlux applications do not strictly depend on the servlet API, so they cannot be deployed as war files and do not use the `src/main/webapp` directory. | ### [](#web.reactive.webflux.welcome-page)Welcome Page Spring Boot supports both static and templated welcome pages. It first looks for an `index.html` file in the configured static content locations. If one is not found, it then looks for an `index` template. If either is found, it is automatically used as the welcome page of the application. This only acts as a fallback for actual index routes defined by the application. The ordering is defined by the order of [`HandlerMapping`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/HandlerMapping.html) beans which is by default the following: | | | | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `org.springframework.web.reactive.function.server.support.RouterFunctionMapping` | Endpoints declared with [`RouterFunction`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/server/RouterFunction.html) beans | | `org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping` | Endpoints declared in [`@Controller`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Controller.html) beans | | `RouterFunctionMapping` for the Welcome Page | The welcome page support | ### [](#web.reactive.webflux.template-engines)Template Engines As well as REST web services, you can also use Spring WebFlux to serve dynamic HTML content. Spring WebFlux supports a variety of templating technologies, including Thymeleaf, FreeMarker, and Mustache. Spring Boot includes auto-configuration support for the following templating engines: * [FreeMarker](https://freemarker.apache.org/docs/) * [Thymeleaf](https://www.thymeleaf.org) * [Mustache](https://mustache.github.io/) | | | | -- | ----------------------------------------------------------------------------------------------------------------- | | ** | Not all FreeMarker features are supported with WebFlux. For more details, check the description of each property. | When you use one of these templating engines with the default configuration, your templates are picked up automatically from `src/main/resources/templates`. ### [](#web.reactive.webflux.error-handling)Error Handling Spring Boot provides a [`WebExceptionHandler`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/server/WebExceptionHandler.html) that handles all errors in a sensible way. Its position in the processing order is immediately before the handlers provided by WebFlux, which are considered last. For machine clients, it produces a JSON response with details of the error, the HTTP status, and the exception message. For browser clients, there is a “whitelabel” error handler that renders the same data in HTML format. You can also provide your own HTML templates to display errors (see the [next section](#web.reactive.webflux.error-handling.error-pages)). Before customizing error handling in Spring Boot directly, you can leverage the [RFC 9457 Problem Details](https://docs.spring.io/spring-framework/reference/7.0/web/webflux/ann-rest-exceptions.html) support in Spring WebFlux. Spring WebFlux can produce custom error messages with the `application/problem+json` media type, like: ```json { "type": "https://example.org/problems/unknown-project", "title": "Unknown project", "status": 404, "detail": "No project found for id 'spring-unknown'", "instance": "/projects/spring-unknown" } ``` This support can be enabled by setting `spring.webflux.problemdetails.enabled` to `true`. The first step to customizing this feature often involves using the existing mechanism but replacing or augmenting the error contents. For that, you can add a bean of type [`ErrorAttributes`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webflux/error/ErrorAttributes.html). To change the error handling behavior, you can implement [`ErrorWebExceptionHandler`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webflux/error/ErrorWebExceptionHandler.html) and register a bean definition of that type. Because an [`ErrorWebExceptionHandler`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webflux/error/ErrorWebExceptionHandler.html) is quite low-level, Spring Boot also provides a convenient [`AbstractErrorWebExceptionHandler`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webflux/autoconfigure/error/AbstractErrorWebExceptionHandler.html) to let you handle errors in a WebFlux functional way, as shown in the following example: * Java * Kotlin ```java import reactor.core.publisher.Mono; import org.springframework.boot.autoconfigure.web.WebProperties; import org.springframework.boot.webflux.autoconfigure.error.AbstractErrorWebExceptionHandler; import org.springframework.boot.webflux.error.ErrorAttributes; import org.springframework.context.ApplicationContext; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; import org.springframework.http.codec.ServerCodecConfigurer; import org.springframework.stereotype.Component; import org.springframework.web.reactive.function.server.RouterFunction; import org.springframework.web.reactive.function.server.RouterFunctions; import org.springframework.web.reactive.function.server.ServerRequest; import org.springframework.web.reactive.function.server.ServerResponse; import org.springframework.web.reactive.function.server.ServerResponse.BodyBuilder; @Component public class MyErrorWebExceptionHandler extends AbstractErrorWebExceptionHandler { public MyErrorWebExceptionHandler(ErrorAttributes errorAttributes, WebProperties webProperties, ApplicationContext applicationContext, ServerCodecConfigurer serverCodecConfigurer) { super(errorAttributes, webProperties.getResources(), applicationContext); setMessageReaders(serverCodecConfigurer.getReaders()); setMessageWriters(serverCodecConfigurer.getWriters()); } @Override protected RouterFunction getRoutingFunction(ErrorAttributes errorAttributes) { return RouterFunctions.route(this::acceptsXml, this::handleErrorAsXml); } private boolean acceptsXml(ServerRequest request) { return request.headers().accept().contains(MediaType.APPLICATION_XML); } public Mono handleErrorAsXml(ServerRequest request) { BodyBuilder builder = ServerResponse.status(HttpStatus.INTERNAL_SERVER_ERROR); // ... additional builder calls return builder.build(); } } ``` ```kotlin import org.springframework.boot.autoconfigure.web.WebProperties import org.springframework.boot.webflux.error.ErrorAttributes import org.springframework.boot.webflux.autoconfigure.error.AbstractErrorWebExceptionHandler import org.springframework.context.ApplicationContext import org.springframework.http.HttpStatus import org.springframework.http.MediaType import org.springframework.http.codec.ServerCodecConfigurer import org.springframework.stereotype.Component import org.springframework.web.reactive.function.server.RouterFunction import org.springframework.web.reactive.function.server.RouterFunctions import org.springframework.web.reactive.function.server.ServerRequest import org.springframework.web.reactive.function.server.ServerResponse import reactor.core.publisher.Mono @Component class MyErrorWebExceptionHandler( errorAttributes: ErrorAttributes, webProperties: WebProperties, applicationContext: ApplicationContext, serverCodecConfigurer: ServerCodecConfigurer ) : AbstractErrorWebExceptionHandler(errorAttributes, webProperties.resources, applicationContext) { init { setMessageReaders(serverCodecConfigurer.readers) setMessageWriters(serverCodecConfigurer.writers) } override fun getRoutingFunction(errorAttributes: ErrorAttributes): RouterFunction { return RouterFunctions.route(this::acceptsXml, this::handleErrorAsXml) } private fun acceptsXml(request: ServerRequest): Boolean { return request.headers().accept().contains(MediaType.APPLICATION_XML) } fun handleErrorAsXml(request: ServerRequest): Mono { val builder = ServerResponse.status(HttpStatus.INTERNAL_SERVER_ERROR) // ... additional builder calls return builder.build() } } ``` For a more complete picture, you can also subclass [`DefaultErrorWebExceptionHandler`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webflux/autoconfigure/error/DefaultErrorWebExceptionHandler.html) directly and override specific methods. In some cases, errors handled at the controller level are not recorded by web observations or the [metrics infrastructure](../actuator/metrics.html#actuator.metrics.supported.spring-webflux). Applications can ensure that such exceptions are recorded with the observations by [setting the handled exception on the observation context](https://docs.spring.io/spring-framework/reference/7.0/integration/observability.html#observability.http-server.reactive). #### [](#web.reactive.webflux.error-handling.error-pages)Custom Error Pages If you want to display a custom HTML error page for a given status code, you can add views that resolve from `error/*`, for example by adding files to a `/error` directory. Error pages can either be static HTML (that is, added under any of the static resource directories) or built with templates. The name of the file should be the exact status code, a status code series mask, or `error` for a default if nothing else matches. Note that the path to the default error view is `error/error`, whereas with Spring MVC the default error view is `error`. For example, to map `404` to a static HTML file, your directory structure would be as follows: ```none src/ +- main/ +- java/ | + +- resources/ +- public/ +- error/ | +- 404.html +- ``` To map all `5xx` errors by using a Mustache template, your directory structure would be as follows: ```none src/ +- main/ +- java/ | + +- resources/ +- templates/ +- error/ | +- 5xx.mustache +- ``` ### [](#web.reactive.webflux.web-filters)Web Filters Spring WebFlux provides a [`WebFilter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/server/WebFilter.html) interface that can be implemented to filter HTTP request-response exchanges. [`WebFilter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/server/WebFilter.html) beans found in the application context will be automatically used to filter each exchange. Where the order of the filters is important they can implement [`Ordered`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/Ordered.html) or be annotated with [`@Order`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/annotation/Order.html). Spring Boot auto-configuration may configure web filters for you. When it does so, the orders shown in the following table will be used: | Web Filter | Order | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | | [`WebFilterChainProxy`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/server/WebFilterChainProxy.html) (Spring Security) | `-100` | | [`HttpExchangesWebFilter`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webflux/actuate/web/exchanges/HttpExchangesWebFilter.html) | `Ordered.LOWEST_PRECEDENCE - 10` | ### [](#web.reactive.webflux.api-versioning)API Versioning Spring WebFlux supports API versioning which can be used to evolve an HTTP API over time. The same `@Controller` path can be mapped multiple times to support different versions of the API. For more details see [Spring Framework’s reference documentation](https://docs.spring.io/spring-framework/reference/7.0/web/webflux/controller/ann-requestmapping.html#webflux-ann-requestmapping-version). Once mappings have been added, you additionally need to configure Spring WebFlux so that it is able to use any version information sent with a request. Typically, versions are sent as HTTP headers, query parameters, media type parameters, or as part of the path. To configure Spring WebFlux, you can either use a [`WebFluxConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/config/WebFluxConfigurer.html) bean and override the `configureApiVersioning(…​)` method, or you can use properties. For example, the following will use an `X-Version` HTTP header to obtain version information and default to `1.0.0` when no header is sent. * Properties * YAML ```properties spring.webflux.apiversion.default=1.0.0 spring.webflux.apiversion.use.header=X-Version ``` ```yaml spring: webflux: apiversion: default: 1.0.0 use: header: X-Version ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If your setup requires multiple strategies, such as header and query parameter, consider declaring the order programmatically by overriding the `configureApiVersioning` method. | For more complete control, you can also define [`ApiVersionResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/accept/ApiVersionResolver.html), [`ApiVersionParser`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/accept/ApiVersionParser.html) and [`ApiVersionDeprecationHandler`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/accept/ApiVersionDeprecationHandler.html) beans which will be injected into the auto-configured Spring WebFlux configuration. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | API versioning is also supported on the client-side with both `WebClient` and `RestClient`. See [API Versioning](../io/rest-client.html#io.rest-client.apiversioning) for details. | ## [](#web.reactive.reactive-server)Embedded Reactive Server Support Spring Boot includes support for the following embedded reactive web servers: Reactor Netty, Tomcat, and Jetty. Most developers use the appropriate starter to obtain a fully configured instance. By default, the embedded server listens for HTTP requests on port 8080. ### [](#web.reactive.reactive-server.customizing)Customizing Reactive Servers Common reactive web server settings can be configured by using Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) properties. Usually, you would define the properties in your `application.properties` or `application.yaml` file. Common server settings include: * Network settings: Listen port for incoming HTTP requests (`server.port`), interface address to bind to (`server.address`), and so on. * Error management: Location of the error page (`spring.web.error.path`) and so on. * [SSL](../../how-to/webserver.html#howto.webserver.configure-ssl) * [HTTP compression](../../how-to/webserver.html#howto.webserver.enable-response-compression) Spring Boot tries as much as possible to expose common settings, but this is not always possible. For those cases, dedicated namespaces such as `server.netty.*` offer server-specific customizations. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | See the [`ServerProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/autoconfigure/ServerProperties.html) class for a complete list. | #### [](#web.reactive.reactive-server.customizing.programmatic)Programmatic Customization If you need to programmatically configure your reactive web server, you can register a Spring bean that implements the [`WebServerFactoryCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/WebServerFactoryCustomizer.html) interface. [`WebServerFactoryCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/WebServerFactoryCustomizer.html) provides access to the [`ConfigurableReactiveWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/reactive/ConfigurableReactiveWebServerFactory.html), which includes numerous customization setter methods. The following example shows programmatically setting the port: * Java * Kotlin ```java import org.springframework.boot.web.server.WebServerFactoryCustomizer; import org.springframework.boot.web.server.reactive.ConfigurableReactiveWebServerFactory; import org.springframework.stereotype.Component; @Component public class MyWebServerFactoryCustomizer implements WebServerFactoryCustomizer { @Override public void customize(ConfigurableReactiveWebServerFactory server) { server.setPort(9000); } } ``` ```kotlin import org.springframework.boot.web.server.WebServerFactoryCustomizer import org.springframework.boot.web.server.reactive.ConfigurableReactiveWebServerFactory import org.springframework.stereotype.Component @Component class MyWebServerFactoryCustomizer : WebServerFactoryCustomizer { override fun customize(server: ConfigurableReactiveWebServerFactory) { server.setPort(9000) } } ``` [`JettyReactiveWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jetty/reactive/JettyReactiveWebServerFactory.html), [`NettyReactiveWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/reactor/netty/NettyReactiveWebServerFactory.html), and [`TomcatReactiveWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/tomcat/reactive/TomcatReactiveWebServerFactory.html) are dedicated variants of [`ConfigurableReactiveWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/reactive/ConfigurableReactiveWebServerFactory.html) that have additional customization setter methods for Jetty, Reactor Netty, and Tomcat respectively. The following example shows how to customize [`NettyReactiveWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/reactor/netty/NettyReactiveWebServerFactory.html) that provides access to Reactor Netty-specific configuration options: * Java * Kotlin ```java import java.time.Duration; import org.springframework.boot.reactor.netty.NettyReactiveWebServerFactory; import org.springframework.boot.web.server.WebServerFactoryCustomizer; import org.springframework.stereotype.Component; @Component public class MyNettyWebServerFactoryCustomizer implements WebServerFactoryCustomizer { @Override public void customize(NettyReactiveWebServerFactory factory) { factory.addServerCustomizers((server) -> server.idleTimeout(Duration.ofSeconds(20))); } } ``` ```kotlin import org.springframework.boot.web.server.WebServerFactoryCustomizer import org.springframework.boot.reactor.netty.NettyReactiveWebServerFactory import org.springframework.stereotype.Component import java.time.Duration @Component class MyNettyWebServerFactoryCustomizer : WebServerFactoryCustomizer { override fun customize(factory: NettyReactiveWebServerFactory) { factory.addServerCustomizers({ server -> server.idleTimeout(Duration.ofSeconds(20)) }) } } ``` #### [](#web.reactive.reactive-server.customizing.direct)Customizing ConfigurableReactiveWebServerFactory Directly For more advanced use cases that require you to extend from [`ReactiveWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/reactive/ReactiveWebServerFactory.html), you can expose a bean of such type yourself. Setters are provided for many configuration options. Several protected method “hooks” are also provided should you need to do something more exotic. See the [`ConfigurableReactiveWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/reactive/ConfigurableReactiveWebServerFactory.html) API documentation for details. | | | | -- | --------------------------------------------------------------------------------------------------- | | ** | Auto-configured customizers are still applied on your custom factory, so use that option carefully. | ## [](#web.reactive.reactive-server-resources-configuration)Reactive Server Resources Configuration When auto-configuring a Reactor Netty or Jetty server, Spring Boot will create specific beans that will provide HTTP resources to the server instance: [`ReactorResourceFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/client/ReactorResourceFactory.html) or [`JettyResourceFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/client/reactive/JettyResourceFactory.html). By default, those resources will be also shared with the Reactor Netty and Jetty clients for optimal performances, given: * the same technology is used for server and client * the client instance is built using the [`WebClient.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.Builder.html) bean auto-configured by Spring Boot Developers can override the resource configuration for Jetty and Reactor Netty by providing a custom [`ReactorResourceFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/client/ReactorResourceFactory.html) or [`JettyResourceFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/client/reactive/JettyResourceFactory.html) bean - this will be applied to both clients and servers. You can learn more about the resource configuration on the client side in the [WebClient Runtime](../io/rest-client.html#io.rest-client.webclient.runtime) section. * [Spring Boot](../../index.html) * [4.1.1](reactive.html) * [4.0.8](../../4.0/reference/web/reactive.html) * [3.5.16](../../3.5/reference/web/reactive.html) * [3.4.13](../../3.4/reference/web/reactive.html) * [3.3.13](../../3.3/reference/web/reactive.html) - [4.2.0-M2](../../4.2/reference/web/reactive.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/web/reactive.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/web/reactive.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/web/reactive.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/how-to/spring-mvc.html ---- # Spring MVC Spring Boot has a number of starters that include Spring MVC. Note that some starters include a dependency on Spring MVC rather than include it directly. This section answers common questions about Spring MVC and Spring Boot. ## [](#howto.spring-mvc.write-json-rest-service)Write a JSON REST Service Any Spring [`@RestController`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/RestController.html) in a Spring Boot application should render JSON response by default as long as Jackson 3 is on the classpath, as shown in the following example: * Java * Kotlin ```java import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class MyController { @RequestMapping("/thing") public MyThing thing() { return new MyThing(); } } ``` ```kotlin import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController @RestController class MyController { @RequestMapping("/thing") fun thing(): MyThing { return MyThing() } } ``` As long as `MyThing` can be serialized by Jackson 3 (true for a normal POJO or Groovy object), then `localhost:8080/thing` serves a JSON representation of it by default. Note that, in a browser, you might sometimes see XML responses, because browsers tend to send accept headers that prefer XML. ## [](#howto.spring-mvc.write-xml-rest-service)Write an XML REST Service If you have the Jackson XML extension (`jackson-dataformat-xml`) on the classpath, you can use it to render XML responses. The previous example that we used for JSON would work. To use the Jackson XML renderer, add the following dependency to your project: ```xml tools.jackson.dataformat jackson-dataformat-xml ``` If Jackson’s XML extension is not available and JAXB is available, XML can be rendered with the additional requirement of having `MyThing` annotated as [`@XmlRootElement`](https://jakarta.ee/specifications/xml-binding/4.0/apidocs/jakarta.xml.bind/jakarta/xml/bind/annotation/XmlRootElement.html), as shown in the following example: * Java * Kotlin ```java import jakarta.xml.bind.annotation.XmlRootElement; @XmlRootElement public class MyThing { private String name; // getters/setters ... public String getName() { return this.name; } public void setName(String name) { this.name = name; } } ``` ```kotlin import jakarta.xml.bind.annotation.XmlRootElement @XmlRootElement class MyThing { var name: String? = null } ``` You will need to ensure that the JAXB library is part of your project, for example by adding: ```xml org.glassfish.jaxb jaxb-runtime ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------ | | ** | To get the server to render XML instead of JSON, you might have to send an `Accept: text/xml` header (or use a browser). | ## [](#howto.spring-mvc.customize-jackson-jsonmapper)Customize the Jackson JsonMapper You can configure the [`JsonMapper`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.html) by using the environment. Jackson provides an extensive suite of on/off features that can be used to configure various aspects of its processing. These features are described in several enums (in Jackson) that map onto properties in the environment: | Enum | Property | Values | | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------------------- | | [`DateTimeFeature`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/cfg/DateTimeFeature.html) | `spring.jackson.datatype.datetime.` | `true`, `false` | | [`EnumFeature`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/cfg/EnumFeature.html) | `spring.jackson.datatype.enum.` | `true`, `false` | | [`JsonNodeFeature`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/cfg/JsonNodeFeature.html) | `spring.jackson.datatype.json-node.` | `true`, `false` | | [`JsonInclude.Include`](https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-annotations/2.21/com/fasterxml/jackson/annotation/JsonInclude.Include.html) | `spring.jackson.default-property-inclusion` | `always`, `non_null`, `non_absent`, `non_default`, `non_empty` | | [`DeserializationFeature`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/DeserializationFeature.html) | `spring.jackson.deserialization.` | `true`, `false` | | [`JsonReadFeature`](https://javadoc.io/doc/tools.jackson.core/jackson-core/3.1.5/tools/jackson/core/json/JsonReadFeature.html) | `spring.jackson.json.read.` | `true`, `false` | | [`JsonWriteFeature`](https://javadoc.io/doc/tools.jackson.core/jackson-core/3.1.5/tools/jackson/core/json/JsonWriteFeature.html) | `spring.jackson.json.write.` | `true`, `false` | | [`MapperFeature`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/MapperFeature.html) | `spring.jackson.mapper.` | `true`, `false` | | [`SerializationFeature`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/SerializationFeature.html) | `spring.jackson.serialization.` | `true`, `false` | For example, to enable pretty print, set `spring.jackson.serialization.indent_output=true`. Note that, thanks to the use of [relaxed binding](../reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding), the case of `indent_output` does not have to match the case of the corresponding enum constant, which is `INDENT_OUTPUT`. This environment-based configuration is applied to the auto-configured [`JsonMapper.Builder`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.Builder.html) bean and applies to any mappers created by using the builder, including the auto-configured [`JsonMapper`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.html) bean. To ease the migration when working on an application that previously used Jackson 2, the auto-configured `JsonMapper` can be configured to use defaults that are as close as possible to those that Spring Boot used for Jackson 2. To enable these defaults, set `spring.jackson.use-jackson2-defaults` to `true`. The context’s [`JsonMapper.Builder`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.Builder.html) can be customized by one or more [`JsonMapperBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson/autoconfigure/JsonMapperBuilderCustomizer.html) beans. Such customizer beans can be ordered (Boot’s own customizer has an order of 0), letting additional customization be applied both before and after Boot’s customization. Furthermore, the `JsonFactory` used by the builder and the mapper that it creates can be customized by one or more [`JsonFactoryBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson/autoconfigure/JsonFactoryBuilderCustomizer.html) beans. Various `spring.jackson.factory` properties can also be used to configure the factory. Any beans of type [`JacksonModule`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/JacksonModule.html) are automatically registered with the auto-configured [`JsonMapper.Builder`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.Builder.html) and are applied to any [`JsonMapper`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.html) instances that it creates. This provides an application-wide mechanism for contributing custom modules when you add new features to your application. Any modules that participate in the Java `ServiceLoader` mechanism are, by default, found and added to the auto-configured [`JsonMapper.Builder`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.Builder.html). To disable this behavior, set `spring.jackson.find-and-add-modules` to `false`. If you want to replace the default [`JsonMapper`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.html) completely, either define a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) of that type or, if you prefer the builder-based approach, define a [`JsonMapper.Builder`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.Builder.html) [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html). When defining an [`JsonMapper`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.html) bean, marking it as [`@Primary`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Primary.html) is recommended as the auto-configuration’s [`JsonMapper`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.html) that it will replace is [`@Primary`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Primary.html). Note that, in either case, doing so disables all auto-configuration of the [`JsonMapper`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.html). If you provide any [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html)s of type [`JacksonJsonHttpMessageConverter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/converter/json/JacksonJsonHttpMessageConverter.html), they replace the default value in the MVC configuration. You can also declare [`ServerHttpMessageConvertersCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/http/converter/autoconfigure/ServerHttpMessageConvertersCustomizer.html) beans to add converters or to override a specific default converter, as described in [HttpMessageConverters](../reference/web/servlet.html#web.servlet.spring-mvc.message-converters). See the [Customize the @ResponseBody Rendering](#howto.spring-mvc.customize-responsebody-rendering) section and the [`WebMvcAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-webmvc/src/main/java/org/springframework/boot/webmvc/autoconfigure/WebMvcAutoConfiguration.java) source code for more details. ## [](#howto.spring-mvc.customize-responsebody-rendering)Customize the @ResponseBody Rendering Spring uses [`HttpMessageConverters`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/converter/HttpMessageConverters.html) to render [`@ResponseBody`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/ResponseBody.html) (or responses from [`@RestController`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/RestController.html)). You can contribute additional converters by adding beans of the appropriate type in a Spring Boot context. If a bean you add is of a type that would have been included by default anyway (such as [`JacksonJsonHttpMessageConverter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/converter/json/JacksonJsonHttpMessageConverter.html) for JSON conversions), it replaces the default value. For more control, declare [`ServerHttpMessageConvertersCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/http/converter/autoconfigure/ServerHttpMessageConvertersCustomizer.html) beans, which let you choose whether a converter is added before the default ones or overrides a specific default converter. The converters used by clients are configured separately, using [`ClientHttpMessageConvertersCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/http/converter/autoconfigure/ClientHttpMessageConvertersCustomizer.html) beans. As in normal MVC usage, any [`WebMvcConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.html) beans that you provide can also contribute converters by overriding the `configureMessageConverters` method. However, unlike with normal MVC, you can supply only additional converters that you need (because Spring Boot uses the same mechanism to contribute its defaults). Finally, if you opt out of the default Spring Boot MVC configuration by providing your own [`@EnableWebMvc`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/config/annotation/EnableWebMvc.html) configuration, you can take control completely and do everything manually by using `getMessageConverters` from [`WebMvcConfigurationSupport`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupport.html). See the [`WebMvcAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-webmvc/src/main/java/org/springframework/boot/webmvc/autoconfigure/WebMvcAutoConfiguration.java) source code for more details. ## [](#howto.spring-mvc.multipart-file-uploads)Handling Multipart File Uploads Spring Boot embraces the servlet 5 [`Part`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/http/Part.html) API to support uploading files. By default, Spring Boot configures Spring MVC with a maximum size of 1MB per file and a maximum of 10MB of file data in a single request. You may override these values, the location to which intermediate data is stored (for example, to the `/tmp` directory), and the threshold past which data is flushed to disk by using the properties exposed in the [`MultipartProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/servlet/autoconfigure/MultipartProperties.html) class. For example, if you want to specify that files be unlimited, set the `spring.servlet.multipart.max-file-size` property to `-1`. The multipart support is helpful when you want to receive multipart encoded file data as a [`@RequestParam`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/RequestParam.html)-annotated parameter of type [`MultipartFile`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/multipart/MultipartFile.html) in a Spring MVC controller handler method. See the [`MultipartAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-servlet/src/main/java/org/springframework/boot/servlet/autoconfigure/MultipartAutoConfiguration.java) source for more details. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | It is recommended to use the container’s built-in support for multipart uploads rather than introduce an additional dependency such as Apache Commons File Upload. | ## [](#howto.spring-mvc.switch-off-dispatcherservlet)Switch Off the Spring MVC DispatcherServlet By default, all content is served from the root of your application (`/`). If you would rather map to a different path, you can configure one as follows: * Properties * YAML ```properties spring.mvc.servlet.path=/mypath ``` ```yaml spring: mvc: servlet: path: "/mypath" ``` If you have additional servlets you can declare a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) of type [`Servlet`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Servlet.html) or [`ServletRegistrationBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/ServletRegistrationBean.html) for each and Spring Boot will register them transparently to the container. It is also possible to use [`@ServletRegistration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/ServletRegistration.html) as an annotation-based alternative to [`ServletRegistrationBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/ServletRegistrationBean.html). Because servlets are registered that way, they can be mapped to a sub-context of the [`DispatcherServlet`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/DispatcherServlet.html) without invoking it. Configuring the [`DispatcherServletPath`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/autoconfigure/DispatcherServletPath.html) yourself is unusual but if you really need to do it, a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) of type [`DispatcherServletPath`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/autoconfigure/DispatcherServletPath.html) must be provided as well to provide the path of your custom [`DispatcherServlet`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/DispatcherServlet.html). ## [](#howto.spring-mvc.switch-off-default-configuration)Switch Off the Default MVC Configuration The easiest way to take complete control over MVC configuration is to provide your own [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) with the [`@EnableWebMvc`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/config/annotation/EnableWebMvc.html) annotation. Doing so leaves all MVC configuration in your hands. ## [](#howto.spring-mvc.customize-view-resolvers)Customize ViewResolvers A [`ViewResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/ViewResolver.html) is a core component of Spring MVC, translating view names in [`@Controller`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Controller.html) to actual [`View`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/View.html) implementations. Note that view resolvers are mainly used in UI applications, rather than REST-style services (a [`View`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/View.html) is not used to render a [`@ResponseBody`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/ResponseBody.html)). There are many implementations of [`ViewResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/ViewResolver.html) to choose from, and Spring on its own is not opinionated about which ones you should use. Spring Boot, on the other hand, installs one or two for you, depending on what it finds on the classpath and in the application context. The [`DispatcherServlet`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/DispatcherServlet.html) uses all the resolvers it finds in the application context, trying each one in turn until it gets a result. If you add your own, you have to be aware of the order and in which position your resolver is added. [`WebMvcAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/autoconfigure/WebMvcAutoConfiguration.html) adds the following [`ViewResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/ViewResolver.html) beans to your context: * An [`InternalResourceViewResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/view/InternalResourceViewResolver.html) named ‘defaultViewResolver’. This one locates physical resources that can be rendered by using the `DefaultServlet` (including static resources and JSP pages, if you use those). It applies a prefix and a suffix to the view name and then looks for a physical resource with that path in the servlet context (the defaults are both empty but are accessible for external configuration through `spring.mvc.view.prefix` and `spring.mvc.view.suffix`). You can override it by providing a bean of the same type. * A [`BeanNameViewResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/view/BeanNameViewResolver.html) named ‘beanNameViewResolver’. This is a useful member of the view resolver chain and picks up any beans with the same name as the [`View`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/View.html) being resolved. It should not be necessary to override or replace it. * A [`ContentNegotiatingViewResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/view/ContentNegotiatingViewResolver.html) named ‘viewResolver’ is added only if there **are** actually beans of type [`View`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/View.html) present. This is a composite resolver, delegating to all the others and attempting to find a match to the ‘Accept’ HTTP header sent by the client. There is a useful [blog about ](https://spring.io/blog/2013/06/03/content-negotiation-using-views)[`ContentNegotiatingViewResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/view/ContentNegotiatingViewResolver.html) that you might like to study to learn more, and you might also look at the source code for detail. You can switch off the auto-configured [`ContentNegotiatingViewResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/view/ContentNegotiatingViewResolver.html) by defining a bean named ‘viewResolver’. * If you use Thymeleaf, you also have a [`ThymeleafViewResolver`](https://www.thymeleaf.org/apidocs/thymeleaf-spring6/3.1.5.RELEASE/org/thymeleaf/spring6/view/ThymeleafViewResolver.html) named ‘thymeleafViewResolver’. It looks for resources by surrounding the view name with a prefix and suffix. The prefix is `spring.thymeleaf.prefix`, and the suffix is `spring.thymeleaf.suffix`. The values of the prefix and suffix default to ‘classpath:/templates/’ and ‘.html’, respectively. You can override [`ThymeleafViewResolver`](https://www.thymeleaf.org/apidocs/thymeleaf-spring6/3.1.5.RELEASE/org/thymeleaf/spring6/view/ThymeleafViewResolver.html) by providing a bean of the same name. * If you use FreeMarker, you also have a [`FreeMarkerViewResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/view/freemarker/FreeMarkerViewResolver.html) named ‘freeMarkerViewResolver’. It looks for resources in a loader path (which is externalized to `spring.freemarker.templateLoaderPath` and has a default value of ‘classpath:/templates/’) by surrounding the view name with a prefix and a suffix. The prefix is externalized to `spring.freemarker.prefix`, and the suffix is externalized to `spring.freemarker.suffix`. The default values of the prefix and suffix are empty and ‘.ftlh’, respectively. You can override [`FreeMarkerViewResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/view/freemarker/FreeMarkerViewResolver.html) by providing a bean of the same name. FreeMarker variables can be customized by defining a bean of type [`FreeMarkerVariablesCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/freemarker/autoconfigure/FreeMarkerVariablesCustomizer.html). * If you use Groovy templates (actually, if `groovy-templates` is on your classpath), you also have a [`GroovyMarkupViewResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/view/groovy/GroovyMarkupViewResolver.html) named ‘groovyMarkupViewResolver’. It looks for resources in a loader path by surrounding the view name with a prefix and suffix (externalized to `spring.groovy.template.prefix` and `spring.groovy.template.suffix`). The prefix and suffix have default values of ‘classpath:/templates/’ and ‘.tpl’, respectively. You can override [`GroovyMarkupViewResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/view/groovy/GroovyMarkupViewResolver.html) by providing a bean of the same name. * If you use Mustache, you also have a [`MustacheViewResolver`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/mustache/servlet/view/MustacheViewResolver.html) named ‘mustacheViewResolver’. It looks for resources by surrounding the view name with a prefix and suffix. The prefix is `spring.mustache.prefix`, and the suffix is `spring.mustache.suffix`. The values of the prefix and suffix default to ‘classpath:/templates/’ and ‘.mustache’, respectively. You can override [`MustacheViewResolver`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/mustache/servlet/view/MustacheViewResolver.html) by providing a bean of the same name. For more detail, see the following sections: * [`WebMvcAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-webmvc/src/main/java/org/springframework/boot/webmvc/autoconfigure/WebMvcAutoConfiguration.java) * [`ThymeleafAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-thymeleaf/src/main/java/org/springframework/boot/thymeleaf/autoconfigure/ThymeleafAutoConfiguration.java) * [`FreeMarkerAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-freemarker/src/main/java/org/springframework/boot/freemarker/autoconfigure/FreeMarkerAutoConfiguration.java) * [`GroovyTemplateAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-groovy-templates/src/main/java/org/springframework/boot/groovy/template/autoconfigure/GroovyTemplateAutoConfiguration.java) ## [](#howto.spring-mvc.customize-whitelabel-error-page)Customize the ‘whitelabel’ Error Page Spring Boot installs a ‘whitelabel’ error page that you see in a browser client if you encounter a server error (machine clients consuming JSON and other media types should see a sensible response with the right error code). | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Set `spring.web.error.whitelabel.enabled` to `false` to switch the default error page off. Doing so restores the default of the servlet container that you are using. Note that Spring Boot still tries to resolve the error view, so you should probably add your own error page rather than disabling it completely. | Overriding the error page with your own depends on the templating technology that you use. For example, if you use Thymeleaf, you can add an `error.html` template. If you use FreeMarker, you can add an `error.ftlh` template. In general, you need a [`View`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/View.html) that resolves with a name of `error` or a [`@Controller`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Controller.html) that handles the `/error` path. Unless you replaced some of the default configuration, you should find a [`BeanNameViewResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/view/BeanNameViewResolver.html) in your [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html), so a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) named `error` would be one way of doing that. See [`ErrorMvcAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-webmvc/src/main/java/org/springframework/boot/webmvc/autoconfigure/error/ErrorMvcAutoConfiguration.java) for more options. See also the section on [Error Handling](../reference/web/servlet.html#web.servlet.spring-mvc.error-handling) for details of how to register handlers in the servlet container. * [Spring Boot](../index.html) * [4.1.1](spring-mvc.html) * [4.0.8](../4.0/how-to/spring-mvc.html) * [3.5.16](../3.5/how-to/spring-mvc.html) * [3.4.13](../3.4/how-to/spring-mvc.html) * [3.3.13](../3.3/how-to/spring-mvc.html) - [4.2.0-M2](../4.2/how-to/spring-mvc.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/spring-mvc.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/spring-mvc.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/spring-mvc.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/package-tree.html ---- # Hierarchy For Package org.springframework.boot.gradle.tasks.bundling Package Hierarchies: * [All Packages](../../../../../../overview-tree.html) ## Class Hierarchy * java.lang.[Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") * org.gradle.api.internal.AbstractTask (implements org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal) * org.gradle.api.[DefaultTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/DefaultTask.html "class or interface in org.gradle.api") (implements org.gradle.api.[Task](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api")) * org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") * org.gradle.api.internal.ConventionTask (implements org.gradle.api.internal.IConventionAware) * org.gradle.api.tasks.[AbstractCopyTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/AbstractCopyTask.html "class or interface in org.gradle.api.tasks") (implements org.gradle.api.file.[CopySpec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/CopySpec.html "class or interface in org.gradle.api.file"), org.gradle.api.internal.file.copy.CopySpecSource) * org.gradle.api.tasks.bundling.[AbstractArchiveTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/AbstractArchiveTask.html "class or interface in org.gradle.api.tasks.bundling") * org.gradle.api.tasks.bundling.[Zip](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/Zip.html "class or interface in org.gradle.api.tasks.bundling") * org.gradle.jvm.tasks.[Jar](https://docs.gradle.org/9.7.0/javadoc/org/gradle/jvm/tasks/Jar.html "class or interface in org.gradle.jvm.tasks") * org.gradle.api.tasks.bundling.[Jar](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/Jar.html "class or interface in org.gradle.api.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[BootJar](BootJar.html "class in org.springframework.boot.gradle.tasks.bundling") (implements org.springframework.boot.gradle.tasks.bundling.[BootArchive](BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling")) * org.gradle.api.tasks.bundling.[War](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/War.html "class or interface in org.gradle.api.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[BootWar](BootWar.html "class in org.springframework.boot.gradle.tasks.bundling") (implements org.springframework.boot.gradle.tasks.bundling.[BootArchive](BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling")) * org.springframework.boot.gradle.tasks.bundling.[CacheSpec](CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[CacheSpec.BindCacheSpec](CacheSpec.BindCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[CacheSpec.VolumeCacheSpec](CacheSpec.VolumeCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[DockerSpec](DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[DockerSpec.DockerRegistrySpec](DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[LayeredSpec](LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.IntoLayerSpec](LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") (implements java.io.[Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io")) * org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.DependenciesIntoLayerSpec](LayeredSpec.DependenciesIntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.IntoLayersSpec](LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling")\ (implements java.io.[Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io")) * org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.ApplicationSpec](LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") * org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.DependenciesSpec](LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") (implements java.io.[Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io")) ## Interface Hierarchy * java.lang.[Comparable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html "class or interface in java.lang")\ * org.gradle.api.[Task](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") (also extends org.gradle.api.plugins.[ExtensionAware](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/plugins/ExtensionAware.html "class or interface in org.gradle.api.plugins"), org.gradle.api.[Named](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Named.html "class or interface in org.gradle.api")) * org.springframework.boot.gradle.tasks.bundling.[BootArchive](BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") * org.gradle.api.plugins.[ExtensionAware](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/plugins/ExtensionAware.html "class or interface in org.gradle.api.plugins") * org.gradle.api.[Task](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") (also extends java.lang.[Comparable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html "class or interface in java.lang")\, org.gradle.api.[Named](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Named.html "class or interface in org.gradle.api")) * org.springframework.boot.gradle.tasks.bundling.[BootArchive](BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") * org.gradle.api.[Named](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Named.html "class or interface in org.gradle.api") * org.gradle.api.[Task](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") (also extends java.lang.[Comparable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html "class or interface in java.lang")\, org.gradle.api.plugins.[ExtensionAware](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/plugins/ExtensionAware.html "class or interface in org.gradle.api.plugins")) * org.springframework.boot.gradle.tasks.bundling.[BootArchive](BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") ## Enum Class Hierarchy * java.lang.[Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") * java.lang.[Enum](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html "class or interface in java.lang")\ (implements java.lang.[Comparable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html "class or interface in java.lang")\, java.lang.constant.[Constable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html "class or interface in java.lang.constant"), java.io.[Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io")) * org.springframework.boot.gradle.tasks.bundling.[ZipCompression](ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/buildinfo/package-use.html ---- Uses of Package\ org.springframework.boot.gradle.tasks.buildinfo =============================================== Packages that use [org.springframework.boot.gradle.tasks.buildinfo](package-summary.html) Package Description [org.springframework.boot.gradle.dsl](#org.springframework.boot.gradle.dsl) Spring Boot Gradle DSL. [org.springframework.boot.gradle.tasks.buildinfo](#org.springframework.boot.gradle.tasks.buildinfo) Support for producing build info for consumption by Spring Boot's actuator. * Classes in [org.springframework.boot.gradle.tasks.buildinfo](package-summary.html) used by [org.springframework.boot.gradle.dsl](../../dsl/package-summary.html) Class Description [BuildInfo](class-use/BuildInfo.html#org.springframework.boot.gradle.dsl) [`Task`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") for generating a build info properties file from [`BuildInfoProperties`](BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo"). * Classes in [org.springframework.boot.gradle.tasks.buildinfo](package-summary.html) used by [org.springframework.boot.gradle.tasks.buildinfo](package-summary.html) Class Description [BuildInfoProperties](class-use/BuildInfoProperties.html#org.springframework.boot.gradle.tasks.buildinfo) The properties that are written into the `META-INF/build-info.properties` file. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/IncludeFilter.html ---- # Class IncludeFilter [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.shared.artifact.filter.collection.AbstractArtifactsFilter [org.springframework.boot.maven.DependencyFilter](DependencyFilter.html "class in org.springframework.boot.maven") org.springframework.boot.maven.IncludeFilter * All Implemented Interfaces: `org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter` *** public class IncludeFilter extends [DependencyFilter](DependencyFilter.html "class in org.springframework.boot.maven") An `ArtifactsFilter` that filters out any artifact not matching an [`Include`](Include.html "class in org.springframework.boot.maven"). `IncludeFilter(List includes)` * ### IncludeFilter public IncludeFilter​([List](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html "class or interface in java.util")<[Include](Include.html "class in org.springframework.boot.maven")> includes) * ## Method Details * ### filter protected boolean filter​(org.apache.maven.artifact.Artifact artifact) * Specified by: `filter` in class `DependencyFilter` ---- url: https://docs.spring.io/spring-boot/reference/packaging/aot.html ---- # Ahead-of-Time Processing With the JVM It’s beneficial for the startup time to run your application using the AOT generated initialization code. First, you need to ensure that the jar you are building includes AOT generated code. | | | | -- | --------------------------------------------------------------------------- | | ** | AOT cache and Spring’s AOT can be combined to further improve startup time. | For Maven, this means that you should build with `-Pnative` to activate the `native` profile: ```shell $ mvn -Pnative package ``` For Gradle, you need to ensure that your build includes the `org.springframework.boot.aot` plugin. When the JAR has been built, run it with `spring.aot.enabled` system property set to `true`. For example: ```shell $ java -Dspring.aot.enabled=true -jar myapplication.jar ........ Starting AOT-processed MyApplication ... ``` Beware that using the ahead-of-time processing has drawbacks. It implies the following restrictions: * The classpath is fixed and fully defined at build time * The beans defined in your application cannot change at runtime, meaning: * The Spring [`@Profile`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Profile.html) annotation and profile-specific configuration [have limitations](../../how-to/aot.html#howto.aot.conditions). * Properties that change if a bean is created are not supported (for example, [`@ConditionalOnProperty`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnProperty.html) and `.enabled` properties). To learn more about ahead-of-time processing, please see the [Understanding Spring Ahead-of-Time Processing](native-image/introducing-graalvm-native-images.html#packaging.native-image.introducing-graalvm-native-images.understanding-aot-processing) section. * [Spring Boot](../../index.html) * [4.1.1](aot.html) * [4.0.8](../../4.0/reference/packaging/aot.html) * [3.5.16](../../3.5/reference/packaging/aot.html) * [3.4.13](../../3.4/reference/packaging/aot.html) * [3.3.13](../../3.3/reference/packaging/aot.html) - [4.2.0-M2](../../4.2/reference/packaging/aot.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/packaging/aot.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/packaging/aot.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/packaging/aot.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/security/index.html ---- # Security Spring Boot provides helpful support for general purpose security features such as OAuth2 and SAML 2.0. This section covers those general purpose security concerns. If you’re looking to secure web applications, see the [web security section](../web/spring-security.html#web.security) instead of this one. * [Spring Boot](../../index.html) * [4.1.1](index.html) * [4.0.8](../../4.0/index.html) * [3.5.16](../../3.5/index.html) * [3.4.13](../../3.4/index.html) * [3.3.13](../../3.3/index.html) - [4.2.0-M2](../../4.2/reference/security/index.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/security/index.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/security/index.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/actuator/cloud-foundry.html ---- # Cloud Foundry Support Spring Boot’s `spring-boot-cloudfoundry` module (part of `spring-boot-starter-cloudfoundry`) includes additional support that is activated when you deploy to a compatible Cloud Foundry instance. The `/cloudfoundryapplication` path provides an alternative secured route to all [`@Endpoint`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/Endpoint.html) beans. The extended support lets Cloud Foundry management UIs (such as the web application that you can use to view deployed applications) be augmented with Spring Boot actuator information. For example, an application status page can include full health information instead of the typical “running” or “stopped” status. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The `/cloudfoundryapplication` path is not directly accessible to regular users. To use the endpoint, you must pass a valid UAA token with the request. | ## [](#actuator.cloud-foundry.disable)Disabling Extended Cloud Foundry Actuator Support If you want to fully disable the `/cloudfoundryapplication` endpoints, you can add the following setting to your `application.properties` file: * Properties * YAML ```properties management.cloudfoundry.enabled=false ``` ```yaml management: cloudfoundry: enabled: false ``` ## [](#actuator.cloud-foundry.ssl)Cloud Foundry Self-signed Certificates By default, the security verification for `/cloudfoundryapplication` endpoints makes SSL calls to various Cloud Foundry services. If your Cloud Foundry UAA or Cloud Controller services use self-signed certificates, you need to set the following property: * Properties * YAML ```properties management.cloudfoundry.skip-ssl-validation=true ``` ```yaml management: cloudfoundry: skip-ssl-validation: true ``` ## [](#actuator.cloud-foundry.custom-context-path)Custom Context Path If the server’s context-path has been configured to anything other than `/`, the Cloud Foundry endpoints are not available at the root of the application. For example, if `server.servlet.context-path=/app`, Cloud Foundry endpoints are available at `/app/cloudfoundryapplication/*`. If you expect the Cloud Foundry endpoints to always be available at `/cloudfoundryapplication/*`, regardless of the server’s context-path, you need to explicitly configure that in your application. The configuration differs, depending on the web server in use. For Tomcat, you can add the following configuration: * Java * Kotlin ```java import java.io.IOException; import java.util.Collections; import jakarta.servlet.GenericServlet; import jakarta.servlet.Servlet; import jakarta.servlet.ServletContainerInitializer; import jakarta.servlet.ServletContext; import jakarta.servlet.ServletException; import jakarta.servlet.ServletRequest; import jakarta.servlet.ServletResponse; import org.apache.catalina.Host; import org.apache.catalina.core.StandardContext; import org.apache.catalina.startup.Tomcat; import org.springframework.boot.tomcat.servlet.TomcatServletWebServerFactory; import org.springframework.boot.web.servlet.ServletContextInitializer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyCloudFoundryConfiguration { @Bean public TomcatServletWebServerFactory servletWebServerFactory() { return new TomcatServletWebServerFactory() { @Override protected void prepareContext(Host host, ServletContextInitializer[] initializers, TempDirs tempDirs) { super.prepareContext(host, initializers, tempDirs); StandardContext child = new StandardContext(); child.addLifecycleListener(new Tomcat.FixContextListener()); child.setPath("/cloudfoundryapplication"); ServletContainerInitializer initializer = getServletContextInitializer(getContextPath()); child.addServletContainerInitializer(initializer, Collections.emptySet()); child.setCrossContext(true); host.addChild(child); } }; } private ServletContainerInitializer getServletContextInitializer(String contextPath) { return (classes, context) -> { Servlet servlet = new GenericServlet() { @Override public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException { ServletContext context = req.getServletContext().getContext(contextPath); context.getRequestDispatcher("/cloudfoundryapplication").forward(req, res); } }; context.addServlet("cloudfoundry", servlet).addMapping("/*"); }; } } ``` ```kotlin import jakarta.servlet.GenericServlet import jakarta.servlet.Servlet import jakarta.servlet.ServletContainerInitializer import jakarta.servlet.ServletContext import jakarta.servlet.ServletException import jakarta.servlet.ServletRequest import jakarta.servlet.ServletResponse import org.apache.catalina.Host import org.apache.catalina.core.StandardContext import org.apache.catalina.startup.Tomcat.FixContextListener import org.springframework.boot.tomcat.servlet.TomcatServletWebServerFactory import org.springframework.boot.web.servlet.ServletContextInitializer import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import java.io.IOException import java.util.Collections.emptySet @Configuration(proxyBeanMethods = false) class MyCloudFoundryConfiguration { @Bean fun servletWebServerFactory(): TomcatServletWebServerFactory { return object : TomcatServletWebServerFactory() { override fun prepareContext(host: Host, initializers: Array, tempDirs: TempDirs) { super.prepareContext(host, initializers, tempDirs) val child = StandardContext() child.addLifecycleListener(FixContextListener()) child.path = "/cloudfoundryapplication" val initializer = getServletContextInitializer(contextPath) child.addServletContainerInitializer(initializer, emptySet()) child.crossContext = true host.addChild(child) } } } private fun getServletContextInitializer(contextPath: String): ServletContainerInitializer { return ServletContainerInitializer { classes: Set?>?, context: ServletContext -> val servlet: Servlet = object : GenericServlet() { @Throws(ServletException::class, IOException::class) override fun service(req: ServletRequest, res: ServletResponse) { val servletContext = req.servletContext.getContext(contextPath) servletContext.getRequestDispatcher("/cloudfoundryapplication").forward(req, res) } } context.addServlet("cloudfoundry", servlet).addMapping("/*") } } } ``` If you’re using a Webflux based application, you can use the following configuration: * Java * Kotlin ```java import java.util.Map; import reactor.core.publisher.Mono; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.boot.webflux.autoconfigure.WebFluxProperties; import org.springframework.context.ApplicationContext; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.http.server.reactive.ContextPathCompositeHandler; import org.springframework.http.server.reactive.HttpHandler; import org.springframework.http.server.reactive.ServerHttpRequest; import org.springframework.http.server.reactive.ServerHttpResponse; import org.springframework.web.server.adapter.WebHttpHandlerBuilder; @Configuration(proxyBeanMethods = false) @EnableConfigurationProperties(WebFluxProperties.class) public class MyReactiveCloudFoundryConfiguration { @Bean public HttpHandler httpHandler(ApplicationContext applicationContext, WebFluxProperties properties) { HttpHandler httpHandler = WebHttpHandlerBuilder.applicationContext(applicationContext).build(); return new CloudFoundryHttpHandler(properties.getBasePath(), httpHandler); } private static final class CloudFoundryHttpHandler implements HttpHandler { private final HttpHandler delegate; private final ContextPathCompositeHandler contextPathDelegate; private CloudFoundryHttpHandler(String basePath, HttpHandler delegate) { this.delegate = delegate; this.contextPathDelegate = new ContextPathCompositeHandler(Map.of(basePath, delegate)); } @Override public Mono handle(ServerHttpRequest request, ServerHttpResponse response) { // Remove underlying context path first (e.g. Servlet container) String path = request.getPath().pathWithinApplication().value(); if (path.startsWith("/cloudfoundryapplication")) { return this.delegate.handle(request, response); } else { return this.contextPathDelegate.handle(request, response); } } } } ``` ```kotlin import org.springframework.boot.context.properties.EnableConfigurationProperties import org.springframework.boot.webflux.autoconfigure.WebFluxProperties import org.springframework.context.ApplicationContext import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.http.server.reactive.ContextPathCompositeHandler import org.springframework.http.server.reactive.HttpHandler import org.springframework.http.server.reactive.ServerHttpRequest import org.springframework.http.server.reactive.ServerHttpResponse import org.springframework.web.server.adapter.WebHttpHandlerBuilder import reactor.core.publisher.Mono @Configuration(proxyBeanMethods = false) @EnableConfigurationProperties(WebFluxProperties::class) class MyReactiveCloudFoundryConfiguration { @Bean fun httpHandler(applicationContext: ApplicationContext, properties: WebFluxProperties): HttpHandler { val httpHandler = WebHttpHandlerBuilder.applicationContext(applicationContext).build() return CloudFoundryHttpHandler(properties.basePath ?: "/", httpHandler) } private class CloudFoundryHttpHandler(basePath: String, private val delegate: HttpHandler) : HttpHandler { private val contextPathDelegate = ContextPathCompositeHandler(mapOf(basePath to delegate)) override fun handle(request: ServerHttpRequest, response: ServerHttpResponse): Mono { // Remove underlying context path first (e.g. Servlet container) val path = request.path.pathWithinApplication().value() return if (path.startsWith("/cloudfoundryapplication")) { delegate.handle(request, response) } else { contextPathDelegate.handle(request, response) } } } } ``` * [Spring Boot](../../index.html) * [4.1.1](cloud-foundry.html) * [4.0.8](../../4.0/reference/actuator/cloud-foundry.html) * [3.5.16](../../3.5/reference/actuator/cloud-foundry.html) * [3.4.13](../../3.4/reference/actuator/cloud-foundry.html) * [3.3.13](../../3.3/reference/actuator/cloud-foundry.html) - [4.2.0-M2](../../4.2/reference/actuator/cloud-foundry.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/actuator/cloud-foundry.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/actuator/cloud-foundry.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/actuator/cloud-foundry.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/run.html ---- # Running your Application with Maven The plugin includes a run goal which can be used to launch your application from the command line, as shown in the following example: ```shell $ mvn spring-boot:run ``` Application arguments can be specified using the `arguments` parameter, see [using application arguments](#run.examples.using-application-arguments) for more details. The application is executed in a forked process and setting properties on the command-line will not affect the application. If you need to specify some JVM arguments (that is for debugging purposes), you can use the `jvmArguments` parameter, see [Debug the application](#run.examples.debug) for more details. There is also explicit support for [system properties](#run.examples.system-properties) and [environment variables](#run.examples.environment-variables). As enabling a profile is quite common, there is dedicated `profiles` property that offers a shortcut for `-Dspring-boot.run.jvmArguments="-Dspring.profiles.active=dev"`, see [Specify active profiles](#run.examples.specify-active-profiles). Spring Boot `devtools` is a module to improve the development-time experience when working on Spring Boot applications. To enable it, just add the following dependency to your project: ```xml org.springframework.boot spring-boot-devtools true ``` When `devtools` is running, it detects changes when you recompile your application and automatically refreshes it. This works for not only resources but code as well. Devtools can also be configured to only refresh the browser whenever a static resource has changed (and ignore any change in the code). Just include the following property in your project: ```properties spring.devtools.remote.restart.enabled=false ``` Prior to `devtools`, the plugin supported hot refreshing of resources by default which has now been disabled in favour of the solution described above. You can restore it at any time by configuring your project: ```xml org.springframework.boot spring-boot-maven-plugin true ``` When `addResources` is enabled, any `src/main/resources` directory will be added to the application classpath when you run the application and any duplicate found in the classes output will be removed. This allows hot refreshing of resources which can be very useful when developing web applications. For example, you can work on HTML, CSS or JavaScript files and see your changes immediately without recompiling your application. It is also a helpful way of allowing your front end developers to work without needing to download and install a Java IDE. | | | | -- | ----------------------------------------------------------------------------------------------- | | ** | A side effect of using this feature is that filtering of resources at build time will not work. | In order to be consistent with the `repackage` goal, the `run` goal builds the classpath in such a way that any dependency that is excluded in the plugin’s configuration gets excluded from the classpath as well. For more details, see [the dedicated example](packaging.html#packaging.examples.exclude-dependency). Sometimes it is useful to run a test variant of your application. For example, if you want to [use Testcontainers at development time](../reference/features/dev-services.html#features.dev-services.testcontainers.at-development-time) or make use of some test stubs. Use the `test-run` goal with many of the same features and configuration options as `run` for this purpose. ## [](#run.run-goal)`spring-boot:run` `org.springframework.boot:spring-boot-maven-plugin:4.1.1` Run an application in place. ### [](#run.run-goal.required-parameters)Required parameters | Name | Type | Default | | --------------------------------------------------------------------- | ------ | ---------------------------------- | | [classesDirectory](#run.run-goal.parameter-details.classes-directory) | `File` | `${project.build.outputDirectory}` | ### [](#run.run-goal.optional-parameters)Optional parameters | Name | Type | Default | | -------------------------------------------------------------------------------------------- | ---------- | ------- | | [addResources](#run.run-goal.parameter-details.add-resources) | `boolean` | `false` | | [additionalClasspathElements](#run.run-goal.parameter-details.additional-classpath-elements) | `String[]` | | | [agents](#run.run-goal.parameter-details.agents) | `File[]` | | | [arguments](#run.run-goal.parameter-details.arguments) | `String[]` | | | [commandlineArguments](#run.run-goal.parameter-details.commandline-arguments) | `String` | | | [environmentVariables](#run.run-goal.parameter-details.environment-variables) | `Map` | | | [excludeGroupIds](#run.run-goal.parameter-details.exclude-group-ids) | `String` | | | [excludes](#run.run-goal.parameter-details.excludes) | `List` | | | [includes](#run.run-goal.parameter-details.includes) | `List` | | | [jvmArguments](#run.run-goal.parameter-details.jvm-arguments) | `String` | | | [mainClass](#run.run-goal.parameter-details.main-class) | `String` | | | [noverify](#run.run-goal.parameter-details.noverify) | `boolean` | | | [optimizedLaunch](#run.run-goal.parameter-details.optimized-launch) | `boolean` | `true` | | [profiles](#run.run-goal.parameter-details.profiles) | `String[]` | | | [skip](#run.run-goal.parameter-details.skip) | `boolean` | `false` | | [systemPropertyVariables](#run.run-goal.parameter-details.system-property-variables) | `Map` | | | [useTestClasspath](#run.run-goal.parameter-details.use-test-classpath) | `boolean` | `false` | | [workingDirectory](#run.run-goal.parameter-details.working-directory) | `File` | | ### [](#run.run-goal.parameter-details)Parameter details #### [](#run.run-goal.parameter-details.add-resources)`addResources` Add maven resources to the classpath directly, this allows live in-place editing of resources. Duplicate resources are removed from `target/classes` to prevent them from appearing twice if `ClassLoader.getResources()` is called. Please consider adding `spring-boot-devtools` to your project instead as it provides this feature and many more. | Name | `addResources` | | ------------- | ------------------------------ | | Type | `boolean` | | Default value | `false` | | User property | `spring-boot.run.addResources` | | Since | `1.0.0` | #### [](#run.run-goal.parameter-details.additional-classpath-elements)`additionalClasspathElements` Additional classpath elements that should be added to the classpath. An element can be a directory with classes and resources or a jar file. | Name | `additionalClasspathElements` | | ------------- | ----------------------------------------------- | | Type | `java.lang.String[]` | | Default value | | | User property | `spring-boot.run.additional-classpath-elements` | | Since | `3.2.0` | #### [](#run.run-goal.parameter-details.agents)`agents` Path to agent jars. | Name | `agents` | | ------------- | ------------------------ | | Type | `java.io.File[]` | | Default value | | | User property | `spring-boot.run.agents` | | Since | `2.2.0` | #### [](#run.run-goal.parameter-details.arguments)`arguments` Arguments that should be passed to the application. | Name | `arguments` | | ------------- | -------------------- | | Type | `java.lang.String[]` | | Default value | | | User property | | | Since | `1.0.0` | #### [](#run.run-goal.parameter-details.classes-directory)`classesDirectory` Directory containing the classes and resource files that should be used to run the application. | Name | `classesDirectory` | | ------------- | ---------------------------------- | | Type | `java.io.File` | | Default value | `${project.build.outputDirectory}` | | User property | | | Since | `1.0.0` | #### [](#run.run-goal.parameter-details.commandline-arguments)`commandlineArguments` Arguments from the command line that should be passed to the application. Use spaces to separate multiple arguments and make sure to wrap multiple values between quotes. When specified, takes precedence over `#arguments`. | Name | `commandlineArguments` | | ------------- | --------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.run.arguments` | | Since | `2.2.3` | #### [](#run.run-goal.parameter-details.environment-variables)`environmentVariables` List of Environment variables that should be associated with the forked process used to run the application. | Name | `environmentVariables` | | ------------- | ---------------------- | | Type | `java.util.Map` | | Default value | | | User property | | | Since | `2.1.0` | #### [](#run.run-goal.parameter-details.exclude-group-ids)`excludeGroupIds` Comma separated list of groupId names to exclude (exact match). | Name | `excludeGroupIds` | | ------------- | ----------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.excludeGroupIds` | | Since | `1.1.0` | #### [](#run.run-goal.parameter-details.excludes)`excludes` Collection of artifact definitions to exclude. The `Exclude` element defines mandatory `groupId` and `artifactId` components and an optional `classifier` component. When configured as a property, values should be comma-separated with colon-separated components: `groupId:artifactId,groupId:artifactId:classifier` | Name | `excludes` | | ------------- | ---------------------- | | Type | `java.util.List` | | Default value | | | User property | `spring-boot.excludes` | | Since | `1.1.0` | #### [](#run.run-goal.parameter-details.includes)`includes` Collection of artifact definitions to include. The `Include` element defines mandatory `groupId` and `artifactId` components and an optional `classifier` component. When configured as a property, values should be comma-separated with colon-separated components: `groupId:artifactId,groupId:artifactId:classifier` | Name | `includes` | | ------------- | ---------------------- | | Type | `java.util.List` | | Default value | | | User property | `spring-boot.includes` | | Since | `1.2.0` | #### [](#run.run-goal.parameter-details.jvm-arguments)`jvmArguments` JVM arguments that should be associated with the forked process used to run the application. On command line, make sure to wrap multiple values between quotes. | Name | `jvmArguments` | | ------------- | ------------------------------ | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.run.jvmArguments` | | Since | `1.1.0` | #### [](#run.run-goal.parameter-details.main-class)`mainClass` The name of the main class. If not specified the first compiled class found that contains a 'main' method will be used. | Name | `mainClass` | | ------------- | ---------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.run.main-class` | | Since | `1.0.0` | #### [](#run.run-goal.parameter-details.noverify)`noverify` Flag to say that the agent requires -noverify. | Name | `noverify` | | ------------- | -------------------------- | | Type | `boolean` | | Default value | | | User property | `spring-boot.run.noverify` | | Since | `1.0.0` | #### [](#run.run-goal.parameter-details.optimized-launch)`optimizedLaunch` Whether the JVM’s launch should be optimized. | Name | `optimizedLaunch` | | ------------- | --------------------------------- | | Type | `boolean` | | Default value | `true` | | User property | `spring-boot.run.optimizedLaunch` | | Since | `2.2.0` | #### [](#run.run-goal.parameter-details.profiles)`profiles` The spring profiles to activate. Convenience shortcut of specifying the 'spring.profiles.active' argument. On command line use commas to separate multiple profiles. | Name | `profiles` | | ------------- | -------------------------- | | Type | `java.lang.String[]` | | Default value | | | User property | `spring-boot.run.profiles` | | Since | `1.3.0` | #### [](#run.run-goal.parameter-details.skip)`skip` Skip the execution. | Name | `skip` | | ------------- | ---------------------- | | Type | `boolean` | | Default value | `false` | | User property | `spring-boot.run.skip` | | Since | `1.3.2` | #### [](#run.run-goal.parameter-details.system-property-variables)`systemPropertyVariables` List of JVM system properties to pass to the process. | Name | `systemPropertyVariables` | | ------------- | ------------------------- | | Type | `java.util.Map` | | Default value | | | User property | | | Since | `2.1.0` | #### [](#run.run-goal.parameter-details.use-test-classpath)`useTestClasspath` Flag to include the test classpath when running. | Name | `useTestClasspath` | | ------------- | ---------------------------------- | | Type | `boolean` | | Default value | `false` | | User property | `spring-boot.run.useTestClasspath` | | Since | `1.3.0` | #### [](#run.run-goal.parameter-details.working-directory)`workingDirectory` Current working directory to use for the application. If not specified, basedir will be used. | Name | `workingDirectory` | | ------------- | ---------------------------------- | | Type | `java.io.File` | | Default value | | | User property | `spring-boot.run.workingDirectory` | | Since | `1.5.0` | ## [](#run.test-run-goal)`spring-boot:test-run` `org.springframework.boot:spring-boot-maven-plugin:4.1.1` Run an application in place using the test runtime classpath. The main class that will be used to launch the application is determined as follows: The configured main class, if any. Then the main class found in the test classes directory, if any. Then the main class found in the classes directory, if any. ### [](#run.test-run-goal.required-parameters)Required parameters | Name | Type | Default | | ----------------------------------------------------------------------------------- | ------ | -------------------------------------- | | [classesDirectory](#run.test-run-goal.parameter-details.classes-directory) | `File` | `${project.build.outputDirectory}` | | [testClassesDirectory](#run.test-run-goal.parameter-details.test-classes-directory) | `File` | `${project.build.testOutputDirectory}` | ### [](#run.test-run-goal.optional-parameters)Optional parameters | Name | Type | Default | | ------------------------------------------------------------------------------------------------- | ---------- | ------- | | [addResources](#run.test-run-goal.parameter-details.add-resources) | `boolean` | `false` | | [additionalClasspathElements](#run.test-run-goal.parameter-details.additional-classpath-elements) | `String[]` | | | [agents](#run.test-run-goal.parameter-details.agents) | `File[]` | | | [arguments](#run.test-run-goal.parameter-details.arguments) | `String[]` | | | [commandlineArguments](#run.test-run-goal.parameter-details.commandline-arguments) | `String` | | | [environmentVariables](#run.test-run-goal.parameter-details.environment-variables) | `Map` | | | [excludeGroupIds](#run.test-run-goal.parameter-details.exclude-group-ids) | `String` | | | [excludes](#run.test-run-goal.parameter-details.excludes) | `List` | | | [includes](#run.test-run-goal.parameter-details.includes) | `List` | | | [jvmArguments](#run.test-run-goal.parameter-details.jvm-arguments) | `String` | | | [mainClass](#run.test-run-goal.parameter-details.main-class) | `String` | | | [noverify](#run.test-run-goal.parameter-details.noverify) | `boolean` | | | [optimizedLaunch](#run.test-run-goal.parameter-details.optimized-launch) | `boolean` | `true` | | [profiles](#run.test-run-goal.parameter-details.profiles) | `String[]` | | | [skip](#run.test-run-goal.parameter-details.skip) | `boolean` | `false` | | [systemPropertyVariables](#run.test-run-goal.parameter-details.system-property-variables) | `Map` | | | [workingDirectory](#run.test-run-goal.parameter-details.working-directory) | `File` | | ### [](#run.test-run-goal.parameter-details)Parameter details #### [](#run.test-run-goal.parameter-details.add-resources)`addResources` Add maven resources to the classpath directly, this allows live in-place editing of resources. Duplicate resources are removed from `target/classes` to prevent them from appearing twice if `ClassLoader.getResources()` is called. Please consider adding `spring-boot-devtools` to your project instead as it provides this feature and many more. | Name | `addResources` | | ------------- | ------------------------------ | | Type | `boolean` | | Default value | `false` | | User property | `spring-boot.run.addResources` | | Since | `1.0.0` | #### [](#run.test-run-goal.parameter-details.additional-classpath-elements)`additionalClasspathElements` Additional classpath elements that should be added to the classpath. An element can be a directory with classes and resources or a jar file. | Name | `additionalClasspathElements` | | ------------- | ----------------------------------------------- | | Type | `java.lang.String[]` | | Default value | | | User property | `spring-boot.run.additional-classpath-elements` | | Since | `3.2.0` | #### [](#run.test-run-goal.parameter-details.agents)`agents` Path to agent jars. | Name | `agents` | | ------------- | ------------------------ | | Type | `java.io.File[]` | | Default value | | | User property | `spring-boot.run.agents` | | Since | `2.2.0` | #### [](#run.test-run-goal.parameter-details.arguments)`arguments` Arguments that should be passed to the application. | Name | `arguments` | | ------------- | -------------------- | | Type | `java.lang.String[]` | | Default value | | | User property | | | Since | `1.0.0` | #### [](#run.test-run-goal.parameter-details.classes-directory)`classesDirectory` Directory containing the classes and resource files that should be used to run the application. | Name | `classesDirectory` | | ------------- | ---------------------------------- | | Type | `java.io.File` | | Default value | `${project.build.outputDirectory}` | | User property | | | Since | `1.0.0` | #### [](#run.test-run-goal.parameter-details.commandline-arguments)`commandlineArguments` Arguments from the command line that should be passed to the application. Use spaces to separate multiple arguments and make sure to wrap multiple values between quotes. When specified, takes precedence over `#arguments`. | Name | `commandlineArguments` | | ------------- | --------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.run.arguments` | | Since | `2.2.3` | #### [](#run.test-run-goal.parameter-details.environment-variables)`environmentVariables` List of Environment variables that should be associated with the forked process used to run the application. | Name | `environmentVariables` | | ------------- | ---------------------- | | Type | `java.util.Map` | | Default value | | | User property | | | Since | `2.1.0` | #### [](#run.test-run-goal.parameter-details.exclude-group-ids)`excludeGroupIds` Comma separated list of groupId names to exclude (exact match). | Name | `excludeGroupIds` | | ------------- | ----------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.excludeGroupIds` | | Since | `1.1.0` | #### [](#run.test-run-goal.parameter-details.excludes)`excludes` Collection of artifact definitions to exclude. The `Exclude` element defines mandatory `groupId` and `artifactId` components and an optional `classifier` component. When configured as a property, values should be comma-separated with colon-separated components: `groupId:artifactId,groupId:artifactId:classifier` | Name | `excludes` | | ------------- | ---------------------- | | Type | `java.util.List` | | Default value | | | User property | `spring-boot.excludes` | | Since | `1.1.0` | #### [](#run.test-run-goal.parameter-details.includes)`includes` Collection of artifact definitions to include. The `Include` element defines mandatory `groupId` and `artifactId` components and an optional `classifier` component. When configured as a property, values should be comma-separated with colon-separated components: `groupId:artifactId,groupId:artifactId:classifier` | Name | `includes` | | ------------- | ---------------------- | | Type | `java.util.List` | | Default value | | | User property | `spring-boot.includes` | | Since | `1.2.0` | #### [](#run.test-run-goal.parameter-details.jvm-arguments)`jvmArguments` JVM arguments that should be associated with the forked process used to run the application. On command line, make sure to wrap multiple values between quotes. | Name | `jvmArguments` | | ------------- | ------------------------------ | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.run.jvmArguments` | | Since | `1.1.0` | #### [](#run.test-run-goal.parameter-details.main-class)`mainClass` The name of the main class. If not specified the first compiled class found that contains a 'main' method will be used. | Name | `mainClass` | | ------------- | ---------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.run.main-class` | | Since | `1.0.0` | #### [](#run.test-run-goal.parameter-details.noverify)`noverify` Flag to say that the agent requires -noverify. | Name | `noverify` | | ------------- | -------------------------- | | Type | `boolean` | | Default value | | | User property | `spring-boot.run.noverify` | | Since | `1.0.0` | #### [](#run.test-run-goal.parameter-details.optimized-launch)`optimizedLaunch` Whether the JVM’s launch should be optimized. | Name | `optimizedLaunch` | | ------------- | -------------------------------------- | | Type | `boolean` | | Default value | `true` | | User property | `spring-boot.test-run.optimizedLaunch` | | Since | | #### [](#run.test-run-goal.parameter-details.profiles)`profiles` The spring profiles to activate. Convenience shortcut of specifying the 'spring.profiles.active' argument. On command line use commas to separate multiple profiles. | Name | `profiles` | | ------------- | -------------------------- | | Type | `java.lang.String[]` | | Default value | | | User property | `spring-boot.run.profiles` | | Since | `1.3.0` | #### [](#run.test-run-goal.parameter-details.skip)`skip` Skip the execution. | Name | `skip` | | ------------- | ---------------------- | | Type | `boolean` | | Default value | `false` | | User property | `spring-boot.run.skip` | | Since | `1.3.2` | #### [](#run.test-run-goal.parameter-details.system-property-variables)`systemPropertyVariables` List of JVM system properties to pass to the process. | Name | `systemPropertyVariables` | | ------------- | ------------------------- | | Type | `java.util.Map` | | Default value | | | User property | | | Since | `2.1.0` | #### [](#run.test-run-goal.parameter-details.test-classes-directory)`testClassesDirectory` Directory containing the test classes and resource files that should be used to run the application. | Name | `testClassesDirectory` | | ------------- | -------------------------------------- | | Type | `java.io.File` | | Default value | `${project.build.testOutputDirectory}` | | User property | | | Since | | #### [](#run.test-run-goal.parameter-details.working-directory)`workingDirectory` Current working directory to use for the application. If not specified, basedir will be used. | Name | `workingDirectory` | | ------------- | ---------------------------------- | | Type | `java.io.File` | | Default value | | | User property | `spring-boot.run.workingDirectory` | | Since | `1.5.0` | ## [](#run.examples)Examples ### [](#run.examples.debug)Debug the Application The `run` and `test-run` goals run your application in a forked process. If you need to debug it, you should add the necessary JVM arguments to enable remote debugging. The following configuration suspend the process until a debugger has joined on port 5005: ```xml org.springframework.boot spring-boot-maven-plugin -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=*:5005 ``` These arguments can be specified on the command line as well: ```shell $ mvn spring-boot:run -Dspring-boot.run.jvmArguments=-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=*:5005 ``` ### [](#run.examples.system-properties)Using System Properties System properties can be specified using the `systemPropertyVariables` attribute. The following example sets `property1` to `test` and `property2` to 42: ```xml 42 org.springframework.boot spring-boot-maven-plugin test ${my.value} ``` If the value is empty or not defined (that is `), the system property is set with an empty String as the value. Maven trims values specified in the pom, so it is not possible to specify a System property which needs to start or end with a space through this mechanism: consider using `jvmArguments` instead. Any String typed Maven variable can be passed as system properties. Any attempt to pass any other Maven variable type (for example a `List` or a `URL` variable) will cause the variable expression to be passed literally (unevaluated). The `jvmArguments` parameter takes precedence over system properties defined with the mechanism above. In the following example, the value for `property1` is `overridden`: ```shell $ mvn spring-boot:run -Dspring-boot.run.jvmArguments="-Dproperty1=overridden" ``` ### [](#run.examples.environment-variables)Using Environment Variables Environment variables can be specified using the `environmentVariables` attribute. The following example sets the 'ENV1', 'ENV2', 'ENV3', 'ENV4' env variables: ```xml org.springframework.boot spring-boot-maven-plugin 5000 Some Text ``` If the value is empty or not defined (that is `), the env variable is set with an empty String as the value. Maven trims values specified in the pom so it is not possible to specify an env variable which needs to start or end with a space. Any String typed Maven variable can be passed as system properties. Any attempt to pass any other Maven variable type (for example a `List` or a `URL` variable) will cause the variable expression to be passed literally (unevaluated). Environment variables defined this way take precedence over existing values. ### [](#run.examples.using-application-arguments)Using Application Arguments Application arguments can be specified using the `arguments` attribute. The following example sets two arguments: `property1` and `property2=42`: ```xml org.springframework.boot spring-boot-maven-plugin property1 property2=${my.value} ``` On the command-line, arguments are separated by a space the same way `jvmArguments` are. If an argument contains a space, make sure to quote it. In the following example, two arguments are available: `property1` and `property2=Hello World`: ```shell $ mvn spring-boot:run -Dspring-boot.run.arguments="property1 'property2=Hello World'" ``` ### [](#run.examples.specify-active-profiles)Specify Active Profiles The active profiles to use for a particular application can be specified using the `profiles` argument. The following configuration enables the `local` and `dev` profiles: ```xml org.springframework.boot spring-boot-maven-plugin local dev ``` The profiles to enable can be specified on the command line as well, make sure to separate them with a comma, as shown in the following example: ```shell $ mvn spring-boot:run -Dspring-boot.run.profiles=local,dev ``` * [Spring Boot](../index.html) * [4.1.1](run.html) * [4.0.8](../4.0/maven-plugin/run.html) * [3.5.16](../3.5/maven-plugin/run.html) * [3.4.13](../3.4/maven-plugin/run.html) * [3.3.13](../3.3/maven-plugin/run.html) - [4.2.0-M2](../4.2/maven-plugin/run.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/maven-plugin/run.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/maven-plugin/run.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/maven-plugin/run.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/run/package-use.html ---- Uses of Package\ org.springframework.boot.gradle.tasks.run ========================================= No usage of org.springframework.boot.gradle.tasks.run ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/class-use/BootArchive.html ---- Uses of Interface\ org.springframework.boot.gradle.tasks.bundling.BootArchive ========================================================== Packages that use [BootArchive](../BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") Package Description [org.springframework.boot.gradle.tasks.bundling](#org.springframework.boot.gradle.tasks.bundling) Support for creating executable jars and wars. * ## Uses of [BootArchive](../BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) Classes in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) that implement [BootArchive](../BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") Modifier and Type Class Description `class ` `BootJar` A custom [`Jar`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/Jar.html "class or interface in org.gradle.api.tasks.bundling") task that produces a Spring Boot executable jar. `class ` `BootWar` A custom [`War`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/War.html "class or interface in org.gradle.api.tasks.bundling") task that produces a Spring Boot executable war. ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/class-use/LayeredSpec.IntoLayersSpec.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.bundling.LayeredSpec.IntoLayersSpec ========================================================================= Packages that use [LayeredSpec.IntoLayersSpec](../LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Package Description [org.springframework.boot.gradle.tasks.bundling](#org.springframework.boot.gradle.tasks.bundling) Support for creating executable jars and wars. * ## Uses of [LayeredSpec.IntoLayersSpec](../LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) Subclasses of [LayeredSpec.IntoLayersSpec](../LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) Modifier and Type Class Description `static class ` `LayeredSpec.ApplicationSpec` An [`LayeredSpec.IntoLayersSpec`](../LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which application classes and resources belong. `static class ` `LayeredSpec.DependenciesSpec` An [`LayeredSpec.IntoLayersSpec`](../LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which dependencies belong. ---- url: https://docs.spring.io/spring-boot/reference/testing/testcontainers.html ---- # Testcontainers The [Testcontainers](https://www.testcontainers.org/) library provides a way to manage services running inside Docker containers. It integrates with JUnit, allowing you to write a test class that can start up a container before any of the tests run. Testcontainers is especially useful for writing integration tests that talk to a real backend service such as MySQL, MongoDB, Cassandra and others. In following sections we will describe some of the methods you can use to integrate Testcontainers with your tests. ## [](#testing.testcontainers.spring-beans)Using Spring Beans The containers provided by Testcontainers can be managed by Spring Boot as beans. To declare a container as a bean, add a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) method to your test configuration: * Java * Kotlin ```java import org.testcontainers.mongodb.MongoDBContainer; import org.testcontainers.utility.DockerImageName; import org.springframework.boot.test.context.TestConfiguration; import org.springframework.context.annotation.Bean; @TestConfiguration(proxyBeanMethods = false) class MyTestConfiguration { @Bean MongoDBContainer mongoDbContainer() { return new MongoDBContainer(DockerImageName.parse("mongo:5.0")); } } ``` ```kotlin import org.springframework.boot.test.context.TestConfiguration import org.springframework.context.annotation.Bean import org.testcontainers.mongodb.MongoDBContainer import org.testcontainers.utility.DockerImageName @TestConfiguration(proxyBeanMethods = false) class MyTestConfiguration { @Bean fun mongoDbContainer(): MongoDBContainer { return MongoDBContainer(DockerImageName.parse("mongo:5.0")) } } ``` You can then inject and use the container by importing the configuration class in the test class: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.testcontainers.mongodb.MongoDBContainer; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.context.annotation.Import; @SpringBootTest @Import(MyTestConfiguration.class) class MyIntegrationTests { @Autowired private MongoDBContainer mongo; @Test void myTest() { ... } } ``` ```kotlin import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.test.context.SpringBootTest import org.springframework.context.annotation.Import import org.testcontainers.mongodb.MongoDBContainer @SpringBootTest @Import(MyTestConfiguration::class) class MyIntegrationTests { @Autowired private val mongo: MongoDBContainer? = null @Test fun myTest() { ... } } ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | This method of managing containers is often used in combination with [service connection annotations](#testing.testcontainers.service-connections). | ## [](#testing.testcontainers.junit-extension)Using the JUnit Extension Testcontainers provides a JUnit extension which can be used to manage containers in your tests. The extension is activated by applying the [`@Testcontainers`](https://javadoc.io/doc/org.testcontainers/junit-jupiter/2.0.5/org/testcontainers/junit/jupiter/Testcontainers.html) annotation from Testcontainers to your test class. You can then use the [`@Container`](https://javadoc.io/doc/org.testcontainers/junit-jupiter/2.0.5/org/testcontainers/junit/jupiter/Container.html) annotation on static container fields. The [`@Testcontainers`](https://javadoc.io/doc/org.testcontainers/junit-jupiter/2.0.5/org/testcontainers/junit/jupiter/Testcontainers.html) annotation can be used on vanilla JUnit tests, or in combination with [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html): * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.testcontainers.junit.jupiter.Container; import org.testcontainers.junit.jupiter.Testcontainers; import org.testcontainers.neo4j.Neo4jContainer; import org.springframework.boot.test.context.SpringBootTest; @Testcontainers @SpringBootTest class MyIntegrationTests { @Container static Neo4jContainer neo4j = new Neo4jContainer("neo4j:5"); @Test void myTest() { ... } } ``` ```kotlin import org.junit.jupiter.api.Test; import org.testcontainers.junit.jupiter.Container; import org.testcontainers.junit.jupiter.Testcontainers; import org.testcontainers.neo4j.Neo4jContainer; import org.springframework.boot.test.context.SpringBootTest; @Testcontainers @SpringBootTest class MyIntegrationTests { @Test fun myTest() { ... } companion object { @Container @JvmStatic val neo4j = Neo4jContainer("neo4j:5"); } } ``` The example above will start up a Neo4j container before any of the tests are run. The lifecycle of the container instance is managed by Testcontainers, as described in [their official documentation](https://java.testcontainers.org/test_framework_integration/junit_5/#extension). When using the JUnit extension, container instances are stopped after the test class has run (for static fields) or after each test method (for non-static fields). This can cause issues when used with Spring Boot tests, as Spring’s TestContext Framework may cache the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) beyond that point and reuse it for another test class or method with the same configuration. If the cached application context contains beans that depend on a container that has already been stopped, later tests or bean destruction callbacks may fail. For this reason, you should prefer [managing containers as Spring beans](#testing.testcontainers.spring-beans) or [importing container declarations](#testing.testcontainers.importing-configuration-interfaces) when the application context should remain usable for as long as it is cached. | | | | -- | -------------------------------------------------------------------------------------------------------------------------- | | ** | In most cases, you will additionally need to configure the application to connect to the service running in the container. | ## [](#testing.testcontainers.importing-configuration-interfaces)Importing Container Configuration Interfaces A common pattern with Testcontainers is to declare the container instances as static fields in an interface. For example, the following interface declares two containers, one named `mongo` of type [`MongoDBContainer`](https://javadoc.io/doc/org.testcontainers/mongodb/2.0.5/org/testcontainers/mongodb/MongoDBContainer.html) and another named `neo4j` of type [`Neo4jContainer`](https://javadoc.io/doc/org.testcontainers/neo4j/2.0.5/org/testcontainers/neo4j/Neo4jContainer.html): * Java * Kotlin ```java import org.testcontainers.junit.jupiter.Container; import org.testcontainers.mongodb.MongoDBContainer; import org.testcontainers.neo4j.Neo4jContainer; interface MyContainers { @Container MongoDBContainer mongoContainer = new MongoDBContainer("mongo:5.0"); @Container Neo4jContainer neo4jContainer = new Neo4jContainer("neo4j:5"); } ``` ```kotlin import org.testcontainers.junit.jupiter.Container import org.testcontainers.mongodb.MongoDBContainer import org.testcontainers.neo4j.Neo4jContainer interface MyContainers { companion object { @Container val mongoContainer: MongoDBContainer = MongoDBContainer("mongo:5.0") @Container val neo4jContainer: Neo4jContainer = Neo4jContainer("neo4j:5") } } ``` When you have containers declared in this way, you can reuse their configuration in multiple tests by having the test classes implement the interface. It’s also possible to use the same interface configuration in your Spring Boot tests. To do so, add [`@ImportTestcontainers`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/context/ImportTestcontainers.html) to your test configuration class: * Java * Kotlin ```java import org.springframework.boot.test.context.TestConfiguration; import org.springframework.boot.testcontainers.context.ImportTestcontainers; @TestConfiguration(proxyBeanMethods = false) @ImportTestcontainers(MyContainers.class) class MyTestConfiguration { } ``` ```kotlin import org.springframework.boot.test.context.TestConfiguration import org.springframework.boot.testcontainers.context.ImportTestcontainers @TestConfiguration(proxyBeanMethods = false) @ImportTestcontainers(MyContainers::class) class MyTestConfiguration { } ``` ## [](#testing.testcontainers.lifecycle)Lifecycle of Managed Containers If you have used the annotations and extensions provided by Testcontainers, then the lifecycle of container instances is managed entirely by Testcontainers. Please refer to the [official Testcontainers documentation](https://java.testcontainers.org) for the information. When the containers are managed by Spring as beans, then their lifecycle is managed by Spring: * Container beans are created and started before all other beans. * Container beans are stopped after the destruction of all other beans. This process ensures that any beans, which rely on functionality provided by the containers, can use those functionalities. It also ensures that they are cleaned up whilst the container is still available. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | When your application beans rely on functionality of containers, prefer configuring the containers as Spring beans to ensure the correct lifecycle behavior. | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Having containers managed by Testcontainers instead of as Spring beans provides no guarantee of the order in which beans and containers will shutdown. It can happen that containers are shutdown before the beans relying on container functionality are cleaned up. This can lead to exceptions being thrown by client beans, for example, due to loss of connection. When the application context should remain usable for as long as it is cached, prefer managing containers as Spring beans or importing container declarations with [`@ImportTestcontainers`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/context/ImportTestcontainers.html). | Container beans are created and started once per application context managed by Spring’s TestContext Framework. For details about how the TestContext Framework manages the underlying application contexts and beans therein, please refer to the [Spring Framework documentation](https://docs.spring.io/spring-framework/reference/7.0). Container beans are stopped as part of the TestContext Framework’s standard application context shutdown process. When the application context gets shutdown, the containers are shutdown as well. This usually happens after all tests using that specific cached application context have finished executing. It may also happen earlier, depending on the caching behavior configured in the TestContext Framework. | | | | -- | ------------------------------------------------------------------------------------------------------------------ | | ** | A single test container instance can, and often is, retained across execution of tests from multiple test classes. | ## [](#testing.testcontainers.service-connections)Service Connections A service connection is a connection to any remote service. Spring Boot’s auto-configuration can consume the details of a service connection and use them to establish a connection to a remote service. When doing so, the connection details take precedence over any connection-related configuration properties. When using Testcontainers, connection details can be automatically created for a service running in a container by annotating the container field in the test class. * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.testcontainers.junit.jupiter.Container; import org.testcontainers.junit.jupiter.Testcontainers; import org.testcontainers.neo4j.Neo4jContainer; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.testcontainers.service.connection.ServiceConnection; @Testcontainers @SpringBootTest class MyIntegrationTests { @Container @ServiceConnection static Neo4jContainer neo4j = new Neo4jContainer("neo4j:5"); @Test void myTest() { ... } } ``` ```kotlin import org.junit.jupiter.api.Test; import org.testcontainers.junit.jupiter.Container; import org.testcontainers.junit.jupiter.Testcontainers; import org.testcontainers.neo4j.Neo4jContainer; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.testcontainers.service.connection.ServiceConnection; @Testcontainers @SpringBootTest class MyIntegrationTests { @Test fun myTest() { ... } companion object { @Container @ServiceConnection @JvmStatic val neo4j = Neo4jContainer("neo4j:5"); } } ``` Thanks to [`@ServiceConnection`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/service/connection/ServiceConnection.html), the above configuration allows Neo4j-related beans in the application to communicate with Neo4j running inside the Testcontainers-managed Docker container. This is done by automatically defining a [`Neo4jConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/neo4j/autoconfigure/Neo4jConnectionDetails.html) bean which is then used by the Neo4j auto-configuration, overriding any connection-related configuration properties. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------- | | ** | You’ll need to add the `spring-boot-testcontainers` module as a test dependency in order to use service connections with Testcontainers. | Service connection annotations are processed by [`ContainerConnectionDetailsFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/service/connection/ContainerConnectionDetailsFactory.html) classes registered with `spring.factories`. A [`ContainerConnectionDetailsFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/service/connection/ContainerConnectionDetailsFactory.html) can create a [`ConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/service/connection/ConnectionDetails.html) bean based on a specific [`Container`](https://javadoc.io/doc/org.testcontainers/testcontainers/2.0.5/org/testcontainers/containers/Container.html) subclass, or the Docker image name. The following service connection factories are provided in the `spring-boot-testcontainers` jar: | Connection Details | Matched on | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`ActiveMQConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/activemq/autoconfigure/ActiveMQConnectionDetails.html) | Containers named "symptoma/activemq" or [`ActiveMQContainer`](https://javadoc.io/doc/org.testcontainers/activemq/2.0.5/org/testcontainers/activemq/ActiveMQContainer.html) | | [`ArtemisConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/artemis/autoconfigure/ArtemisConnectionDetails.html) | Containers of type [`ArtemisContainer`](https://javadoc.io/doc/org.testcontainers/activemq/2.0.5/org/testcontainers/activemq/ArtemisContainer.html) | | [`CassandraConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/cassandra/autoconfigure/CassandraConnectionDetails.html) | Containers of type [`CassandraContainer`](https://javadoc.io/doc/org.testcontainers/testcontainers/2.0.5/org/testcontainers/cassandra/CassandraContainer.html) | | [`CouchbaseConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/couchbase/autoconfigure/CouchbaseConnectionDetails.html) | Containers of type [`CouchbaseContainer`](https://javadoc.io/doc/org.testcontainers/couchbase/2.0.5/org/testcontainers/couchbase/CouchbaseContainer.html) | | [`ElasticsearchConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/elasticsearch/autoconfigure/ElasticsearchConnectionDetails.html) | Containers of type [`ElasticsearchContainer`](https://javadoc.io/doc/org.testcontainers/elasticsearch/2.0.5/org/testcontainers/elasticsearch/ElasticsearchContainer.html) | | [`FlywayConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/flyway/autoconfigure/FlywayConnectionDetails.html) | Containers of type [`JdbcDatabaseContainer`](https://javadoc.io/doc/org.testcontainers/jdbc/2.0.5/org/testcontainers/containers/JdbcDatabaseContainer.html) | | [`JdbcConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/autoconfigure/JdbcConnectionDetails.html) | Containers of type [`JdbcDatabaseContainer`](https://javadoc.io/doc/org.testcontainers/jdbc/2.0.5/org/testcontainers/containers/JdbcDatabaseContainer.html) | | [`KafkaConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/kafka/autoconfigure/KafkaConnectionDetails.html) | Containers of type [`KafkaContainer`](https://javadoc.io/doc/org.testcontainers/kafka/2.0.5/org/testcontainers/kafka/KafkaContainer.html), [`ConfluentKafkaContainer`](https://javadoc.io/doc/org.testcontainers/kafka/2.0.5/org/testcontainers/kafka/ConfluentKafkaContainer.html) or [`RedpandaContainer`](https://javadoc.io/doc/org.testcontainers/redpanda/2.0.5/org/testcontainers/redpanda/RedpandaContainer.html) | | [`LdapConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ldap/autoconfigure/LdapConnectionDetails.html) | Containers named "osixia/openldap" or of type [`LLdapContainer`](https://javadoc.io/doc/org.testcontainers/testcontainers/2.0.5/org/testcontainers/ldap/LLdapContainer.html) | | [`LiquibaseConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/liquibase/autoconfigure/LiquibaseConnectionDetails.html) | Containers of type [`JdbcDatabaseContainer`](https://javadoc.io/doc/org.testcontainers/jdbc/2.0.5/org/testcontainers/containers/JdbcDatabaseContainer.html) | | [`MongoConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/mongodb/autoconfigure/MongoConnectionDetails.html) | Containers of type [`MongoDBContainer`](https://javadoc.io/doc/org.testcontainers/mongodb/2.0.5/org/testcontainers/mongodb/MongoDBContainer.html) or [`MongoDBAtlasLocalContainer`](https://javadoc.io/doc/org.testcontainers/mongodb/2.0.5/org/testcontainers/mongodb/MongoDBAtlasLocalContainer.html) | | [`Neo4jConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/neo4j/autoconfigure/Neo4jConnectionDetails.html) | Containers of type [`Neo4jContainer`](https://javadoc.io/doc/org.testcontainers/neo4j/2.0.5/org/testcontainers/neo4j/Neo4jContainer.html) | | [`OtlpLoggingConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/opentelemetry/autoconfigure/logging/otlp/OtlpLoggingConnectionDetails.html) | Containers named "otel/opentelemetry-collector-contrib" or of type [`LgtmStackContainer`](https://javadoc.io/doc/org.testcontainers/grafana/2.0.5/org/testcontainers/grafana/LgtmStackContainer.html) | | [`OtlpMetricsConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/metrics/autoconfigure/export/otlp/OtlpMetricsConnectionDetails.html) | Containers named "otel/opentelemetry-collector-contrib" or of type [`LgtmStackContainer`](https://javadoc.io/doc/org.testcontainers/grafana/2.0.5/org/testcontainers/grafana/LgtmStackContainer.html) | | [`OtlpTracingConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/tracing/opentelemetry/autoconfigure/otlp/OtlpTracingConnectionDetails.html) | Containers named "otel/opentelemetry-collector-contrib" or of type [`LgtmStackContainer`](https://javadoc.io/doc/org.testcontainers/grafana/2.0.5/org/testcontainers/grafana/LgtmStackContainer.html) | | [`PulsarConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/pulsar/autoconfigure/PulsarConnectionDetails.html) | Containers of type [`PulsarContainer`](https://javadoc.io/doc/org.testcontainers/pulsar/2.0.5/org/testcontainers/pulsar/PulsarContainer.html) | | [`R2dbcConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/r2dbc/autoconfigure/R2dbcConnectionDetails.html) | Containers of type [`ClickHouseContainer`](https://javadoc.io/doc/org.testcontainers/clickhouse/2.0.5/org/testcontainers/clickhouse/ClickHouseContainer.html), [`MariaDBContainer`](https://javadoc.io/doc/org.testcontainers/mariadb/2.0.5/org/testcontainers/mariadb/MariaDBContainer.html), [`MSSQLServerContainer`](https://javadoc.io/doc/org.testcontainers/mssqlserver/2.0.5/org/testcontainers/mssqlserver/MSSQLServerContainer.html), [`MySQLContainer`](https://javadoc.io/doc/org.testcontainers/mysql/2.0.5/org/testcontainers/mysql/MySQLContainer.html), [OracleContainer (free)](https://javadoc.io/doc/org.testcontainers/oracle-free/2.0.5/org/testcontainers/oracle/OracleContainer.html), [OracleContainer (XE)](https://javadoc.io/doc/org.testcontainers/oracle-xe/2.0.5/org/testcontainers/containers/OracleContainer.html) or [`PostgreSQLContainer`](https://javadoc.io/doc/org.testcontainers/postgresql/2.0.5/org/testcontainers/postgresql/PostgreSQLContainer.html) | | [`RabbitConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/amqp/autoconfigure/RabbitConnectionDetails.html) | Containers of type [`RabbitMQContainer`](https://javadoc.io/doc/org.testcontainers/rabbitmq/2.0.5/org/testcontainers/rabbitmq/RabbitMQContainer.html) | | [`RabbitStreamConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/amqp/autoconfigure/RabbitStreamConnectionDetails.html) | Containers of type [`RabbitMQContainer`](https://javadoc.io/doc/org.testcontainers/rabbitmq/2.0.5/org/testcontainers/rabbitmq/RabbitMQContainer.html) when the `@ServiceConnection` `type` attribute includes [`RabbitStreamConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/amqp/autoconfigure/RabbitStreamConnectionDetails.html) | | [`DataRedisConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/redis/autoconfigure/DataRedisConnectionDetails.html) | Containers of type [`RedisContainer`](https://javadoc.io/doc/com.redis/testcontainers-redis/2.2.4/com/redis/testcontainers/RedisContainer.html) or [`RedisStackContainer`](https://javadoc.io/doc/com.redis/testcontainers-redis/2.2.4/com/redis/testcontainers/RedisStackContainer.html), or containers named "redis", "redis/redis-stack" or "redis/redis-stack-server" | | [`ZipkinConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/zipkin/autoconfigure/ZipkinConnectionDetails.html) | Containers named "openzipkin/zipkin" | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | By default, with the exception of [`RabbitStreamConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/amqp/autoconfigure/RabbitStreamConnectionDetails.html), all applicable connection details beans will be created for a given [`Container`](https://javadoc.io/doc/org.testcontainers/testcontainers/2.0.5/org/testcontainers/containers/Container.html). For example, a [`PostgreSQLContainer`](https://javadoc.io/doc/org.testcontainers/postgresql/2.0.5/org/testcontainers/postgresql/PostgreSQLContainer.html) will create both [`JdbcConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/autoconfigure/JdbcConnectionDetails.html) and [`R2dbcConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/r2dbc/autoconfigure/R2dbcConnectionDetails.html).If you want to create only a subset of the applicable types, you can use the `type` attribute of [`@ServiceConnection`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/service/connection/ServiceConnection.html).To create a [`RabbitStreamConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/amqp/autoconfigure/RabbitStreamConnectionDetails.html) bean from a [`RabbitMQContainer`](https://javadoc.io/doc/org.testcontainers/rabbitmq/2.0.5/org/testcontainers/rabbitmq/RabbitMQContainer.html), you must opt in using the `type` attribute of [`@ServiceConnection`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/service/connection/ServiceConnection.html). The container must also expose port 5552, or port 5551 when SSL is configured, for RabbitMQ Streams. | By default `Container.getDockerImageName().getRepository()` is used to obtain the name used to find connection details. The repository portion of the Docker image name ignores any registry and the version. This works as long as Spring Boot is able to get the instance of the [`Container`](https://javadoc.io/doc/org.testcontainers/testcontainers/2.0.5/org/testcontainers/containers/Container.html), which is the case when using a `static` field like in the example above. If you’re using a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) method, Spring Boot won’t call the bean method to get the Docker image name, because this would cause eager initialization issues. Instead, the return type of the bean method is used to find out which connection detail should be used. This works as long as you’re using typed containers such as [`Neo4jContainer`](https://javadoc.io/doc/org.testcontainers/neo4j/2.0.5/org/testcontainers/neo4j/Neo4jContainer.html) or [`RabbitMQContainer`](https://javadoc.io/doc/org.testcontainers/rabbitmq/2.0.5/org/testcontainers/rabbitmq/RabbitMQContainer.html). This stops working if you’re using [`GenericContainer`](https://javadoc.io/doc/org.testcontainers/testcontainers/2.0.5/org/testcontainers/containers/GenericContainer.html), for example with Redis as shown in the following example: * Java * Kotlin ```java import org.testcontainers.containers.GenericContainer; import org.springframework.boot.test.context.TestConfiguration; import org.springframework.boot.testcontainers.service.connection.ServiceConnection; import org.springframework.context.annotation.Bean; @TestConfiguration(proxyBeanMethods = false) public class MyRedisConfiguration { @Bean @ServiceConnection(name = "redis") public GenericContainer redisContainer() { return new GenericContainer<>("redis:7"); } } ``` ```kotlin import org.springframework.boot.test.context.TestConfiguration import org.springframework.boot.testcontainers.service.connection.ServiceConnection import org.springframework.context.annotation.Bean import org.testcontainers.containers.GenericContainer @TestConfiguration(proxyBeanMethods = false) class MyRedisConfiguration { @Bean @ServiceConnection(name = "redis") fun redisContainer(): GenericContainer<*> { return GenericContainer("redis:7") } } ``` Spring Boot can’t tell from [`GenericContainer`](https://javadoc.io/doc/org.testcontainers/testcontainers/2.0.5/org/testcontainers/containers/GenericContainer.html) which container image is used, so the `name` attribute from [`@ServiceConnection`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/service/connection/ServiceConnection.html) must be used to provide that hint. You can also use the `name` attribute of [`@ServiceConnection`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/service/connection/ServiceConnection.html) to override which connection detail will be used, for example when using custom images. If you are using the Docker image `registry.mycompany.com/mirror/myredis`, you’d use `@ServiceConnection(name="redis")` to ensure [`DataRedisConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/redis/autoconfigure/DataRedisConnectionDetails.html) are created. ### [](#testing.testcontainers.service-connections.ssl)SSL with Service Connections You can use the [`@Ssl`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/service/connection/Ssl.html), [`@JksKeyStore`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/service/connection/JksKeyStore.html), [`@JksTrustStore`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/service/connection/JksTrustStore.html), [`@PemKeyStore`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/service/connection/PemKeyStore.html) and [`@PemTrustStore`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/service/connection/PemTrustStore.html) annotations on a supported container to enable SSL support for that service connection. Please note that you still have to enable SSL on the service which is running inside the Testcontainer yourself, the annotations only configure SSL on the client side in your application. ```java import com.redis.testcontainers.RedisContainer; import org.junit.jupiter.api.Test; import org.testcontainers.junit.jupiter.Container; import org.testcontainers.junit.jupiter.Testcontainers; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.testcontainers.service.connection.PemKeyStore; import org.springframework.boot.testcontainers.service.connection.PemTrustStore; import org.springframework.boot.testcontainers.service.connection.ServiceConnection; import org.springframework.data.redis.core.RedisOperations; @Testcontainers @SpringBootTest class MyRedisWithSslIntegrationTests { @Container @ServiceConnection @PemKeyStore(certificate = "classpath:client.crt", privateKey = "classpath:client.key") @PemTrustStore("classpath:ca.crt") static RedisContainer redis = new SecureRedisContainer("redis:latest"); @Autowired private RedisOperations operations; @Test void testRedis() { // ... } } ``` The above code uses the [`@PemKeyStore`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/service/connection/PemKeyStore.html) annotation to load the client certificate and key into the keystore and the and [`@PemTrustStore`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/service/connection/PemTrustStore.html) annotation to load the CA certificate into the truststore. This will authenticate the client against the server, and the CA certificate in the truststore makes sure that the server certificate is valid and trusted. The `SecureRedisContainer` in this example is a custom subclass of `RedisContainer` which copies certificates to the correct places and invokes `redis-server` with commandline parameters enabling SSL. The SSL annotations are supported for the following service connections: * Cassandra * Couchbase * Elasticsearch * Kafka * MongoDB * OpenTelemetry (OTLP logging, metrics, and tracing) * RabbitMQ * RabbitMQ Streams * Redis The `ElasticsearchContainer` additionally supports automatic detection of server side SSL. To use this feature, annotate the container with [`@Ssl`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/testcontainers/service/connection/Ssl.html), as seen in the following example, and Spring Boot takes care of the client side SSL configuration for you: ```java import org.junit.jupiter.api.Test; import org.testcontainers.elasticsearch.ElasticsearchContainer; import org.testcontainers.junit.jupiter.Container; import org.testcontainers.junit.jupiter.Testcontainers; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.data.elasticsearch.test.autoconfigure.DataElasticsearchTest; import org.springframework.boot.testcontainers.service.connection.ServiceConnection; import org.springframework.boot.testcontainers.service.connection.Ssl; import org.springframework.data.elasticsearch.client.elc.ElasticsearchTemplate; @Testcontainers @DataElasticsearchTest class MyElasticsearchWithSslIntegrationTests { @Ssl @Container @ServiceConnection static ElasticsearchContainer elasticsearch = new ElasticsearchContainer( "docker.elastic.co/elasticsearch/elasticsearch:8.17.2"); @Autowired private ElasticsearchTemplate elasticsearchTemplate; @Test void testElasticsearch() { // ... } } ``` ## [](#testing.testcontainers.dynamic-properties)Dynamic Properties A slightly more verbose but also more flexible alternative to service connections is [`@DynamicPropertySource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/context/DynamicPropertySource.html). A static [`@DynamicPropertySource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/context/DynamicPropertySource.html) method allows adding dynamic property values to the Spring Environment. * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.testcontainers.junit.jupiter.Container; import org.testcontainers.junit.jupiter.Testcontainers; import org.testcontainers.neo4j.Neo4jContainer; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.DynamicPropertyRegistry; import org.springframework.test.context.DynamicPropertySource; @Testcontainers @SpringBootTest class MyIntegrationTests { @Container static Neo4jContainer neo4j = new Neo4jContainer("neo4j:5"); @Test void myTest() { // ... } @DynamicPropertySource static void neo4jProperties(DynamicPropertyRegistry registry) { registry.add("spring.neo4j.uri", neo4j::getBoltUrl); } } ``` ```kotlin import org.junit.jupiter.api.Test import org.springframework.boot.test.context.SpringBootTest import org.springframework.test.context.DynamicPropertyRegistry import org.springframework.test.context.DynamicPropertySource import org.testcontainers.junit.jupiter.Container import org.testcontainers.junit.jupiter.Testcontainers import org.testcontainers.neo4j.Neo4jContainer @Testcontainers @SpringBootTest class MyIntegrationTests { @Test fun myTest() { ... } companion object { @Container @JvmStatic val neo4j = Neo4jContainer("neo4j:5"); @DynamicPropertySource @JvmStatic fun neo4jProperties(registry: DynamicPropertyRegistry) { registry.add("spring.neo4j.uri") { neo4j.boltUrl } } } } ``` The above configuration allows Neo4j-related beans in the application to communicate with Neo4j running inside the Testcontainers-managed Docker container. * [Spring Boot](../../index.html) * [4.1.1](testcontainers.html) * [4.0.8](../../4.0/reference/testing/testcontainers.html) * [3.5.16](../../3.5/reference/testing/testcontainers.html) * [3.4.13](../../3.4/reference/testing/testcontainers.html) * [3.3.13](../../3.3/reference/testing/testcontainers.html) - [4.2.0-M2](../../4.2/reference/testing/testcontainers.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/testing/testcontainers.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/testing/testcontainers.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/testing/testcontainers.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/actuator/metrics.html ---- # Metrics Spring Boot Actuator provides dependency management and auto-configuration for [Micrometer](https://micrometer.io), an application metrics facade that supports [numerous monitoring systems](https://docs.micrometer.io/micrometer/reference/1.17), including: * [AppOptics](#actuator.metrics.export.appoptics) * [Atlas](#actuator.metrics.export.atlas) * [Datadog](#actuator.metrics.export.datadog) * [Dynatrace](#actuator.metrics.export.dynatrace) * [Elastic](#actuator.metrics.export.elastic) * [Ganglia](#actuator.metrics.export.ganglia) * [Graphite](#actuator.metrics.export.graphite) * [Humio](#actuator.metrics.export.humio) * [Influx](#actuator.metrics.export.influx) * [JMX](#actuator.metrics.export.jmx) * [KairosDB](#actuator.metrics.export.kairos) * [New Relic](#actuator.metrics.export.newrelic) * [OTLP](#actuator.metrics.export.otlp) * [Prometheus](#actuator.metrics.export.prometheus) * [Simple](#actuator.metrics.export.simple) (in-memory) * [Stackdriver](#actuator.metrics.export.stackdriver) * [StatsD](#actuator.metrics.export.statsd) | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | To learn more about Micrometer’s capabilities, see its [reference documentation](https://docs.micrometer.io/micrometer/reference/1.17), in particular the [concepts section](https://docs.micrometer.io/micrometer/reference/1.17/concepts). | ## [](#actuator.metrics.getting-started)Getting Started Spring Boot auto-configures a composite [`MeterRegistry`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/MeterRegistry.html) and adds a registry to the composite for each of the supported implementations that it finds on the classpath. Having a dependency on `micrometer-registry-{system}` in your runtime classpath is enough for Spring Boot to configure the registry. Most registries share common features. For instance, you can disable a particular registry even if the Micrometer registry implementation is on the classpath. The following example disables Datadog: * Properties * YAML ```properties management.datadog.metrics.export.enabled=false ``` ```yaml management: datadog: metrics: export: enabled: false ``` You can also disable all registries unless stated otherwise by the registry-specific property, as the following example shows: * Properties * YAML ```properties management.defaults.metrics.export.enabled=false ``` ```yaml management: defaults: metrics: export: enabled: false ``` Spring Boot also adds any auto-configured registries to the global static composite registry on the [`Metrics`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/Metrics.html) class, unless you explicitly tell it not to: * Properties * YAML ```properties management.metrics.use-global-registry=false ``` ```yaml management: metrics: use-global-registry: false ``` You can register any number of [`MeterRegistryCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/metrics/autoconfigure/MeterRegistryCustomizer.html) beans to further configure the registry, such as applying common tags, before any meters are registered with the registry: * Java * Kotlin ```java import io.micrometer.core.instrument.MeterRegistry; import org.springframework.boot.micrometer.metrics.autoconfigure.MeterRegistryCustomizer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyMeterRegistryConfiguration { @Bean public MeterRegistryCustomizer metricsCommonTags() { return (registry) -> registry.config().commonTags("region", "us-east-1"); } } ``` ```kotlin import io.micrometer.core.instrument.MeterRegistry import org.springframework.boot.micrometer.metrics.autoconfigure.MeterRegistryCustomizer import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyMeterRegistryConfiguration { @Bean fun metricsCommonTags(): MeterRegistryCustomizer { return MeterRegistryCustomizer { registry -> registry.config().commonTags("region", "us-east-1") } } } ``` You can apply customizations to particular registry implementations by being more specific about the generic type: * Java * Kotlin ```java import io.micrometer.core.instrument.Meter; import io.micrometer.core.instrument.config.NamingConvention; import io.micrometer.graphite.GraphiteMeterRegistry; import org.springframework.boot.micrometer.metrics.autoconfigure.MeterRegistryCustomizer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyMeterRegistryConfiguration { @Bean public MeterRegistryCustomizer graphiteMetricsNamingConvention() { return (registry) -> registry.config().namingConvention(this::name); } private String name(String name, Meter.Type type, String baseUnit) { return ... } } ``` ```kotlin import io.micrometer.core.instrument.Meter import io.micrometer.core.instrument.config.NamingConvention import io.micrometer.graphite.GraphiteMeterRegistry import org.springframework.boot.micrometer.metrics.autoconfigure.MeterRegistryCustomizer import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyMeterRegistryConfiguration { @Bean fun graphiteMetricsNamingConvention(): MeterRegistryCustomizer { return MeterRegistryCustomizer { registry: GraphiteMeterRegistry -> registry.config().namingConvention(this::name) } } private fun name(name: String, type: Meter.Type, baseUnit: String?): String { return ... } } ``` Spring Boot also [configures built-in instrumentation](#actuator.metrics.supported) that you can control through configuration or dedicated annotation markers. ## [](#actuator.metrics.export)Supported Monitoring Systems This section briefly describes each of the supported monitoring systems. ### [](#actuator.metrics.export.appoptics)AppOptics By default, the AppOptics registry periodically pushes metrics to `api.appoptics.com/v1/measurements`. To export metrics to SaaS [AppOptics](https://docs.micrometer.io/micrometer/reference/1.17/implementations/appOptics), your API token must be provided: * Properties * YAML ```properties management.appoptics.metrics.export.api-token=YOUR_TOKEN ``` ```yaml management: appoptics: metrics: export: api-token: "YOUR_TOKEN" ``` ### [](#actuator.metrics.export.atlas)Atlas By default, metrics are exported to [Atlas](https://docs.micrometer.io/micrometer/reference/1.17/implementations/atlas) running on your local machine. You can provide the location of the [Atlas server](https://github.com/Netflix/atlas): * Properties * YAML ```properties management.atlas.metrics.export.uri=https://atlas.example.com:7101/api/v1/publish ``` ```yaml management: atlas: metrics: export: uri: "https://atlas.example.com:7101/api/v1/publish" ``` ### [](#actuator.metrics.export.datadog)Datadog A Datadog registry periodically pushes metrics to [datadoghq](https://www.datadoghq.com). To export metrics to [Datadog](https://docs.micrometer.io/micrometer/reference/1.17/implementations/datadog), you must provide your API key: * Properties * YAML ```properties management.datadog.metrics.export.api-key=YOUR_KEY ``` ```yaml management: datadog: metrics: export: api-key: "YOUR_KEY" ``` If you additionally provide an application key (optional), then metadata such as meter descriptions, types, and base units will also be exported: * Properties * YAML ```properties management.datadog.metrics.export.api-key=YOUR_API_KEY management.datadog.metrics.export.application-key=YOUR_APPLICATION_KEY ``` ```yaml management: datadog: metrics: export: api-key: "YOUR_API_KEY" application-key: "YOUR_APPLICATION_KEY" ``` By default, metrics are sent to the Datadog US [site](https://docs.datadoghq.com/getting_started/site) (`api.datadoghq.com`). If your Datadog project is hosted on one of the other sites, or you need to send metrics through a proxy, configure the URI accordingly: * Properties * YAML ```properties management.datadog.metrics.export.uri=https://api.datadoghq.eu ``` ```yaml management: datadog: metrics: export: uri: "https://api.datadoghq.eu" ``` You can also change the interval at which metrics are sent to Datadog: * Properties * YAML ```properties management.datadog.metrics.export.step=30s ``` ```yaml management: datadog: metrics: export: step: "30s" ``` ### [](#actuator.metrics.export.dynatrace)Dynatrace Dynatrace offers two metrics ingest APIs, both of which are implemented for [Micrometer](https://docs.micrometer.io/micrometer/reference/1.17/implementations/dynatrace). You can find the Dynatrace documentation on Micrometer metrics ingest [here](https://docs.dynatrace.com/docs/shortlink/micrometer-metrics-ingest). Configuration properties in the `v1` namespace apply only when exporting to the [Timeseries v1 API](https://docs.dynatrace.com/docs/shortlink/api-metrics). Support for the V1 API is deprecated. Configuration properties in the `v2` namespace apply only when exporting to the [Metrics v2 API](https://docs.dynatrace.com/docs/shortlink/api-metrics-v2-post-datapoints). Note that this integration can export only to either the `v1` or `v2` version of the API at a time, with `v2` being strongly recommended due to the deprecation of the v1 API. If the `device-id` (required for v1 but not used in v2) is set in the `v1` namespace, metrics are exported to the `v1` endpoint. Otherwise, `v2` is assumed. #### [](#actuator.metrics.export.dynatrace.v2-api)v2 API You can use the v2 API in two ways. ##### [](#actuator.metrics.export.dynatrace.v2-api.auto-config)Auto-configuration Dynatrace auto-configuration is available for hosts that are monitored by the OneAgent or by the Dynatrace Operator for Kubernetes. **Local OneAgent:** If a OneAgent is running on the host, metrics are automatically exported to the [local OneAgent ingest endpoint](https://docs.dynatrace.com/docs/shortlink/local-api). The ingest endpoint forwards the metrics to the Dynatrace backend. **Dynatrace Kubernetes Operator:** When running in Kubernetes with the Dynatrace Operator installed, the registry will automatically pick up your endpoint URI and API token from the operator instead. This is the default behavior and requires no special setup beyond a dependency on `io.micrometer:micrometer-registry-dynatrace`. ##### [](#actuator.metrics.export.dynatrace.v2-api.manual-config)Manual Configuration If no auto-configuration is available, the endpoint of the [Metrics v2 API](https://docs.dynatrace.com/docs/shortlink/api-metrics-v2-post-datapoints) and an API token are required. The [API token](https://docs.dynatrace.com/docs/shortlink/api-authentication) must have the “Ingest metrics” (`metrics.ingest`) permission set. We recommend limiting the scope of the token to this one permission. You must ensure that the endpoint URI contains the path (for example, `/api/v2/metrics/ingest`): The URL of the Metrics API v2 ingest endpoint is different according to your deployment option: * SaaS: `https://{your-environment-id}.live.dynatrace.com/api/v2/metrics/ingest` * Managed deployments: `https://{your-domain}/e/{your-environment-id}/api/v2/metrics/ingest` The example below configures metrics export using the `example` environment id: * Properties * YAML ```properties management.dynatrace.metrics.export.uri=https://example.live.dynatrace.com/api/v2/metrics/ingest management.dynatrace.metrics.export.api-token=YOUR_TOKEN ``` ```yaml management: dynatrace: metrics: export: uri: "https://example.live.dynatrace.com/api/v2/metrics/ingest" api-token: "YOUR_TOKEN" ``` When using the Dynatrace v2 API, the following optional features are available (more details can be found in the [Dynatrace documentation](https://docs.dynatrace.com/docs/shortlink/micrometer-metrics-ingest#dt-configuration-properties)): * Metric key prefix: Sets a prefix that is prepended to all exported metric keys. * Enrich with Dynatrace metadata: If a OneAgent or Dynatrace operator is running, enrich metrics with additional metadata (for example, about the host, process, or pod). * Default dimensions: Specify key-value pairs that are added to all exported metrics. If tags with the same key are specified with Micrometer, they overwrite the default dimensions. * Use Dynatrace Summary instruments: In some cases the Micrometer Dynatrace registry created metrics that were rejected. In Micrometer 1.9.x, this was fixed by introducing Dynatrace-specific summary instruments. Setting this toggle to `false` forces Micrometer to fall back to the behavior that was the default before 1.9.x. It should only be used when encountering problems while migrating from Micrometer 1.8.x to 1.9.x. * Export meter metadata: Starting from Micrometer 1.12.0, the Dynatrace exporter will also export meter metadata, such as unit and description by default. Use the `export-meter-metadata` toggle to turn this feature off. It is possible to not specify a URI and API token, as shown in the following example. In this scenario, the automatically configured endpoint is used: * Properties * YAML ```properties management.dynatrace.metrics.export.v2.metric-key-prefix=your.key.prefix management.dynatrace.metrics.export.v2.enrich-with-dynatrace-metadata=true management.dynatrace.metrics.export.v2.default-dimensions.key1=value1 management.dynatrace.metrics.export.v2.default-dimensions.key2=value2 management.dynatrace.metrics.export.v2.use-dynatrace-summary-instruments=true management.dynatrace.metrics.export.v2.export-meter-metadata=true ``` ```yaml management: dynatrace: metrics: export: # Specify uri and api-token here if not using the local OneAgent endpoint. v2: metric-key-prefix: "your.key.prefix" enrich-with-dynatrace-metadata: true default-dimensions: key1: "value1" key2: "value2" use-dynatrace-summary-instruments: true # (default: true) export-meter-metadata: true # (default: true) ``` #### [](#actuator.metrics.export.dynatrace.v1-api)v1 API (Deprecated) The Dynatrace v1 API metrics registry pushes metrics to the configured URI periodically by using the [Timeseries v1 API](https://docs.dynatrace.com/docs/shortlink/api-metrics). For backwards-compatibility with existing setups, when `device-id` is set (required for v1, but not used in v2), metrics are exported to the Timeseries v1 endpoint. To export metrics to [Dynatrace](https://docs.micrometer.io/micrometer/reference/1.17/implementations/dynatrace), your API token, device ID, and URI must be provided: * Properties * YAML ```properties management.dynatrace.metrics.export.uri=https://{your-environment-id}.live.dynatrace.com management.dynatrace.metrics.export.api-token=YOUR_TOKEN management.dynatrace.metrics.export.v1.device-id=YOUR_DEVICE_ID ``` ```yaml management: dynatrace: metrics: export: uri: "https://{your-environment-id}.live.dynatrace.com" api-token: "YOUR_TOKEN" v1: device-id: "YOUR_DEVICE_ID" ``` For the v1 API, you must specify the base environment URI without a path, as the v1 endpoint path is added automatically. #### [](#actuator.metrics.export.dynatrace.version-independent-settings)Version-independent Settings In addition to the API endpoint and token, you can also change the interval at which metrics are sent to Dynatrace. The default export interval is `60s`. The following example sets the export interval to 30 seconds: * Properties * YAML ```properties management.dynatrace.metrics.export.step=30s ``` ```yaml management: dynatrace: metrics: export: step: "30s" ``` You can find more information on how to set up the Dynatrace exporter for Micrometer in the [Micrometer documentation](https://docs.micrometer.io/micrometer/reference/1.17/implementations/dynatrace) and the [Dynatrace documentation](https://docs.dynatrace.com/docs/shortlink/micrometer-metrics-ingest). ### [](#actuator.metrics.export.elastic)Elastic By default, metrics are exported to [Elastic](https://docs.micrometer.io/micrometer/reference/1.17/implementations/elastic) running on your local machine. You can provide the location of the Elastic server to use by using the following property: * Properties * YAML ```properties management.elastic.metrics.export.host=https://elastic.example.com:8086 ``` ```yaml management: elastic: metrics: export: host: "https://elastic.example.com:8086" ``` ### [](#actuator.metrics.export.ganglia)Ganglia By default, metrics are exported to [Ganglia](https://docs.micrometer.io/micrometer/reference/1.17/implementations/ganglia) running on your local machine. You can provide the [Ganglia server](http://ganglia.sourceforge.net) host and port, as the following example shows: * Properties * YAML ```properties management.ganglia.metrics.export.host=ganglia.example.com management.ganglia.metrics.export.port=9649 ``` ```yaml management: ganglia: metrics: export: host: "ganglia.example.com" port: 9649 ``` ### [](#actuator.metrics.export.graphite)Graphite By default, metrics are exported to [Graphite](https://docs.micrometer.io/micrometer/reference/1.17/implementations/graphite) running on your local machine. You can provide the [Graphite server](https://graphiteapp.org) host and port, as the following example shows: * Properties * YAML ```properties management.graphite.metrics.export.host=graphite.example.com management.graphite.metrics.export.port=9004 ``` ```yaml management: graphite: metrics: export: host: "graphite.example.com" port: 9004 ``` Micrometer provides a default [`HierarchicalNameMapper`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/util/HierarchicalNameMapper.html) that governs how a dimensional meter ID is [mapped to flat hierarchical names](https://docs.micrometer.io/micrometer/reference/1.17/implementations/graphite#_hierarchical_name_mapping). | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | To take control over this behavior, define your [`GraphiteMeterRegistry`](https://javadoc.io/doc/io.micrometer/micrometer-registry-graphite/1.17.1/io/micrometer/graphite/GraphiteMeterRegistry.html) and supply your own [`HierarchicalNameMapper`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/util/HierarchicalNameMapper.html). Auto-configured [`GraphiteConfig`](https://javadoc.io/doc/io.micrometer/micrometer-registry-graphite/1.17.1/io/micrometer/graphite/GraphiteConfig.html) and [`Clock`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/Clock.html) beans are provided unless you define your own:- Java - Kotlin```java import io.micrometer.core.instrument.Clock; import io.micrometer.core.instrument.Meter; import io.micrometer.core.instrument.config.NamingConvention; import io.micrometer.core.instrument.util.HierarchicalNameMapper; import io.micrometer.graphite.GraphiteConfig; import io.micrometer.graphite.GraphiteMeterRegistry; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyGraphiteConfiguration { @Bean public GraphiteMeterRegistry graphiteMeterRegistry(GraphiteConfig config, Clock clock) { return new GraphiteMeterRegistry(config, clock, this::toHierarchicalName); } private String toHierarchicalName(Meter.Id id, NamingConvention convention) { return ... } } ``````kotlin import io.micrometer.core.instrument.Clock import io.micrometer.core.instrument.Meter import io.micrometer.core.instrument.config.NamingConvention import io.micrometer.core.instrument.util.HierarchicalNameMapper import io.micrometer.graphite.GraphiteConfig import io.micrometer.graphite.GraphiteMeterRegistry import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyGraphiteConfiguration { @Bean fun graphiteMeterRegistry(config: GraphiteConfig, clock: Clock): GraphiteMeterRegistry { return GraphiteMeterRegistry(config, clock, this::toHierarchicalName) } private fun toHierarchicalName(id: Meter.Id, convention: NamingConvention): String { return ... } } ``` | ### [](#actuator.metrics.export.humio)Humio By default, the Humio registry periodically pushes metrics to [cloud.humio.com](https://cloud.humio.com). To export metrics to SaaS [Humio](https://docs.micrometer.io/micrometer/reference/1.17/implementations/humio), you must provide your API token: * Properties * YAML ```properties management.humio.metrics.export.api-token=YOUR_TOKEN ``` ```yaml management: humio: metrics: export: api-token: "YOUR_TOKEN" ``` You should also configure one or more tags to identify the data source to which metrics are pushed: * Properties * YAML ```properties management.humio.metrics.export.tags.alpha=a management.humio.metrics.export.tags.bravo=b ``` ```yaml management: humio: metrics: export: tags: alpha: "a" bravo: "b" ``` ### [](#actuator.metrics.export.influx)Influx By default, metrics are exported to an [Influx](https://docs.micrometer.io/micrometer/reference/1.17/implementations/influx) v1 instance running on your local machine with the default configuration. To export metrics to InfluxDB v2, configure the `org`, `bucket`, and authentication `token` for writing metrics. You can provide the location of the [Influx server](https://www.influxdata.com) to use by using: * Properties * YAML ```properties management.influx.metrics.export.uri=https://influx.example.com:8086 ``` ```yaml management: influx: metrics: export: uri: "https://influx.example.com:8086" ``` ### [](#actuator.metrics.export.jmx)JMX Micrometer provides a hierarchical mapping to [JMX](https://docs.micrometer.io/micrometer/reference/1.17/implementations/jmx), primarily as a cheap and portable way to view metrics locally. By default, metrics are exported to the `metrics` JMX domain. You can provide the domain to use by using: * Properties * YAML ```properties management.jmx.metrics.export.domain=com.example.app.metrics ``` ```yaml management: jmx: metrics: export: domain: "com.example.app.metrics" ``` Micrometer provides a default [`HierarchicalNameMapper`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/util/HierarchicalNameMapper.html) that governs how a dimensional meter ID is [mapped to flat hierarchical names](https://docs.micrometer.io/micrometer/reference/1.17/implementations/jmx#_hierarchical_name_mapping). | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | To take control over this behavior, define your [`JmxMeterRegistry`](https://javadoc.io/doc/io.micrometer/micrometer-registry-jmx/1.17.1/io/micrometer/jmx/JmxMeterRegistry.html) and supply your own [`HierarchicalNameMapper`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/util/HierarchicalNameMapper.html). Auto-configured [`JmxConfig`](https://javadoc.io/doc/io.micrometer/micrometer-registry-jmx/1.17.1/io/micrometer/jmx/JmxConfig.html) and [`Clock`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/Clock.html) beans are provided unless you define your own:- Java - Kotlin```java import io.micrometer.core.instrument.Clock; import io.micrometer.core.instrument.Meter; import io.micrometer.core.instrument.config.NamingConvention; import io.micrometer.core.instrument.util.HierarchicalNameMapper; import io.micrometer.jmx.JmxConfig; import io.micrometer.jmx.JmxMeterRegistry; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyJmxConfiguration { @Bean public JmxMeterRegistry jmxMeterRegistry(JmxConfig config, Clock clock) { return new JmxMeterRegistry(config, clock, this::toHierarchicalName); } private String toHierarchicalName(Meter.Id id, NamingConvention convention) { return ... } } ``````kotlin import io.micrometer.core.instrument.Clock import io.micrometer.core.instrument.Meter import io.micrometer.core.instrument.config.NamingConvention import io.micrometer.core.instrument.util.HierarchicalNameMapper import io.micrometer.jmx.JmxConfig import io.micrometer.jmx.JmxMeterRegistry import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyJmxConfiguration { @Bean fun jmxMeterRegistry(config: JmxConfig, clock: Clock): JmxMeterRegistry { return JmxMeterRegistry(config, clock, this::toHierarchicalName) } private fun toHierarchicalName(id: Meter.Id, convention: NamingConvention): String { return ... } } ``` | ### [](#actuator.metrics.export.kairos)KairosDB By default, metrics are exported to [KairosDB](https://docs.micrometer.io/micrometer/reference/1.17/implementations/kairos) running on your local machine. You can provide the location of the [KairosDB server](https://kairosdb.github.io/) to use by using: * Properties * YAML ```properties management.kairos.metrics.export.uri=https://kairosdb.example.com:8080/api/v1/datapoints ``` ```yaml management: kairos: metrics: export: uri: "https://kairosdb.example.com:8080/api/v1/datapoints" ``` ### [](#actuator.metrics.export.newrelic)New Relic A New Relic registry periodically pushes metrics to [New Relic](https://docs.micrometer.io/micrometer/reference/1.17/implementations/new-relic). To export metrics to [New Relic](https://newrelic.com), you must provide your API key and account ID: * Properties * YAML ```properties management.newrelic.metrics.export.api-key=YOUR_KEY management.newrelic.metrics.export.account-id=YOUR_ACCOUNT_ID ``` ```yaml management: newrelic: metrics: export: api-key: "YOUR_KEY" account-id: "YOUR_ACCOUNT_ID" ``` You can also change the interval at which metrics are sent to New Relic: * Properties * YAML ```properties management.newrelic.metrics.export.step=30s ``` ```yaml management: newrelic: metrics: export: step: "30s" ``` By default, metrics are published through REST calls, but you can also use the Java Agent API if you have it on the classpath: * Properties * YAML ```properties management.newrelic.metrics.export.client-provider-type=insights-agent ``` ```yaml management: newrelic: metrics: export: client-provider-type: "insights-agent" ``` Finally, you can take full control by defining your own [`NewRelicClientProvider`](https://javadoc.io/doc/io.micrometer/micrometer-registry-new-relic/1.17.1/io/micrometer/newrelic/NewRelicClientProvider.html) bean. ### [](#actuator.metrics.export.otlp)OTLP By default, metrics are exported over the [OpenTelemetry protocol (OTLP)](https://docs.micrometer.io/micrometer/reference/1.17/implementations/otlp) to a consumer running on your local machine. To export to another location, provide the location of the [OTLP metrics endpoint](https://opentelemetry.io/) using `management.otlp.metrics.export.url`: * Properties * YAML ```properties management.otlp.metrics.export.url=https://otlp.example.com:4318/v1/metrics ``` ```yaml management: otlp: metrics: export: url: "https://otlp.example.com:4318/v1/metrics" ``` Custom headers, for example for authentication, can also be provided using `management.otlp.metrics.export.headers.*` properties. If an `OtlpMetricsSender` bean is available, it will be configured on the `OtlpMeterRegistry` that Spring Boot auto-configures. [OTLP Exemplars](https://opentelemetry.io/docs/specs/otel/metrics/data-model/#exemplars) are also supported. To enable this feature, an [`ExemplarContextProvider`](https://javadoc.io/doc/io.micrometer/micrometer-registry-otlp/1.17.1/io/micrometer/registry/otlp/ExemplarContextProvider.html) bean should be present. If you use [Micrometer Tracing](tracing.html), this will be auto-configured for you. By default, only sampled traces are included as exemplars. You can control this behavior using the `management.tracing.exemplars.include` property. ### [](#actuator.metrics.export.prometheus)Prometheus [Prometheus](https://docs.micrometer.io/micrometer/reference/1.17/implementations/prometheus) expects to scrape or poll individual application instances for metrics. Spring Boot provides an actuator endpoint at `/actuator/prometheus` to present a [Prometheus scrape](https://prometheus.io) with the appropriate format. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | By default, the endpoint is not available and must be exposed. See [exposing endpoints](endpoints.html#actuator.endpoints.exposing) for more details. | The following example `scrape_config` adds to `prometheus.yml`: ```yaml scrape_configs: - job_name: "spring" metrics_path: "/actuator/prometheus" static_configs: - targets: ["HOST:PORT"] ``` [Prometheus Exemplars](https://prometheus.io/docs/prometheus/latest/feature_flags/#exemplars-storage) are also supported. To enable this feature, a [`SpanContext`](https://javadoc.io/doc/io.prometheus/prometheus-metrics-tracer-common/1.7.0/io/prometheus/metrics/tracer/common/SpanContext.html) bean should be present. If you’re using the deprecated Prometheus simpleclient support and want to enable that feature, a [`SpanContextSupplier`](https://javadoc.io/doc/io.prometheus/simpleclient_tracer_common/0.16.0/io/prometheus/client/exemplars/tracer/common/SpanContextSupplier.html) bean should be present. If you use [Micrometer Tracing](https://docs.micrometer.io/tracing/reference/1.7), this will be auto-configured for you, but you can always create your own if you want. By default, only sampled traces are included as exemplars. You can control this behavior using the `management.tracing.exemplars.include` property. The value `all` is not supported with Prometheus. Please check the [Prometheus Docs](https://prometheus.io/docs/prometheus/latest/feature_flags/#exemplars-storage), since this feature needs to be explicitly enabled on Prometheus' side, and it is only supported using the [OpenMetrics](https://github.com/OpenObservability/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#exemplars) format. For ephemeral or batch jobs that may not exist long enough to be scraped, you can use [Prometheus Pushgateway](https://github.com/prometheus/pushgateway) support to expose the metrics to Prometheus. To enable Prometheus Pushgateway support, add the following dependency to your project: ```xml io.prometheus prometheus-metrics-exporter-pushgateway ``` When the Prometheus Pushgateway dependency is present on the classpath and the `management.prometheus.metrics.export.pushgateway.enabled` property is set to `true`, a [`PrometheusPushGatewayManager`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/metrics/export/prometheus/PrometheusPushGatewayManager.html) bean is auto-configured. This manages the pushing of metrics to a Prometheus Pushgateway. You can tune the [`PrometheusPushGatewayManager`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/metrics/export/prometheus/PrometheusPushGatewayManager.html) by using properties under `management.prometheus.metrics.export.pushgateway`. For advanced configuration, you can also provide your own [`PrometheusPushGatewayManager`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/metrics/export/prometheus/PrometheusPushGatewayManager.html) bean. ### [](#actuator.metrics.export.simple)Simple Micrometer ships with a simple, in-memory backend that is automatically used as a fallback if no other registry is configured. This lets you see what metrics are collected in the [metrics endpoint](#actuator.metrics.endpoint). The in-memory backend disables itself as soon as you use any other available backend. You can also disable it explicitly: * Properties * YAML ```properties management.simple.metrics.export.enabled=false ``` ```yaml management: simple: metrics: export: enabled: false ``` ### [](#actuator.metrics.export.stackdriver)Stackdriver The Stackdriver registry periodically pushes metrics to [Stackdriver](https://cloud.google.com/stackdriver/). To export metrics to SaaS [Stackdriver](https://docs.micrometer.io/micrometer/reference/1.17/implementations/stackdriver), you must provide your Google Cloud project ID: * Properties * YAML ```properties management.stackdriver.metrics.export.project-id=my-project ``` ```yaml management: stackdriver: metrics: export: project-id: "my-project" ``` You can also change the interval at which metrics are sent to Stackdriver: * Properties * YAML ```properties management.stackdriver.metrics.export.step=30s ``` ```yaml management: stackdriver: metrics: export: step: "30s" ``` ### [](#actuator.metrics.export.statsd)StatsD The StatsD registry eagerly pushes metrics over UDP to a StatsD agent. By default, metrics are exported to a [StatsD](https://docs.micrometer.io/micrometer/reference/1.17/implementations/statsD) agent running on your local machine. You can provide the StatsD agent host, port, and protocol to use by using: * Properties * YAML ```properties management.statsd.metrics.export.host=statsd.example.com management.statsd.metrics.export.port=9125 management.statsd.metrics.export.protocol=udp ``` ```yaml management: statsd: metrics: export: host: "statsd.example.com" port: 9125 protocol: "udp" ``` You can also change the StatsD line protocol to use (it defaults to Datadog): * Properties * YAML ```properties management.statsd.metrics.export.flavor=etsy ``` ```yaml management: statsd: metrics: export: flavor: "etsy" ``` ## [](#actuator.metrics.supported)Supported Metrics and Meters Spring Boot provides automatic meter registration for a wide variety of technologies. In most situations, the defaults provide sensible metrics that can be published to any of the supported monitoring systems. ### [](#actuator.metrics.supported.jvm)JVM Metrics Auto-configuration enables JVM Metrics by using core Micrometer classes. JVM metrics are published under the `jvm.` meter name. The following JVM metrics are provided: * Various memory and buffer pool details * Statistics related to garbage collection * Thread utilization * [Virtual threads statistics](https://docs.micrometer.io/micrometer/reference/reference/jvm.html#_java_21_metrics) (for this, `io.micrometer:micrometer-java21` has to be on the classpath) * The number of classes loaded and unloaded * JVM version information * JIT compilation time ### [](#actuator.metrics.supported.system)System Metrics Auto-configuration enables system metrics by using core Micrometer classes. System metrics are published under the `system.`, `process.`, and `disk.` meter names. The following system metrics are provided: * CPU metrics * File descriptor metrics * Uptime metrics (both the amount of time the application has been running and a fixed gauge of the absolute start time) * Disk space available ### [](#actuator.metrics.supported.application-startup)Application Startup Metrics Auto-configuration exposes application startup time metrics: * `application.started.time`: time taken to start the application. * `application.ready.time`: time taken for the application to be ready to service requests. Metrics are tagged by the fully qualified name of the application class. ### [](#actuator.metrics.supported.logger)Logger Metrics Auto-configuration enables the event metrics for both Logback and Log4J2. The details are published under the `log4j2.events.` or `logback.events.` meter names. ### [](#actuator.metrics.supported.tasks)Task Execution and Scheduling Metrics Auto-configuration enables the instrumentation of all available [`ThreadPoolTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/concurrent/ThreadPoolTaskExecutor.html) and [`ThreadPoolTaskScheduler`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/concurrent/ThreadPoolTaskScheduler.html) beans, as long as the underling [`ThreadPoolExecutor`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/ThreadPoolExecutor.html) is available. Metrics are tagged by the name of the executor, which is derived from the bean name. ### [](#actuator.metrics.supported.jms)JMS Metrics Auto-configuration enables the instrumentation of all available [`JmsTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/core/JmsTemplate.html) beans and [`@JmsListener`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/annotation/JmsListener.html) annotated methods. This will produce `"jms.message.publish"` and `"jms.message.process"` metrics respectively. See the [Spring Framework reference documentation for more information on produced observations](https://docs.spring.io/spring-framework/reference/7.0/integration/observability.html#observability.jms). | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | [`JmsClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/core/JmsClient.html) and [`JmsMessagingTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/core/JmsMessagingTemplate.html) that uses a [`JmsTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/core/JmsTemplate.html) bean are also instrumented. | ### [](#actuator.metrics.supported.spring-mvc)Spring MVC Metrics Auto-configuration enables the instrumentation of all requests handled by Spring MVC controllers and functional handlers. By default, metrics are generated with the name, `http.server.requests`. You can customize the name by setting the `management.observations.http.server.requests.name` property. See the [Spring Framework reference documentation for more information on produced observations](https://docs.spring.io/spring-framework/reference/7.0/integration/observability.html#observability.http-server.servlet). To add to the default tags, provide a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) that extends [`DefaultServerRequestObservationConvention`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/server/observation/DefaultServerRequestObservationConvention.html) from the `org.springframework.http.server.observation` package. To replace the default tags, provide a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) that implements [`ServerRequestObservationConvention`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/server/observation/ServerRequestObservationConvention.html). | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | In some cases, exceptions handled in web controllers are not recorded as request metrics tags. Applications can opt in and record exceptions by [setting handled exceptions as request attributes](../web/servlet.html#web.servlet.spring-mvc.error-handling). | By default, all requests are handled. To customize the filter, provide a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) that implements `FilterRegistrationBean`. ### [](#actuator.metrics.supported.spring-webflux)Spring WebFlux Metrics Auto-configuration enables the instrumentation of all requests handled by Spring WebFlux controllers and functional handlers. By default, metrics are generated with the name, `http.server.requests`. You can customize the name by setting the `management.observations.http.server.requests.name` property. See the [Spring Framework reference documentation for more information on produced observations](https://docs.spring.io/spring-framework/reference/7.0/integration/observability.html#observability.http-server.reactive). To add to the default tags, provide a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) that extends [`DefaultServerRequestObservationConvention`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/server/reactive/observation/DefaultServerRequestObservationConvention.html) from the `org.springframework.http.server.reactive.observation` package. To replace the default tags, provide a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) that implements [`ServerRequestObservationConvention`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/server/reactive/observation/ServerRequestObservationConvention.html). | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | In some cases, exceptions handled in controllers and handler functions are not recorded as request metrics tags. Applications can opt in and record exceptions by [setting handled exceptions as request attributes](../web/reactive.html#web.reactive.webflux.error-handling). | ### [](#actuator.metrics.supported.jersey)Jersey Server Metrics Auto-configuration enables the instrumentation of all requests handled by the Jersey JAX-RS implementation. By default, metrics are generated with the name, `http.server.requests`. You can customize the name by setting the `management.observations.http.server.requests.name` property. By default, Jersey server metrics are tagged with the following information: | Tag | Description | | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `exception` | The simple class name of any exception that was thrown while handling the request. | | `method` | The request’s method (for example, `GET` or `POST`) | | `outcome` | The request’s outcome, based on the status code of the response. 1xx is `INFORMATIONAL`, 2xx is `SUCCESS`, 3xx is `REDIRECTION`, 4xx is `CLIENT_ERROR`, and 5xx is `SERVER_ERROR` | | `status` | The response’s HTTP status code (for example, `200` or `500`) | | `uri` | The request’s URI template prior to variable substitution, if possible (for example, `/api/person/{id}`) | To customize the tags, provide a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) that implements [`JerseyObservationConvention`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/binder/jersey/server/JerseyObservationConvention.html). ### [](#actuator.metrics.supported.ssl)SSL Bundle Metrics Spring Boot Actuator publishes expiry metrics about SSL bundles. The metric `ssl.chain.expiry` gauges the expiry date of each certificate chain in key stores and trust stores in seconds. This number will be negative if the chain has already expired. This metric is tagged with the following information: | Tag | Description | | ------------- | ------------------------------------------------------------------------------------------------- | | `bundle` | The name of the bundle which contains the certificate chain | | `certificate` | The serial number (in hex format) of the certificate which is the soonest to expire in the chain | | `chain` | The name of the certificate chain. | | `source` | Whether the certificate chain comes from the key store (`keystore`) or trust store (`truststore`) | ### [](#actuator.metrics.supported.http-clients)HTTP Client Metrics Spring Boot Actuator manages the instrumentation of [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html), [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html) and [`RestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.html). For that, you have to inject the auto-configured builder and use it to create instances: * [`RestTemplateBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateBuilder.html) for [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html) * [`WebClient.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.Builder.html) for [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html) * [`RestClient.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.Builder.html) for [`RestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.html) You can also manually apply the customizers responsible for this instrumentation, namely [`ObservationRestTemplateCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/observation/ObservationRestTemplateCustomizer.html), [`ObservationWebClientCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webclient/observation/ObservationWebClientCustomizer.html) and [`ObservationRestClientCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/observation/ObservationRestClientCustomizer.html). By default, metrics are generated with the name, `http.client.requests`. You can customize the name by setting the `management.observations.http.client.requests.name` property. See the [Spring Framework reference documentation for more information on produced observations](https://docs.spring.io/spring-framework/reference/7.0/integration/observability.html#observability.http-client). To customize the tags when using [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html) or [`RestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.html), provide a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) that implements [`ClientRequestObservationConvention`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/client/observation/ClientRequestObservationConvention.html) from the `org.springframework.http.client.observation` package. To customize the tags when using [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html), provide a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) that implements [`ClientRequestObservationConvention`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/ClientRequestObservationConvention.html) from the `org.springframework.web.reactive.function.client` package. ### [](#actuator.metrics.supported.tomcat)Tomcat Metrics Auto-configuration enables the instrumentation of Tomcat only when an MBean [`Registry`](https://tomcat.apache.org/tomcat-11.0-doc/api/org/apache/tomcat/util/modeler/Registry.html) is enabled. By default, the MBean registry is disabled, but you can enable it by setting `server.tomcat.mbeanregistry.enabled` to `true`. Tomcat metrics are published under the `tomcat.` meter name. ### [](#actuator.metrics.supported.cache)Cache Metrics Auto-configuration enables the instrumentation of all available [`Cache`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/Cache.html) instances on startup, with metrics prefixed with `cache`. Cache instrumentation is standardized for a basic set of metrics. Additional, cache-specific metrics are also available. The following cache libraries are supported: * Cache2k * Caffeine * Hazelcast * Any compliant JCache (JSR-107) implementation * Redis | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Metrics should be enabled for the auto-configuration to pick them up. Refer to the documentation of the cache library you are using for more details. | Metrics are tagged by the name of the cache and by the name of the [`CacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/CacheManager.html), which is derived from the bean name. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Only caches that are configured on startup are bound to the registry. For caches not defined in the cache’s configuration, such as caches created on the fly or programmatically after the startup phase, an explicit registration is required. A [`CacheMetricsRegistrar`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/cache/metrics/CacheMetricsRegistrar.html) bean is made available to make that process easier. | ### [](#actuator.metrics.supported.spring-batch)Spring Batch Metrics See the [Spring Batch reference documentation](https://docs.spring.io/spring-batch/reference/6.0/monitoring-and-metrics.html). ### [](#actuator.metrics.supported.spring-graphql)Spring GraphQL Metrics See the [Spring GraphQL reference documentation](https://docs.spring.io/spring-graphql/reference/2.0/observability.html). ### [](#actuator.metrics.supported.jdbc)DataSource Metrics Auto-configuration enables the instrumentation of all available [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) objects with metrics prefixed with `jdbc.connections`. Data source instrumentation results in gauges that represent the currently active, idle, maximum allowed, and minimum allowed connections in the pool. Metrics are also tagged by the name of the [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) computed based on the bean name. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | By default, Spring Boot provides metadata for all supported data sources. You can add additional [`DataSourcePoolMetadataProvider`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/metadata/DataSourcePoolMetadataProvider.html) beans if your favorite data source is not supported. See [`DataSourcePoolMetadataProvidersConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/autoconfigure/DataSourcePoolMetadataProvidersConfiguration.html) for examples. | Also, Hikari-specific metrics are exposed with a `hikaricp` prefix. Each metric is tagged by the name of the pool (you can control it with `spring.datasource.name`). ### [](#actuator.metrics.supported.hibernate)Hibernate Metrics If `org.hibernate.orm:hibernate-micrometer` is on the classpath, all available Hibernate [`EntityManagerFactory`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/EntityManagerFactory.html) instances that have statistics enabled are instrumented with a metric named `hibernate`. Metrics are also tagged by the name of the [`EntityManagerFactory`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/EntityManagerFactory.html), which is derived from the bean name. To enable statistics, the standard JPA property `hibernate.generate_statistics` must be set to `true`. You can enable that on the auto-configured [`EntityManagerFactory`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/EntityManagerFactory.html): * Properties * YAML ```properties spring.jpa.properties[hibernate.generate_statistics]=true ``` ```yaml spring: jpa: properties: "[hibernate.generate_statistics]": true ``` ### [](#actuator.metrics.supported.spring-data-repository)Spring Data Repository Metrics Auto-configuration enables the instrumentation of all Spring Data [`Repository`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/Repository.html) method invocations. By default, metrics are generated with the name, `spring.data.repository.invocations`. You can customize the name by setting the `management.metrics.data.repository.metric-name` property. The [`@Timed`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/annotation/Timed.html) annotation from the `io.micrometer.core.annotation` package is supported on [`Repository`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/Repository.html) interfaces and methods. If you do not want to record metrics for all [`Repository`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/Repository.html) invocations, you can set `management.metrics.data.repository.autotime.enabled` to `false` and exclusively use [`@Timed`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/annotation/Timed.html) annotations instead. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | A [`@Timed`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/annotation/Timed.html) annotation with `longTask = true` enables a long task timer for the method. Long task timers require a separate metric name and can be stacked with a short task timer. | By default, repository invocation related metrics are tagged with the following information: | Tag | Description | | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `repository` | The simple class name of the source [`Repository`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/Repository.html). | | `method` | The name of the [`Repository`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/Repository.html) method that was invoked. | | `state` | The result state (`SUCCESS`, `ERROR`, `CANCELED`, or `RUNNING`). | | `exception` | The simple class name of any exception that was thrown from the invocation. | To replace the default tags, provide a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) that implements [`RepositoryTagsProvider`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/metrics/RepositoryTagsProvider.html). ### [](#actuator.metrics.supported.rabbitmq)RabbitMQ Metrics Auto-configuration enables the instrumentation of all available RabbitMQ connection factories with a metric named `rabbitmq`. ### [](#actuator.metrics.supported.spring-integration)Spring Integration Metrics Spring Integration automatically provides [Micrometer support](https://docs.spring.io/spring-integration/reference/7.1/metrics.html#micrometer-integration) whenever a [`MeterRegistry`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/MeterRegistry.html) bean is available. Metrics are published under the `spring.integration.` meter name. ### [](#actuator.metrics.supported.kafka)Kafka Metrics Auto-configuration registers a [`MicrometerConsumerListener`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/core/MicrometerConsumerListener.html) and [`MicrometerProducerListener`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/core/MicrometerProducerListener.html) for the auto-configured consumer factory and producer factory, respectively. It also registers a [`KafkaStreamsMicrometerListener`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/streams/KafkaStreamsMicrometerListener.html) for [`StreamsBuilderFactoryBean`](https://docs.spring.io/spring-kafka/docs/4.1.x/api/org/springframework/kafka/config/StreamsBuilderFactoryBean.html). For more detail, see the [Micrometer Native Metrics](https://docs.spring.io/spring-kafka/reference/4.1/kafka/micrometer.html#micrometer-native) section of the Spring Kafka documentation. ### [](#actuator.metrics.supported.mongodb)MongoDB Metrics This section briefly describes the available metrics for MongoDB. #### [](#actuator.metrics.supported.mongodb.command)MongoDB Command Metrics Auto-configuration registers a [`MongoMetricsCommandListener`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/binder/mongodb/MongoMetricsCommandListener.html) with the auto-configured [`MongoClient`](https://mongodb.github.io/mongo-java-driver/5.8/apidocs/mongodb-driver-sync/com/mongodb/client/MongoClient.html). A timer metric named `mongodb.driver.commands` is created for each command issued to the underlying MongoDB driver. Each metric is tagged with the following information by default: | Tag | Description | | ---------------- | ------------------------------------------------------------ | | `command` | The name of the command issued. | | `cluster.id` | The identifier of the cluster to which the command was sent. | | `server.address` | The address of the server to which the command was sent. | | `status` | The outcome of the command (`SUCCESS` or `FAILED`). | To replace the default metric tags, define a [`MongoCommandTagsProvider`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/binder/mongodb/MongoCommandTagsProvider.html) bean, as the following example shows: * Java * Kotlin ```java import io.micrometer.core.instrument.binder.mongodb.MongoCommandTagsProvider; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyCommandTagsProviderConfiguration { @Bean public MongoCommandTagsProvider customCommandTagsProvider() { return new CustomCommandTagsProvider(); } } ``` ```kotlin import io.micrometer.core.instrument.binder.mongodb.MongoCommandTagsProvider import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyCommandTagsProviderConfiguration { @Bean fun customCommandTagsProvider(): MongoCommandTagsProvider? { return CustomCommandTagsProvider() } } ``` To disable the auto-configured command metrics, set the following property: * Properties * YAML ```properties management.metrics.mongodb.command.enabled=false ``` ```yaml management: metrics: mongodb: command: enabled: false ``` #### [](#actuator.metrics.supported.mongodb.connection-pool)MongoDB Connection Pool Metrics Auto-configuration registers a [`MongoMetricsConnectionPoolListener`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/binder/mongodb/MongoMetricsConnectionPoolListener.html) with the auto-configured [`MongoClient`](https://mongodb.github.io/mongo-java-driver/5.8/apidocs/mongodb-driver-sync/com/mongodb/client/MongoClient.html). The following gauge metrics are created for the connection pool: * `mongodb.driver.pool.size` reports the current size of the connection pool, including idle and in-use members. * `mongodb.driver.pool.checkedout` reports the count of connections that are currently in use. * `mongodb.driver.pool.waitqueuesize` reports the current size of the wait queue for a connection from the pool. Each metric is tagged with the following information by default: | Tag | Description | | ---------------- | ----------------------------------------------------------------------- | | `cluster.id` | The identifier of the cluster to which the connection pool corresponds. | | `server.address` | The address of the server to which the connection pool corresponds. | To replace the default metric tags, define a [`MongoConnectionPoolTagsProvider`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/binder/mongodb/MongoConnectionPoolTagsProvider.html) bean: * Java * Kotlin ```java import io.micrometer.core.instrument.binder.mongodb.MongoConnectionPoolTagsProvider; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyConnectionPoolTagsProviderConfiguration { @Bean public MongoConnectionPoolTagsProvider customConnectionPoolTagsProvider() { return new CustomConnectionPoolTagsProvider(); } } ``` ```kotlin import io.micrometer.core.instrument.binder.mongodb.MongoConnectionPoolTagsProvider import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyConnectionPoolTagsProviderConfiguration { @Bean fun customConnectionPoolTagsProvider(): MongoConnectionPoolTagsProvider { return CustomConnectionPoolTagsProvider() } } ``` To disable the auto-configured connection pool metrics, set the following property: * Properties * YAML ```properties management.metrics.mongodb.connectionpool.enabled=false ``` ```yaml management: metrics: mongodb: connectionpool: enabled: false ``` ### [](#actuator.metrics.supported.neo4j)Neo4j Metrics Auto-configuration registers a [`MicrometerObservationProvider`](https://javadoc.io/doc/org.neo4j.driver/neo4j-java-driver/6.1.0/org/neo4j/driver/observation/micrometer/MicrometerObservationProvider.html) for the auto-configured [`Driver`](https://javadoc.io/doc/org.neo4j.driver/neo4j-java-driver/6.1.0/org/neo4j/driver/Driver.html). To override this behavior, you can register a [`ConfigBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/neo4j/autoconfigure/ConfigBuilderCustomizer.html) bean with an order higher than zero. ### [](#actuator.metrics.supported.jetty)Jetty Metrics Auto-configuration binds metrics for Jetty’s [`ThreadPool`](https://javadoc.jetty.org/jetty-12/org/eclipse/jetty/util/thread/ThreadPool.html) by using Micrometer’s [`JettyServerThreadPoolMetrics`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/binder/jetty/JettyServerThreadPoolMetrics.html). Metrics for Jetty’s [`Connector`](https://javadoc.jetty.org/jetty-12/org/eclipse/jetty/server/Connector.html) instances are bound by using Micrometer’s [`JettyConnectionMetrics`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/binder/jetty/JettyConnectionMetrics.html) and, when `server.ssl.enabled` is set to `true`, Micrometer’s [`JettySslHandshakeMetrics`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/binder/jetty/JettySslHandshakeMetrics.html). ### [](#actuator.metrics.supported.redis)Redis Metrics Auto-configuration registers a [`MicrometerTracing`](https://javadoc.io/doc/io.lettuce/lettuce-core/7.5.2.RELEASE/io/lettuce/core/tracing/MicrometerTracing.html) for the auto-configured [`LettuceConnectionFactory`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/connection/lettuce/LettuceConnectionFactory.html). For more detail, see the [Observability section](https://redis.github.io/lettuce/advanced-usage/observability) of the Lettuce documentation. ## [](#actuator.metrics.registering-custom)Registering Custom Metrics To register custom metrics, inject [`MeterRegistry`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/MeterRegistry.html) into your component: * Java * Kotlin ```java import io.micrometer.core.instrument.MeterRegistry; import io.micrometer.core.instrument.Tags; import org.springframework.stereotype.Component; @Component public class MyBean { private final Dictionary dictionary; public MyBean(MeterRegistry registry) { this.dictionary = Dictionary.load(); registry.gauge("dictionary.size", Tags.empty(), this.dictionary.getWords().size()); } } ``` ```kotlin import io.micrometer.core.instrument.MeterRegistry import io.micrometer.core.instrument.Tags import org.springframework.stereotype.Component @Component class MyBean(registry: MeterRegistry) { private val dictionary: Dictionary init { dictionary = Dictionary.load() registry.gauge("dictionary.size", Tags.empty(), dictionary.words.size) } } ``` If your metrics depend on other beans, we recommend that you use a [`MeterBinder`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/binder/MeterBinder.html) to register them: * Java * Kotlin ```java import io.micrometer.core.instrument.Gauge; import io.micrometer.core.instrument.binder.MeterBinder; import org.springframework.context.annotation.Bean; public class MyMeterBinderConfiguration { @Bean public MeterBinder queueSize(Queue queue) { return (registry) -> Gauge.builder("queueSize", queue::size).register(registry); } } ``` ```kotlin import io.micrometer.core.instrument.Gauge import io.micrometer.core.instrument.binder.MeterBinder import org.springframework.context.annotation.Bean class MyMeterBinderConfiguration { @Bean fun queueSize(queue: Queue): MeterBinder { return MeterBinder { registry -> Gauge.builder("queueSize", queue::size).register(registry) } } } ``` Using a [`MeterBinder`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/binder/MeterBinder.html) ensures that the correct dependency relationships are set up and that the bean is available when the metric’s value is retrieved. A [`MeterBinder`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/binder/MeterBinder.html) implementation can also be useful if you find that you repeatedly instrument a suite of metrics across components or applications. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | By default, metrics from all [`MeterBinder`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/binder/MeterBinder.html) beans are automatically bound to the Spring-managed [`MeterRegistry`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/MeterRegistry.html). | ## [](#actuator.metrics.customizing)Customizing Individual Metrics If you need to apply customizations to specific [`Meter`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/Meter.html) instances, you can use the [`MeterFilter`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/config/MeterFilter.html) interface. For example, if you want to rename the `mytag.region` tag to `mytag.area` for all meter IDs beginning with `com.example`, you can do the following: * Java * Kotlin ```java import io.micrometer.core.instrument.config.MeterFilter; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyMetricsFilterConfiguration { @Bean public MeterFilter renameRegionTagMeterFilter() { return MeterFilter.renameTag("com.example", "mytag.region", "mytag.area"); } } ``` ```kotlin import io.micrometer.core.instrument.config.MeterFilter import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyMetricsFilterConfiguration { @Bean fun renameRegionTagMeterFilter(): MeterFilter { return MeterFilter.renameTag("com.example", "mytag.region", "mytag.area") } } ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | By default, all [`MeterFilter`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/config/MeterFilter.html) beans are automatically bound to the Spring-managed [`MeterRegistry`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/MeterRegistry.html). Make sure to register your metrics by using the Spring-managed [`MeterRegistry`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/MeterRegistry.html) and not any of the static methods on [`Metrics`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/Metrics.html). These use the global registry that is not Spring-managed. | ### [](#actuator.metrics.customizing.common-tags)Common Tags Common tags are generally used for dimensional drill-down on the operating environment, such as host, instance, region, stack, and others. Commons tags are applied to all meters and can be configured, as the following example shows: * Properties * YAML ```properties management.metrics.tags.region=us-east-1 management.metrics.tags.stack=prod ``` ```yaml management: metrics: tags: region: "us-east-1" stack: "prod" ``` The preceding example adds `region` and `stack` tags to all meters with a value of `us-east-1` and `prod`, respectively. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The order of common tags is important if you use Graphite. As the order of common tags cannot be guaranteed by using this approach, Graphite users are advised to define a custom [`MeterFilter`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/config/MeterFilter.html) instead. | ### [](#actuator.metrics.customizing.per-meter-properties)Per-meter Properties In addition to [`MeterFilter`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/config/MeterFilter.html) beans, you can apply a limited set of customization on a per-meter basis using properties. Per-meter customizations are applied, using Spring Boot’s [`PropertiesMeterFilter`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/metrics/autoconfigure/PropertiesMeterFilter.html), to any meter IDs that start with the given name. The following example filters out any meters that have an ID starting with `example.remote`. * Properties * YAML ```properties management.metrics.enable.example.remote=false ``` ```yaml management: metrics: enable: example: remote: false ``` The following properties allow per-meter customization: | Property | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `management.metrics.enable` | Whether to accept meters with certain IDs. Meters that are not accepted are filtered from the [`MeterRegistry`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/MeterRegistry.html). | | `management.metrics.distribution.percentiles-histogram` | Whether to publish a histogram suitable for computing aggregable (across dimension) percentile approximations. | | `management.metrics.distribution.minimum-expected-value`, `management.metrics.distribution.maximum-expected-value` | Publish fewer histogram buckets by clamping the range of expected values. | | `management.metrics.distribution.percentiles` | Publish percentile values computed in your application | | `management.metrics.distribution.expiry`, `management.metrics.distribution.buffer-length` | Give greater weight to recent samples by accumulating them in ring buffers which rotate after a configurable expiry, with a configurable buffer length. | | `management.metrics.distribution.slo` | Publish a cumulative histogram with buckets defined by your service-level objectives. | For more details on the concepts behind `percentiles-histogram`, `percentiles`, and `slo`, see the [Histograms and percentiles](https://docs.micrometer.io/micrometer/reference/1.17/concepts/histogram-quantiles.html) section of the Micrometer documentation. ## [](#actuator.metrics.endpoint)Metrics Endpoint Spring Boot provides a `metrics` endpoint that you can use diagnostically to examine the metrics collected by an application. The endpoint is not available by default and must be exposed. See [exposing endpoints](endpoints.html#actuator.endpoints.exposing) for more details. Navigating to `/actuator/metrics` displays a list of available meter names. You can drill down to view information about a particular meter by providing its name as a selector — for example, `/actuator/metrics/jvm.memory.max`. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The name you use here should match the name used in the code, not the name after it has been naming-convention normalized for a monitoring system to which it is shipped. In other words, if `jvm.memory.max` appears as `jvm_memory_max` in Prometheus because of its snake case naming convention, you should still use `jvm.memory.max` as the selector when inspecting the meter in the `metrics` endpoint. | You can also add any number of `tag=KEY:VALUE` query parameters to the end of the URL to dimensionally drill down on a meter — for example, `/actuator/metrics/jvm.memory.max?tag=area:nonheap`. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The reported measurements are the *sum* of the statistics of all meters that match the meter name and any tags that have been applied. In the preceding example, the returned `Value` statistic is the sum of the maximum memory footprints of the “Code Cache”, “Compressed Class Space”, and “Metaspace” areas of the heap. If you wanted to see only the maximum size for the “Metaspace”, you could add an additional `tag=id:Metaspace` — that is, `/actuator/metrics/jvm.memory.max?tag=area:nonheap&tag=id:Metaspace`. | ## [](#actuator.metrics.micrometer-observation)Integration with Micrometer Observation A [`DefaultMeterObservationHandler`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/observation/DefaultMeterObservationHandler.html) is automatically registered on the [`ObservationRegistry`](https://javadoc.io/doc/io.micrometer/micrometer-observation/1.17.1/io/micrometer/observation/ObservationRegistry.html), which creates metrics for every completed observation. * [Spring Boot](../../index.html) * [4.1.1](metrics.html) * [4.0.8](../../4.0/reference/actuator/metrics.html) * [3.5.16](../../3.5/reference/actuator/metrics.html) * [3.4.13](../../3.4/reference/actuator/metrics.html) * [3.3.13](../../3.3/reference/actuator/metrics.html) - [4.2.0-M2](../../4.2/reference/actuator/metrics.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/actuator/metrics.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/actuator/metrics.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/actuator/metrics.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/upgrading.html ---- # Upgrading Spring Boot Instructions for how to upgrade from earlier versions of Spring Boot are provided on the project [wiki](https://github.com/spring-projects/spring-boot/wiki). Follow the links in the [release notes](https://github.com/spring-projects/spring-boot/wiki#release-notes) section to find the version that you want to upgrade to. Upgrading instructions are always the first item in the release notes. If you are more than one release behind, please make sure that you also review the release notes of the versions that you jumped. ## [](#upgrading.from-1x)Upgrading From 1.x If you are upgrading from the `1.x` release of Spring Boot, check the [migration guide](https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.0-Migration-Guide) on the project wiki that provides detailed upgrade instructions to upgrade to Spring Boot 2.x. Check also the [release notes](https://github.com/spring-projects/spring-boot/wiki#release-notes) for a list of “new and noteworthy” features for each release. ## [](#upgrading.from-2x)Upgrading From 2.x If you are upgrading from the `2.x` release of Spring Boot, check the [migration guide](https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-3.0-Migration-Guide) on the project wiki that provides detailed upgrade instructions. Check also the [release notes](https://github.com/spring-projects/spring-boot/wiki#release-notes) for a list of “new and noteworthy” features for each release. ## [](#upgrading.from-3x)Upgrading From 3.x If you are upgrading from the `3.x` release of Spring Boot, check the [migration guide](https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-4.0-Migration-Guide) on the project wiki that provides detailed upgrade instructions. Check also the [release notes](https://github.com/spring-projects/spring-boot/wiki#release-notes) for a list of “new and noteworthy” features for each release. ## [](#upgrading.to-feature)Upgrading to a New Feature Release When upgrading to a new feature release, some properties may have been renamed or removed. Spring Boot provides a way to analyze your application’s environment and print diagnostics at startup, but also temporarily migrate properties at runtime for you. To enable that feature, add the following dependency to your project: ```xml org.springframework.boot spring-boot-properties-migrator runtime ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Properties that are added late to the environment, such as when using [`@PropertySource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/PropertySource.html), will not be taken into account. | | | | | -- | ------------------------------------------------------------------------------------------------------- | | ** | Once you finish the migration, please make sure to remove this module from your project’s dependencies. | ## [](#upgrading.cli)Upgrading the Spring Boot CLI To upgrade an existing CLI installation, use the appropriate package manager command (for example, `brew upgrade`). If you manually installed the CLI, follow the [standard instructions](installing.html#getting-started.installing.cli.manual-installation), remembering to update your `PATH` environment variable to remove any older references. * [Spring Boot](index.html) * [4.1.1](upgrading.html) * [4.0.8](4.0/upgrading.html) * [3.5.16](3.5/upgrading.html) * [3.4.13](3.4/upgrading.html) * [3.3.13](3.3/upgrading.html) - [4.2.0-M2](4.2/upgrading.html) * [4.2.0-SNAPSHOT](4.2-SNAPSHOT/upgrading.html) * [4.1.3-SNAPSHOT](4.1-SNAPSHOT/upgrading.html) * [4.0.10-SNAPSHOT](4.0-SNAPSHOT/upgrading.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/features/aop.html ---- # Aspect-Oriented Programming Spring Boot provides auto-configuration for aspect-oriented programming (AOP). You can learn more about AOP with Spring in the [Spring Framework reference documentation](https://docs.spring.io/spring-framework/reference/7.0/core/aop-api.html). By default, Spring Boot’s auto-configuration configures Spring AOP to use CGLib proxies. To use JDK proxies instead, set `spring.aop.proxy-target-class` to `false`. If AspectJ is on the classpath, Spring Boot’s auto-configuration will automatically enable AspectJ auto proxy such that [`@EnableAspectJAutoProxy`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/EnableAspectJAutoProxy.html) is not required. * [Spring Boot](../../index.html) * [4.1.1](aop.html) * [4.0.8](../../4.0/reference/features/aop.html) * [3.5.16](../../3.5/reference/features/aop.html) * [3.4.13](../../3.4/reference/features/aop.html) * [3.3.13](../../3.3/reference/features/aop.html) - [4.2.0-M2](../../4.2/reference/features/aop.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/features/aop.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/features/aop.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/features/aop.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/web/index.html ---- # Web Spring Boot is well suited for web application development. You can create a self-contained HTTP server by using embedded Tomcat, Jetty, or Netty. Most web applications use the `spring-boot-starter-webmvc` module to get up and running quickly. You can also choose to build reactive web applications by using the `spring-boot-starter-webflux` module. If you have not yet developed a Spring Boot web application, you can follow the “Hello World!” example in the [Getting started](../../tutorial/first-application/index.html) section. * [Spring Boot](../../index.html) * [4.1.1](index.html) * [4.0.8](../../4.0/reference/web/index.html) * [3.5.16](../../3.5/reference/web/index.html) * [3.4.13](../../3.4/reference/web/index.html) * [3.3.13](../../3.3/reference/web/index.html) - [4.2.0-M2](../../4.2/reference/web/index.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/web/index.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/web/index.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/web/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/integration-tests.html ---- # Running Integration Tests While you may start your Spring Boot application very easily from your test (or test suite) itself, it may be desirable to handle that in the build itself. To make sure that the lifecycle of your Spring Boot application is properly managed around your integration tests, you can use the `start` and `stop` goals, as shown in the following example: ```xml org.springframework.boot spring-boot-maven-plugin pre-integration-test start post-integration-test stop ``` Such setup can now use the [failsafe-plugin](https://maven.apache.org/surefire/maven-failsafe-plugin) to run your integration tests as you would expect. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The application is started in a separate process and JMX is used to communicate with the application. By default, the plugin uses port `9001`. If you need to configure the JMX port, see [the dedicated example](#integration-tests.examples.jmx-port). | You could also configure a more advanced setup to skip the integration tests when a specific property has been set, see [the dedicated example](#integration-tests.examples.skip). ## [](#integration-tests.no-starter-parent)Using Failsafe Without Spring Boot’s Parent POM Spring Boot’s Parent POM, `spring-boot-starter-parent`, configures Failsafe’s `` to be `${project.build.outputDirectory}`. Without this configuration, which causes Failsafe to use the compiled classes rather than the repackaged jar, Failsafe cannot load your application’s classes. If you are not using the parent POM, you should configure Failsafe in the same way, as shown in the following example: ```xml org.apache.maven.plugins maven-failsafe-plugin ${project.build.outputDirectory} ``` ## [](#integration-tests.start-goal)`spring-boot:start` `org.springframework.boot:spring-boot-maven-plugin:4.1.1` Start a spring application. Contrary to the `run` goal, this does not block and allows other goals to operate on the application. This goal is typically used in integration test scenario where the application is started before a test suite and stopped after. ### [](#integration-tests.start-goal.required-parameters)Required parameters | Name | Type | Default | | ------------------------------------------------------------------------------------- | ------ | ---------------------------------- | | [classesDirectory](#integration-tests.start-goal.parameter-details.classes-directory) | `File` | `${project.build.outputDirectory}` | ### [](#integration-tests.start-goal.optional-parameters)Optional parameters | Name | Type | Default | | ------------------------------------------------------------------------------------------------------------ | ---------- | ------------------------------------------------------------ | | [addResources](#integration-tests.start-goal.parameter-details.add-resources) | `boolean` | `false` | | [additionalClasspathElements](#integration-tests.start-goal.parameter-details.additional-classpath-elements) | `String[]` | | | [agents](#integration-tests.start-goal.parameter-details.agents) | `File[]` | | | [arguments](#integration-tests.start-goal.parameter-details.arguments) | `String[]` | | | [commandlineArguments](#integration-tests.start-goal.parameter-details.commandline-arguments) | `String` | | | [environmentVariables](#integration-tests.start-goal.parameter-details.environment-variables) | `Map` | | | [excludeGroupIds](#integration-tests.start-goal.parameter-details.exclude-group-ids) | `String` | | | [excludes](#integration-tests.start-goal.parameter-details.excludes) | `List` | | | [includes](#integration-tests.start-goal.parameter-details.includes) | `List` | | | [jmxName](#integration-tests.start-goal.parameter-details.jmx-name) | `String` | `org.springframework.boot:type=Admin,name=SpringApplication` | | [jmxPort](#integration-tests.start-goal.parameter-details.jmx-port) | `int` | `9001` | | [jvmArguments](#integration-tests.start-goal.parameter-details.jvm-arguments) | `String` | | | [mainClass](#integration-tests.start-goal.parameter-details.main-class) | `String` | | | [maxAttempts](#integration-tests.start-goal.parameter-details.max-attempts) | `int` | `60` | | [noverify](#integration-tests.start-goal.parameter-details.noverify) | `boolean` | | | [profiles](#integration-tests.start-goal.parameter-details.profiles) | `String[]` | | | [skip](#integration-tests.start-goal.parameter-details.skip) | `boolean` | `false` | | [systemPropertyVariables](#integration-tests.start-goal.parameter-details.system-property-variables) | `Map` | | | [useTestClasspath](#integration-tests.start-goal.parameter-details.use-test-classpath) | `boolean` | `false` | | [wait](#integration-tests.start-goal.parameter-details.wait) | `long` | `500` | | [workingDirectory](#integration-tests.start-goal.parameter-details.working-directory) | `File` | | ### [](#integration-tests.start-goal.parameter-details)Parameter details #### [](#integration-tests.start-goal.parameter-details.add-resources)`addResources` Add maven resources to the classpath directly, this allows live in-place editing of resources. Duplicate resources are removed from `target/classes` to prevent them from appearing twice if `ClassLoader.getResources()` is called. Please consider adding `spring-boot-devtools` to your project instead as it provides this feature and many more. | Name | `addResources` | | ------------- | ------------------------------ | | Type | `boolean` | | Default value | `false` | | User property | `spring-boot.run.addResources` | | Since | `1.0.0` | #### [](#integration-tests.start-goal.parameter-details.additional-classpath-elements)`additionalClasspathElements` Additional classpath elements that should be added to the classpath. An element can be a directory with classes and resources or a jar file. | Name | `additionalClasspathElements` | | ------------- | ----------------------------------------------- | | Type | `java.lang.String[]` | | Default value | | | User property | `spring-boot.run.additional-classpath-elements` | | Since | `3.2.0` | #### [](#integration-tests.start-goal.parameter-details.agents)`agents` Path to agent jars. | Name | `agents` | | ------------- | ------------------------ | | Type | `java.io.File[]` | | Default value | | | User property | `spring-boot.run.agents` | | Since | `2.2.0` | #### [](#integration-tests.start-goal.parameter-details.arguments)`arguments` Arguments that should be passed to the application. | Name | `arguments` | | ------------- | -------------------- | | Type | `java.lang.String[]` | | Default value | | | User property | | | Since | `1.0.0` | #### [](#integration-tests.start-goal.parameter-details.classes-directory)`classesDirectory` Directory containing the classes and resource files that should be used to run the application. | Name | `classesDirectory` | | ------------- | ---------------------------------- | | Type | `java.io.File` | | Default value | `${project.build.outputDirectory}` | | User property | | | Since | `1.0.0` | #### [](#integration-tests.start-goal.parameter-details.commandline-arguments)`commandlineArguments` Arguments from the command line that should be passed to the application. Use spaces to separate multiple arguments and make sure to wrap multiple values between quotes. When specified, takes precedence over `#arguments`. | Name | `commandlineArguments` | | ------------- | --------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.run.arguments` | | Since | `2.2.3` | #### [](#integration-tests.start-goal.parameter-details.environment-variables)`environmentVariables` List of Environment variables that should be associated with the forked process used to run the application. | Name | `environmentVariables` | | ------------- | ---------------------- | | Type | `java.util.Map` | | Default value | | | User property | | | Since | `2.1.0` | #### [](#integration-tests.start-goal.parameter-details.exclude-group-ids)`excludeGroupIds` Comma separated list of groupId names to exclude (exact match). | Name | `excludeGroupIds` | | ------------- | ----------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.excludeGroupIds` | | Since | `1.1.0` | #### [](#integration-tests.start-goal.parameter-details.excludes)`excludes` Collection of artifact definitions to exclude. The `Exclude` element defines mandatory `groupId` and `artifactId` components and an optional `classifier` component. When configured as a property, values should be comma-separated with colon-separated components: `groupId:artifactId,groupId:artifactId:classifier` | Name | `excludes` | | ------------- | ---------------------- | | Type | `java.util.List` | | Default value | | | User property | `spring-boot.excludes` | | Since | `1.1.0` | #### [](#integration-tests.start-goal.parameter-details.includes)`includes` Collection of artifact definitions to include. The `Include` element defines mandatory `groupId` and `artifactId` components and an optional `classifier` component. When configured as a property, values should be comma-separated with colon-separated components: `groupId:artifactId,groupId:artifactId:classifier` | Name | `includes` | | ------------- | ---------------------- | | Type | `java.util.List` | | Default value | | | User property | `spring-boot.includes` | | Since | `1.2.0` | #### [](#integration-tests.start-goal.parameter-details.jmx-name)`jmxName` The JMX name of the automatically deployed MBean managing the lifecycle of the spring application. | Name | `jmxName` | | ------------- | ------------------------------------------------------------ | | Type | `java.lang.String` | | Default value | `org.springframework.boot:type=Admin,name=SpringApplication` | | User property | | | Since | | #### [](#integration-tests.start-goal.parameter-details.jmx-port)`jmxPort` The port to use to expose the platform MBeanServer. | Name | `jmxPort` | | ------------- | --------- | | Type | `int` | | Default value | `9001` | | User property | | | Since | | #### [](#integration-tests.start-goal.parameter-details.jvm-arguments)`jvmArguments` JVM arguments that should be associated with the forked process used to run the application. On command line, make sure to wrap multiple values between quotes. | Name | `jvmArguments` | | ------------- | ------------------------------ | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.run.jvmArguments` | | Since | `1.1.0` | #### [](#integration-tests.start-goal.parameter-details.main-class)`mainClass` The name of the main class. If not specified the first compiled class found that contains a 'main' method will be used. | Name | `mainClass` | | ------------- | ---------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.run.main-class` | | Since | `1.0.0` | #### [](#integration-tests.start-goal.parameter-details.max-attempts)`maxAttempts` The maximum number of attempts to check if the spring application is ready. Combined with the "wait" argument, this gives a global timeout value (30 sec by default) | Name | `maxAttempts` | | ------------- | ------------------------------- | | Type | `int` | | Default value | `60` | | User property | `spring-boot.start.maxAttempts` | | Since | | #### [](#integration-tests.start-goal.parameter-details.noverify)`noverify` Flag to say that the agent requires -noverify. | Name | `noverify` | | ------------- | -------------------------- | | Type | `boolean` | | Default value | | | User property | `spring-boot.run.noverify` | | Since | `1.0.0` | #### [](#integration-tests.start-goal.parameter-details.profiles)`profiles` The spring profiles to activate. Convenience shortcut of specifying the 'spring.profiles.active' argument. On command line use commas to separate multiple profiles. | Name | `profiles` | | ------------- | -------------------------- | | Type | `java.lang.String[]` | | Default value | | | User property | `spring-boot.run.profiles` | | Since | `1.3.0` | #### [](#integration-tests.start-goal.parameter-details.skip)`skip` Skip the execution. | Name | `skip` | | ------------- | ---------------------- | | Type | `boolean` | | Default value | `false` | | User property | `spring-boot.run.skip` | | Since | `1.3.2` | #### [](#integration-tests.start-goal.parameter-details.system-property-variables)`systemPropertyVariables` List of JVM system properties to pass to the process. | Name | `systemPropertyVariables` | | ------------- | ------------------------- | | Type | `java.util.Map` | | Default value | | | User property | | | Since | `2.1.0` | #### [](#integration-tests.start-goal.parameter-details.use-test-classpath)`useTestClasspath` Flag to include the test classpath when running. | Name | `useTestClasspath` | | ------------- | ---------------------------------- | | Type | `boolean` | | Default value | `false` | | User property | `spring-boot.run.useTestClasspath` | | Since | | #### [](#integration-tests.start-goal.parameter-details.wait)`wait` The number of milliseconds to wait between each attempt to check if the spring application is ready. | Name | `wait` | | ------------- | ------------------------ | | Type | `long` | | Default value | `500` | | User property | `spring-boot.start.wait` | | Since | | #### [](#integration-tests.start-goal.parameter-details.working-directory)`workingDirectory` Current working directory to use for the application. If not specified, basedir will be used. | Name | `workingDirectory` | | ------------- | ---------------------------------- | | Type | `java.io.File` | | Default value | | | User property | `spring-boot.run.workingDirectory` | | Since | `1.5.0` | ## [](#integration-tests.stop-goal)`spring-boot:stop` `org.springframework.boot:spring-boot-maven-plugin:4.1.1` Stop an application that has been started by the "start" goal. Typically invoked once a test suite has completed. ### [](#integration-tests.stop-goal.optional-parameters)Optional parameters | Name | Type | Default | | ------------------------------------------------------------------ | --------- | ------------------------------------------------------------ | | [jmxName](#integration-tests.stop-goal.parameter-details.jmx-name) | `String` | `org.springframework.boot:type=Admin,name=SpringApplication` | | [jmxPort](#integration-tests.stop-goal.parameter-details.jmx-port) | `int` | `9001` | | [skip](#integration-tests.stop-goal.parameter-details.skip) | `boolean` | `false` | ### [](#integration-tests.stop-goal.parameter-details)Parameter details #### [](#integration-tests.stop-goal.parameter-details.jmx-name)`jmxName` The JMX name of the automatically deployed MBean managing the lifecycle of the application. | Name | `jmxName` | | ------------- | ------------------------------------------------------------ | | Type | `java.lang.String` | | Default value | `org.springframework.boot:type=Admin,name=SpringApplication` | | User property | | | Since | | #### [](#integration-tests.stop-goal.parameter-details.jmx-port)`jmxPort` The port to use to look up the platform MBeanServer. | Name | `jmxPort` | | ------------- | --------- | | Type | `int` | | Default value | `9001` | | User property | | | Since | | #### [](#integration-tests.stop-goal.parameter-details.skip)`skip` Skip the execution. | Name | `skip` | | ------------- | ----------------------- | | Type | `boolean` | | Default value | `false` | | User property | `spring-boot.stop.skip` | | Since | `1.3.2` | ## [](#integration-tests.examples)Examples ### [](#integration-tests.examples.random-port)Random Port for Integration Tests One nice feature of the Spring Boot test integration is that it can allocate a free port for the web application. When the `start` goal of the plugin is used, the Spring Boot application is started separately, making it difficult to pass the actual port to the integration test itself. The example below showcases how you could achieve the same feature using the [Build Helper Maven Plugin](https://www.mojohaus.org/build-helper-maven-plugin): ```xml org.codehaus.mojo build-helper-maven-plugin reserve-tomcat-port reserve-network-port process-resources tomcat.http.port org.springframework.boot spring-boot-maven-plugin pre-integration-test start --server.port=${tomcat.http.port} post-integration-test stop org.apache.maven.plugins maven-failsafe-plugin ${tomcat.http.port} ``` You can now retrieve the `test.server.port` system property in any of your integration test to create a proper `URL` to the server. ### [](#integration-tests.examples.jmx-port)Customize JMX Port The `jmxPort` property allows to customize the port the plugin uses to communicate with the Spring Boot application. This example shows how you can customize the port in case `9001` is already used: ```xml org.springframework.boot spring-boot-maven-plugin 9009 pre-integration-test start post-integration-test stop ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you need to configure the JMX port, make sure to do so in the global configuration as shown above so that it is shared by both goals. | ### [](#integration-tests.examples.skip)Skip Integration Tests The `skip` property allows to skip the execution of the Spring Boot maven plugin altogether. This example shows how you can skip integration tests with a command-line property and still make sure that the `repackage` goal runs: ```xml false org.springframework.boot spring-boot-maven-plugin pre-integration-test start ${skip.it} post-integration-test stop ${skip.it} org.apache.maven.plugins maven-failsafe-plugin ${skip.it} ``` By default, the integration tests will run but this setup allows you to easily disable them on the command-line as follows: ```shell $ mvn verify -Dskip.it=true ``` * [Spring Boot](../index.html) * [4.1.1](integration-tests.html) * [4.0.8](../4.0/maven-plugin/integration-tests.html) * [3.5.16](../3.5/maven-plugin/integration-tests.html) * [3.4.13](../3.4/maven-plugin/integration-tests.html) * [3.3.13](../3.3/maven-plugin/integration-tests.html) - [4.2.0-M2](../4.2/maven-plugin/integration-tests.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/maven-plugin/integration-tests.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/maven-plugin/integration-tests.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/maven-plugin/integration-tests.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/actuator/enabling.html ---- # Enabling Production-ready Features The [`spring-boot-actuator`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-actuator) module provides all of Spring Boot’s production-ready features. The recommended way to enable the features is to add a dependency on the `spring-boot-starter-actuator` starter. Definition of Actuator An actuator is a manufacturing term that refers to a mechanical device for moving or controlling something. Actuators can generate a large amount of motion from a small change. To add the actuator to a Maven-based project, add the following starter dependency: ```xml org.springframework.boot spring-boot-starter-actuator ``` For Gradle, use the following declaration: ```gradle dependencies { implementation 'org.springframework.boot:spring-boot-starter-actuator' } ``` * [Spring Boot](../../index.html) * [4.1.1](enabling.html) * [4.0.8](../../4.0/reference/actuator/enabling.html) * [3.5.16](../../3.5/reference/actuator/enabling.html) * [3.4.13](../../3.4/reference/actuator/enabling.html) * [3.3.13](../../3.3/reference/actuator/enabling.html) - [4.2.0-M2](../../4.2/reference/actuator/enabling.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/actuator/enabling.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/actuator/enabling.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/actuator/enabling.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/dsl/package-use.html ---- Uses of Package\ org.springframework.boot.gradle.dsl =================================== No usage of org.springframework.boot.gradle.dsl ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index.html ---- [org/springframework/boot/maven/package-summary.html](org/springframework/boot/maven/package-summary.html) ---- url: https://docs.spring.io/spring-boot/how-to/aot.html ---- # Ahead-of-Time Processing A number of questions often arise when people use the ahead-of-time processing of Spring Boot applications. This section addresses those questions. ## [](#howto.aot.conditions)Conditions Ahead-of-time processing optimizes the application and evaluates [`@Conditional`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Conditional.html) annotations based on the environment at build time. [Profiles](../reference/features/profiles.html) are implemented through conditions and are therefore affected, too. If you want beans that are created based on a condition in an ahead-of-time optimized application, you have to set up the environment when building the application. The beans which are created while ahead-of-time processing at build time are then always created when running the application and can’t be switched off. To do this, you can set the profiles which should be used when building the application. For Maven, this works by setting the `profiles` configuration of the `spring-boot-maven-plugin:process-aot` execution: ```xml native org.springframework.boot spring-boot-maven-plugin process-aot profile-a,profile-b ``` For Gradle, you need to configure the `ProcessAot` task: ```gradle tasks.withType(org.springframework.boot.gradle.tasks.aot.ProcessAot).configureEach { args('--spring.profiles.active=profile-a,profile-b') } ``` Profiles which only change configuration properties that don’t influence conditions are supported without limitations when running ahead-of-time optimized applications. * [Spring Boot](../index.html) * [4.1.1](aot.html) * [4.0.8](../4.0/how-to/aot.html) * [3.5.16](../3.5/how-to/aot.html) * [3.4.13](../3.4/how-to/aot.html) * [3.3.13](../3.3/how-to/aot.html) - [4.2.0-M2](../4.2/how-to/aot.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/aot.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/aot.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/aot.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/how-to/docker-compose.html ---- # Docker Compose This section includes topics relating to the Docker Compose support in Spring Boot. ## [](#howto.docker-compose.jdbc-url)Customizing the JDBC URL When using [`JdbcConnectionDetails`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/autoconfigure/JdbcConnectionDetails.html) with Docker Compose, the parameters of the JDBC URL can be customized by applying the `org.springframework.boot.jdbc.parameters` label to the service. For example: ```yaml services: postgres: image: 'postgres:15.3' environment: - 'POSTGRES_USER=myuser' - 'POSTGRES_PASSWORD=secret' - 'POSTGRES_DB=mydb' ports: - '5432:5432' labels: org.springframework.boot.jdbc.parameters: 'ssl=true&sslmode=require' ``` With this Docker Compose file in place, the JDBC URL used is `jdbc:postgresql://127.0.0.1:5432/mydb?ssl=true&sslmode=require`. ## [](#howto.docker-compose.sharing-services)Sharing Services Between Multiple Applications If you want to share services between multiple applications, create the `compose.yaml` file in one of the applications and then use the configuration property `spring.docker.compose.file` in the other applications to reference the `compose.yaml` file. You should also set `spring.docker.compose.lifecycle-management` to `start-only`, as it defaults to `start-and-stop` and stopping one application would shut down the shared services for the other still running applications as well. Setting it to `start-only` won’t stop the shared services on application stop, but a caveat is that if you shut down all applications, the services remain running. You can stop the services manually by running `docker compose stop` on the command line in the directory which contains the `compose.yaml` file. * [Spring Boot](../index.html) * [4.1.1](docker-compose.html) * [4.0.8](../4.0/how-to/docker-compose.html) * [3.5.16](../3.5/how-to/docker-compose.html) * [3.4.13](../3.4/how-to/docker-compose.html) * [3.3.13](../3.3/how-to/docker-compose.html) - [4.2.0-M2](../4.2/how-to/docker-compose.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/docker-compose.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/docker-compose.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/docker-compose.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-1.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## A * [AbstractAotMojo](../org/springframework/boot/maven/AbstractAotMojo.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Abstract base class for AOT processing MOJOs. * [AbstractAotMojo(ToolchainManager)](../org/springframework/boot/maven/AbstractAotMojo.html#%3Cinit%3E\(org.apache.maven.toolchain.ToolchainManager\)) - Constructor for class org.springframework.boot.maven.[AbstractAotMojo](../org/springframework/boot/maven/AbstractAotMojo.html "class in org.springframework.boot.maven")   * [AbstractAotMojo.Errors](../org/springframework/boot/maven/AbstractAotMojo.Errors.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) [`DiagnosticListener`](https://docs.oracle.com/en/java/javase/17/docs/api/java.compiler/javax/tools/DiagnosticListener.html "class or interface in javax.tools") used to collect errors. * [AbstractDependencyFilterMojo](../org/springframework/boot/maven/AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) A base mojo filtering the dependencies of the project. * [AbstractDependencyFilterMojo()](../org/springframework/boot/maven/AbstractDependencyFilterMojo.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.maven.[AbstractDependencyFilterMojo](../org/springframework/boot/maven/AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven")   * [AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter](../org/springframework/boot/maven/AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) `ArtifactFilter` to exclude test scope dependencies. * [AbstractPackagerMojo](../org/springframework/boot/maven/AbstractPackagerMojo.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Abstract base class for classes that work with an `Packager`. * [AbstractPackagerMojo(MavenProjectHelper)](../org/springframework/boot/maven/AbstractPackagerMojo.html#%3Cinit%3E\(org.apache.maven.project.MavenProjectHelper\)) - Constructor for class org.springframework.boot.maven.[AbstractPackagerMojo](../org/springframework/boot/maven/AbstractPackagerMojo.html "class in org.springframework.boot.maven")   * [AbstractPackagerMojo.LayoutType](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") - Enum Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Archive layout types. * [AbstractRunMojo](../org/springframework/boot/maven/AbstractRunMojo.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Base class to run a Spring Boot application. * [AbstractRunMojo(ToolchainManager)](../org/springframework/boot/maven/AbstractRunMojo.html#%3Cinit%3E\(org.apache.maven.toolchain.ToolchainManager\)) - Constructor for class org.springframework.boot.maven.[AbstractRunMojo](../org/springframework/boot/maven/AbstractRunMojo.html "class in org.springframework.boot.maven")   * [ArtifactsLibraries](../org/springframework/boot/maven/ArtifactsLibraries.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) `Libraries` backed by Maven `Artifact`s. * [ArtifactsLibraries(Set, Collection, Collection, Log)](../org/springframework/boot/maven/ArtifactsLibraries.html#%3Cinit%3E\(java.util.Set,java.util.Collection,java.util.Collection,org.apache.maven.plugin.logging.Log\)) - Constructor for class org.springframework.boot.maven.[ArtifactsLibraries](../org/springframework/boot/maven/ArtifactsLibraries.html "class in org.springframework.boot.maven") Creates a new `ArtifactsLibraries` from the given `artifacts`. * [ArtifactsLibraries(Set, Set, Collection, Collection, Log)](../org/springframework/boot/maven/ArtifactsLibraries.html#%3Cinit%3E\(java.util.Set,java.util.Set,java.util.Collection,java.util.Collection,org.apache.maven.plugin.logging.Log\)) - Constructor for class org.springframework.boot.maven.[ArtifactsLibraries](../org/springframework/boot/maven/ArtifactsLibraries.html "class in org.springframework.boot.maven") Creates a new `ArtifactsLibraries` from the given `artifacts`. [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayersSpec.html ---- # Class LayeredSpec.IntoLayersSpec\ [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.gradle.tasks.bundling.LayeredSpec.IntoLayersSpec\ * Type Parameters: `S` - the type of [`LayeredSpec.IntoLayerSpec`](LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") used by this spec - All Implemented Interfaces: `Serializable` * Direct Known Subclasses: `LayeredSpec.ApplicationSpec, LayeredSpec.DependenciesSpec` - Enclosing class: `LayeredSpec` *** public abstract static class LayeredSpec.IntoLayersSpec\ extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") implements [Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io") Base class for specs that control the layers to which a category of content should belong. * Since: 2.3.0 * Author: Madhura Bhave, Scott Frederick, Phillip Webb * See Also: * [Serialized Form](../../../../../../serialized-form.html#org.springframework.boot.gradle.tasks.bundling.LayeredSpec.IntoLayersSpec) - ## Method Summary Modifier and Type Method Description `void` `intoLayer(String layer)`   `void` `intoLayer(String layer, Action action)`   ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Method Details * ### intoLayer public void intoLayer​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") layer) * ### intoLayer public void intoLayer​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") layer, [Action](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Action.html "class or interface in org.gradle.api")<[S](#type-param-S "type parameter in LayeredSpec.IntoLayersSpec")> action) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/PropertiesMergingResourceTransformer.html ---- # Class PropertiesMergingResourceTransformer [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.maven.PropertiesMergingResourceTransformer * All Implemented Interfaces: `org.apache.maven.plugins.shade.resource.ReproducibleResourceTransformer, org.apache.maven.plugins.shade.resource.ResourceTransformer` *** public class PropertiesMergingResourceTransformer extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") implements org.apache.maven.plugins.shade.resource.ReproducibleResourceTransformer Extension for the [Maven shade plugin](https://maven.apache.org/plugins/maven-shade-plugin/) to allow properties files (e.g. META-INF/spring.factories) to be merged without losing any information. * Since: 1.0.0 * Author: Dave Syer, Andy Wilkinson - ## Constructor Summary Constructors Constructor Description `PropertiesMergingResourceTransformer()`   - ## Method Summary Modifier and Type Method Description `boolean` `canTransformResource(String resource)`   `Properties` `getData()` Return the data the properties being merged. `@Nullable String` `getResource()`   `boolean` `hasTransformedResource()`   `void` `modifyOutputStream(JarOutputStream os)`   `void` `processResource(String resource, InputStream inputStream, List relocators)` Deprecated. `void` `processResource(String resource, InputStream inputStream, List relocators, long time)`   `void` `setResource(@Nullable String resource)`   ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### PropertiesMergingResourceTransformer public PropertiesMergingResourceTransformer() * ## Method Details * ### getData public [Properties](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Properties.html "class or interface in java.util") getData() Return the data the properties being merged. * Returns: the data * ### canTransformResource public boolean canTransformResource​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") resource) * Specified by: `canTransformResource` in interface `org.apache.maven.plugins.shade.resource.ResourceTransformer` * ### processResource [@Deprecated](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html "class or interface in java.lang")([since](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html#since\(\) "class or interface in java.lang")="2.4.0", [forRemoval](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html#forRemoval\(\) "class or interface in java.lang")=false) public void processResource​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") resource, [InputStream](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html "class or interface in java.io") inputStream, [List](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html "class or interface in java.util")\ relocators) throws [IOException](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html "class or interface in java.io") Deprecated. * Specified by: `processResource` in interface `org.apache.maven.plugins.shade.resource.ResourceTransformer` * Throws: `IOException` * ### processResource public void processResource​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") resource, [InputStream](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html "class or interface in java.io") inputStream, [List](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html "class or interface in java.util")\ relocators, long time) throws [IOException](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html "class or interface in java.io") * Specified by: `processResource` in interface `org.apache.maven.plugins.shade.resource.ReproducibleResourceTransformer` * Throws: `IOException` * ### hasTransformedResource public boolean hasTransformedResource() * Specified by: `hasTransformedResource` in interface `org.apache.maven.plugins.shade.resource.ResourceTransformer` * ### modifyOutputStream public void modifyOutputStream​([JarOutputStream](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/jar/JarOutputStream.html "class or interface in java.util.jar") os) throws [IOException](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html "class or interface in java.io") * Specified by: `modifyOutputStream` in interface `org.apache.maven.plugins.shade.resource.ResourceTransformer` * Throws: `IOException` * ### getResource public @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getResource() * ### setResource public void setResource​(@Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") resource) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/aot/package-use.html ---- Uses of Package\ org.springframework.boot.gradle.tasks.aot ========================================= Packages that use [org.springframework.boot.gradle.tasks.aot](package-summary.html) Package Description [org.springframework.boot.gradle.tasks.aot](#org.springframework.boot.gradle.tasks.aot) Support for ahead-of-time processing of an application built with Gradle. * Classes in [org.springframework.boot.gradle.tasks.aot](package-summary.html) used by [org.springframework.boot.gradle.tasks.aot](package-summary.html) Class Description [AbstractAot](class-use/AbstractAot.html#org.springframework.boot.gradle.tasks.aot) Specialization of [`JavaExec`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") to be used as a base class for tasks that perform ahead-of-time processing. ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/index-files/index-13.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ## S * [setApplication(LayeredSpec.ApplicationSpec)](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html#setApplication\(org.springframework.boot.gradle.tasks.bundling.LayeredSpec.ApplicationSpec\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Sets the [`LayeredSpec.ApplicationSpec`](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which application classes are resources belong. * [setClasspath(Object)](../org/springframework/boot/gradle/plugin/ResolveMainClassName.html#setClasspath\(java.lang.Object\)) - Method in class org.springframework.boot.gradle.plugin.[ResolveMainClassName](../org/springframework/boot/gradle/plugin/ResolveMainClassName.html "class in org.springframework.boot.gradle.plugin") Sets the classpath that the task will examine when resolving the main class name. * [setClasspath(Object)](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html#setClasspath\(java.lang.Object\)) - Method in interface org.springframework.boot.gradle.tasks.bundling.[BootArchive](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") Sets the classpath to include in the archive. * [setClasspath(Object)](../org/springframework/boot/gradle/tasks/bundling/BootJar.html#setClasspath\(java.lang.Object\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootJar](../org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling")   * [setClasspath(FileCollection)](../org/springframework/boot/gradle/plugin/ResolveMainClassName.html#setClasspath\(org.gradle.api.file.FileCollection\)) - Method in class org.springframework.boot.gradle.plugin.[ResolveMainClassName](../org/springframework/boot/gradle/plugin/ResolveMainClassName.html "class in org.springframework.boot.gradle.plugin") Sets the classpath that the task will examine when resolving the main class name. * [setClasspath(FileCollection)](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html#setClasspath\(org.gradle.api.file.FileCollection\)) - Method in interface org.springframework.boot.gradle.tasks.bundling.[BootArchive](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") Sets the classpath to include in the archive. * [setClasspath(FileCollection)](../org/springframework/boot/gradle/tasks/bundling/BootJar.html#setClasspath\(org.gradle.api.file.FileCollection\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootJar](../org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling")   * [setClasspathRoots(FileCollection)](../org/springframework/boot/gradle/tasks/aot/ProcessTestAot.html#setClasspathRoots\(org.gradle.api.file.FileCollection\)) - Method in class org.springframework.boot.gradle.tasks.aot.[ProcessTestAot](../org/springframework/boot/gradle/tasks/aot/ProcessTestAot.html "class in org.springframework.boot.gradle.tasks.aot") Sets the classpath roots that should be scanned for test classes to process. * [setDependencies(LayeredSpec.DependenciesSpec)](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html#setDependencies\(org.springframework.boot.gradle.tasks.bundling.LayeredSpec.DependenciesSpec\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Sets the [`LayeredSpec.DependenciesSpec`](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which dependencies belong. * [setProvidedClasspath(Object)](../org/springframework/boot/gradle/tasks/bundling/BootWar.html#setProvidedClasspath\(java.lang.Object\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootWar](../org/springframework/boot/gradle/tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling") Sets the provided classpath to include in the `WEB-INF/lib-provided` directory of the war. * [setProvidedClasspath(FileCollection)](../org/springframework/boot/gradle/tasks/bundling/BootWar.html#setProvidedClasspath\(org.gradle.api.file.FileCollection\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootWar](../org/springframework/boot/gradle/tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling") Sets the provided classpath to include in the `WEB-INF/lib-provided` directory of the war. * [setPullPolicy(String)](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#setPullPolicy\(java.lang.String\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Sets image pull policy that will be used when building the image. * [sourceResources(SourceSet)](../org/springframework/boot/gradle/tasks/run/BootRun.html#sourceResources\(org.gradle.api.tasks.SourceSet\)) - Method in class org.springframework.boot.gradle.tasks.run.[BootRun](../org/springframework/boot/gradle/tasks/run/BootRun.html "class in org.springframework.boot.gradle.tasks.run") Adds the [`source directories`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/SourceDirectorySet.html#getSrcDirs\(\) "class or interface in org.gradle.api.file") of the given `sourceSet's` [`resources`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html#getResources\(\) "class or interface in org.gradle.api.tasks") to the start of the classpath in place of the [`output's`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html#getOutput\(\) "class or interface in org.gradle.api.tasks") [`resources directory`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSetOutput.html#getResourcesDir\(\) "class or interface in org.gradle.api.tasks"). * [SpringBootAotPlugin](../org/springframework/boot/gradle/plugin/SpringBootAotPlugin.html "class in org.springframework.boot.gradle.plugin") - Class in [org.springframework.boot.gradle.plugin](../org/springframework/boot/gradle/plugin/package-summary.html) Gradle plugin for Spring Boot AOT. * [SpringBootAotPlugin()](../org/springframework/boot/gradle/plugin/SpringBootAotPlugin.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.gradle.plugin.[SpringBootAotPlugin](../org/springframework/boot/gradle/plugin/SpringBootAotPlugin.html "class in org.springframework.boot.gradle.plugin")   * [SpringBootExtension](../org/springframework/boot/gradle/dsl/SpringBootExtension.html "class in org.springframework.boot.gradle.dsl") - Class in [org.springframework.boot.gradle.dsl](../org/springframework/boot/gradle/dsl/package-summary.html) Entry point to Spring Boot's Gradle DSL. * [SpringBootExtension(Project)](../org/springframework/boot/gradle/dsl/SpringBootExtension.html#%3Cinit%3E\(org.gradle.api.Project\)) - Constructor for class org.springframework.boot.gradle.dsl.[SpringBootExtension](../org/springframework/boot/gradle/dsl/SpringBootExtension.html "class in org.springframework.boot.gradle.dsl") Creates a new `SpringBootPluginExtension` that is associated with the given `project`. * [SpringBootPlugin](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html "class in org.springframework.boot.gradle.plugin") - Class in [org.springframework.boot.gradle.plugin](../org/springframework/boot/gradle/plugin/package-summary.html) Gradle plugin for Spring Boot. * [SpringBootPlugin()](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.gradle.plugin.[SpringBootPlugin](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html "class in org.springframework.boot.gradle.plugin")   * [STORED](../org/springframework/boot/gradle/tasks/bundling/ZipCompression.html#STORED) - Enum constant in enum class org.springframework.boot.gradle.tasks.bundling.[ZipCompression](../org/springframework/boot/gradle/tasks/bundling/ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") The entry should be [`ZipEntry.STORED`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/zip/ZipEntry.html#STORED "class or interface in java.util.zip") in the archive. [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ---- url: https://docs.spring.io/spring-boot/how-to/deployment/index.html ---- # Deploying Spring Boot Applications Spring Boot’s flexible packaging options provide a great deal of choice when it comes to deploying your application. You can deploy Spring Boot applications to a variety of cloud platforms and to virtual or real machines. This section covers some of the more common deployment scenarios. * [Spring Boot](../../index.html) * [4.1.1](index.html) * [4.0.8](../../4.0/how-to/deployment/index.html) * [3.5.16](../../3.5/how-to/deployment/index.html) * [3.4.13](../../3.4/how-to/deployment/index.html) * [3.3.13](../../3.3/how-to/deployment/index.html) - [4.2.0-M2](../../4.2/how-to/deployment/index.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/how-to/deployment/index.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/how-to/deployment/index.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/how-to/deployment/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/io/grpc.html ---- # gRPC Google Remote Procedure Call (gRPC) is a high-performance RPC framework that enables client-server communication using binary messages. Spring Boot includes support for developing and testing both client and server gRPC applications. The underlying message format used by gRPC is Protocol Buffers, which allow messages to be created and consumed by a wide variety of programming languages. ## [](#io.grpc.servicedefinitions)Service Definitions To develop a gRPC application, you first need a Protocol Buffers service definition file. A `.proto` file defines the services and messages that your application can consume or provide. Here’s an example of a typical `.proto` file that uses [the `proto3` revision](https://protobuf.dev/programming-guides/proto3/) of the protocol buffers language: ```protobuf syntax = "proto3"; option java_package = "com.example.grpc.proto"; option java_multiple_files = true; service HelloWorld { rpc SayHello (HelloRequest) returns (HelloReply) {} } message HelloRequest { string name = 1; } message HelloReply { string message = 1; } ``` This file defines a `HelloWorld` service with a single method that accepts a `HelloRequest` message and returns a `HelloReply` message. The `HelloRequest` message contains a `name` string field. The `HelloReply` message contains a `message` string field. With the exception of the `java_package` and `java_multiple_files` options, there is nothing in the `.proto` file that is specific to the Java programming language. ### [](#io.grpc.servicedefinitions.generatingjavacode)Generating Java Code Since `.proto` files are language agnostic, we need a process to convert them into usable Java code. We can then use the generated code to either make a remote procedure call to a running service or implement the service ourselves so that others may call it. The exact process you use to generate code will depend on your build system. Spring Boot supports both Maven and Gradle protobuf plugins, but you are free to use whatever solution works best for you. #### [](#io.grpc.servicedefinitions.generatingjavacode.maven)Using the Maven Plugin Spring Boot includes dependency management for the `io.github.ascopes:protobuf-maven-plugin` Maven plugin. If you are using the `spring-boot-starter-parent` POM, you’ll also get sensible out-of-the-box configuration. The following shows a typical Maven POM file that uses the plugin: ```xml 4.0.0 org.springframework.boot spring-boot-starter-parent 4.1.1 com.example myproject 0.0.1-SNAPSHOT io.github.ascopes protobuf-maven-plugin org.springframework.boot spring-boot-maven-plugin ``` Since POM above extends `spring-boot-starter-parent`, you’ll get the following: * Configuration of the `protoc` version. * Configuration of the `binary-maven` plugin. * Execution configuration for the `generate` goal. The `.proto` files should be added to `src/main/proto`. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you don’t use `spring-boot-starter-parent`, or you want to configure the plugin directly, refer to the [protobuf-maven-plugin documentation](https://ascopes.github.io/protobuf-maven-plugin). If you use Spring Boot’s dependency management the `${protobuf-java.version}` and `${grpc-java.version}` properties will be useful. | #### [](#io.grpc.servicedefinitions.generatingjavacode.gradle)Using the Gradle Plugin Spring Boot includes dependency management for the `com.google.protobuf:protobuf-gradle-plugin` Gradle plugin. In addition, the `spring-boot-gradle-plugin` will react to the presence of the protobuf plugin and configure it appropriately. The following shows a typical Gradle file that uses the plugin: ```gradle plugins { id 'java' id 'org.springframework.boot' version '4.1.1' id 'io.spring.dependency-management' version '1.1.7' id 'com.google.protobuf' version '0.9.6' } group = 'com.example' version = '0.0.1-SNAPSHOT' java { toolchain { languageVersion = JavaLanguageVersion.of(17) } } repositories { mavenCentral() } protobuf { plugins { grpc {} } } ``` The `org.springframework.boot` reacts to the `com.google.protobuf` plugin and configures `protoc` and its version. Additionally, because the `protobuf` extension has been configured to use the `grpc` plugin, the `org.springframework.boot` plugin also configures `protoc-gen-grpc-java` and its version. The `.proto` files should be added to `src/main/proto`. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you don’t use `org.springframework.boot` plugin, or you want to configure the plugin directly, refer to the [protobuf-gradle-plugin documentation](https://github.com/google/protobuf-gradle-plugin). | ## [](#io.grpc.server)Writing a gRPC Server Application Spring Boot provides a `spring-boot-grpc-server` module and a `spring-boot-starter-grpc-server` starter POM that you can use for server applications. In order to write the actual server code, you’ll need to extend one or more of the base classes generated from your `.proto` file and expose them as Spring beans. Spring gRPC will automatically expose any bean that implements [`BindableService`](https://javadoc.io/doc/io.grpc/grpc-api/1.83.1/io/grpc/BindableService.html) as a gRPC server. Since all `.proto` generated classes implement [`BindableService`](https://javadoc.io/doc/io.grpc/grpc-api/1.83.1/io/grpc/BindableService.html), adding them as beans is enough to expose them over gRPC. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------- | | ** | For more details, see [the Spring gRPC documentation](https://docs.spring.io/spring-grpc/reference/1.1/server.html#_create_a_grpc_service). | The following example shows how the `HelloWorld` service from the `.proto` file above could be implemented. In this example, we’re using the [`@GrpcService`](https://docs.spring.io/spring-grpc/reference/1.1/api/java/org/springframework/grpc/server/service/GrpcService.html) annotation and assuming that the code is in a package that will be picked up by component scanning: * Java * Kotlin ```java import io.grpc.stub.StreamObserver; import org.springframework.grpc.server.service.GrpcService; @GrpcService public class MyHelloWorldService extends HelloWorldGrpc.HelloWorldImplBase { @Override public void sayHello(HelloRequest request, StreamObserver responseObserver) { String message = "Hello '%s'".formatted(request.getName()); HelloReply reply = HelloReply.newBuilder().setMessage(message).build(); responseObserver.onNext(reply); responseObserver.onCompleted(); } } ``` ```kotlin import io.grpc.stub.StreamObserver import org.springframework.grpc.server.service.GrpcService @GrpcService class MyHelloWorldService : HelloWorldGrpc.HelloWorldImplBase() { override fun sayHello(request: HelloRequest, responseObserver: StreamObserver) { val message = "Hello '${request.getName()}'" val reply = HelloReply.newBuilder().setMessage(message).build() responseObserver.onNext(reply) responseObserver.onCompleted() } } ``` If the application makes used of `spring-boot-starter-grpc-server`, then Netty will be used as the server implementation listening on port `9090`. You can test your application using [grpcurl](https://github.com/fullstorydev/grpcurl): ```shell $ grpcurl -d '{"name":"Spring"}' -plaintext localhost:9090 HelloWorld.SayHello ``` ```json { "message": "Hello 'Spring'" } ``` ### [](#io.grpc.server.netty-shaded)Switching to a Netty Shaded Server If you find that the version of Netty provided by the `spring-boot-starter-grpc-server` starter POM isn’t compatible with other libraries you use, you can switch to a “shaded” version. To switch, you can exclude `io.grpc:grpc-netty` and include `io.grpc:grpc-netty-shaded`. For example: * Maven * Gradle ```xml org.springframework.boot spring-boot-starter-grpc-server io.grpc grpc-netty io.grpc grpc-netty-shaded ``` ```gradle dependencies { implementation('org.springframework.boot:spring-boot-starter-grpc-server') { // Exclude the gRPC Netty dependency exclude group: 'io.grpc', module: 'grpc-netty' } // Use gRPC Netty Shaded instead implementation "io.grpc:grpc-netty-shaded" } ``` ### [](#io.grpc.server.servlet)Switching to a Servlet Container It’s possible to expose gRPC services using a regular Servlet Container such as Tomcat rather than using Netty. To do so, your Servlet Container must be configured to support HTTP/2. To switch to the Servlet gRPC implementation, you can exclude `io.grpc:grpc-netty` and include `io.grpc:grpc-servlet-jakarta`. For example: * Maven * Gradle ```xml org.springframework.boot spring-boot-starter-webmvc org.springframework.boot spring-boot-starter-grpc-server io.grpc grpc-netty io.grpc grpc-servlet-jakarta ``` ```gradle dependencies { implementation('org.springframework.boot:spring-boot-starter-webmvc') { implementation('org.springframework.boot:spring-boot-starter-grpc-server') { // Exclude the gRPC Netty dependency exclude group: 'io.grpc', module: 'grpc-netty' } // Use gRPC Servlet Jakarta instead implementation "io.grpc:grpc-servlet-jakarta" } ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Remember to include a Servlet Container dependency – `spring-boot-starter-tomcat`, for example – and to set `server.http2.enabled` to `true`. | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | When using a servlet container, certain gRPC server configuration properties are not relevant and will be ignored. For example, `spring.grpc.server.port` is ignored since `server.port` is used to set a web server port. | ### [](#io.grpc.server.ssl)SSL Support SSL can be configured for both `grpc-netty` and `grpc-netty-shaded` servers using SSL bundles. See the [SSL core documentation](../features/ssl.html) for details on how to declare an SSL bundle. Once your bundle has been defined, you can use the following properties in your gRPC server application to use it: * Properties * YAML ```properties spring.grpc.server.ssl.bundle=mysslbundle ``` ```yaml spring: grpc: server: ssl: bundle: mysslbundle ``` Client authentication can also be configured by setting `spring.grpc.server.ssl.client-auth` to `optional` or `require`. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------- | | ** | To temporarily disable server SSL support – to aid with testing, for example – set `spring.grpc.server.ssl.enabled` to `false`. | ### [](#io.grpc.server.in-process)Using an In-Process Server You can run an in-process server by including the `io.grpc:grpc-inprocess` dependency on your classpath and defining a `spring.grpc.server.inprocess.name` property. In this mode, the in-process server factory is auto-configured in addition to the regular server factory. The name you provide can be used as a client channel target using the form `in-process:`. ### [](#io.grpc.server.reflection)Reflection When it’s available, Spring Boot will auto-configure the [gRPC Reflection service](https://grpc.io/docs/guides/reflection/). This allows clients to browse the metadata of your services and download their `.proto` files. The reflection service resides in the `io.grpc:grpc-services` library, which is an optional dependency. You will need to add the dependency to your project in order for auto-configuration to apply. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you have the `io.grpc:grpc-services` library but prefer that reflection isn’t auto-configured, you can set `spring.grpc.server.reflection.enabled` to `false`. | ### [](#io.grpc.server.health)Server Health A gRPC server can provide health information using a standard service API ([health/v1](https://github.com/grpc/grpc-proto/blob/master/grpc/health/v1/health.proto)). This allows clients to check on the health of your server services a route traffic appropriately. Spring Boot provides a bridge between its own `spring-boot-health` module and the standard gRPC health service. Health information is provided whenever the `io.grpc:grpc-services` and `org.springframework.boot:spring-boot-health` modules are on your classpath. | | | | -- | -------------------------------------------------------------------------------------------------------------- | | ** | If you don’t want health indicators to be exposed, you can set `spring.grpc.server.health.enabled` to `false`. | #### [](#io.grpc.server.health.service-mappings)Service Specific Health Mappings By default, health information is provided for the overall server status (`""`) using all available health indicators. It is also possible to provide fine-grained health information for specific services by including only a sub-set of health indicators. Custom mapping and ordering rules can also be defined on a per-service basis. For example, the following configuration will provide health for “myservice” using only the `db` and `redis` indicators. * Properties * YAML ```properties spring.grpc.server.health.service.myservice.include[0]=db spring.grpc.server.health.service.myservice.include[1]=redis ``` ```yaml spring: grpc: server: health: service: myservice: include: - db - redis ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can set `spring.grpc.server.health.include-overall-health` to `false` to disable the overall server status health if you only want to provide service-specific health. | #### [](#io.grpc.server.health.push)Push Configuration Unlike web-based health checks, gRPC health information is periodically pushed rather than pulled. By default, the first health push happens 5 seconds after the application starts and then every subsequent 5 seconds. To fine-tune this, you can use the following properties: * Properties * YAML ```properties spring.grpc.server.health.schedule.period=5m spring.grpc.server.health.schedule.delay=2s ``` ```yaml spring: grpc: server: health: schedule: period: 5m delay: 2s ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------- | | ** | You can also set `spring.grpc.server.health.schedule.enabled` to `false` if want to send health updates in some other way. | ### [](#io.grpc.server.security)Securing gRPC Server Applications #### [](#io.grpc.server.security.netty)Netty Based Servers Spring gRPC includes features that allow you to secure your Netty based server applications declaratively using Spring Security. This follows similar patterns to those you would use to secure a regular web application. Spring Boot provides auto-configuration for both [`GrpcSecurity`](https://docs.spring.io/spring-grpc/reference/1.1/api/java/org/springframework/grpc/server/security/GrpcSecurity.html) and [`SecurityGrpcExceptionHandler`](https://docs.spring.io/spring-grpc/reference/1.1/api/java/org/springframework/grpc/server/security/SecurityGrpcExceptionHandler.html) beans. Typically gRPC application are then secured using [`@PreAuthorize`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/access/prepost/PreAuthorize.html) annotations on your gRPC service beans, or a [`AuthenticationProcessInterceptor`](https://docs.spring.io/spring-grpc/reference/1.1/api/java/org/springframework/grpc/server/security/AuthenticationProcessInterceptor.html) bean. For more details, please see [the Spring gRPC documentation](https://docs.spring.io/spring-grpc/reference/1.1/server.html#_declarative_security_with_spring_security). #### [](#io.grpc.server.security.servlet)Servlet Container Based Servers If your gRPC server is running [within a standard Servlet Container](../web/servlet.html), you can use typical [web security configuration](../web/spring-security.html#web.security.spring-mvc) to secure your application. Spring Boot will auto-configre [`GrpcServerExecutorProvider`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/grpc/server/autoconfigure/GrpcServerExecutorProvider.html) and [`SecurityContextServerInterceptor`](https://docs.spring.io/spring-grpc/reference/1.1/api/java/org/springframework/grpc/server/security/SecurityContextServerInterceptor.html) beans to ensure that Spring Security works correctly. Cross-Site Request Forgery (CSRF) protection is incompatible with the gRPC protocol and will be disabled by default for all gRPC requests. If you prefer to configure your own CSRF protection, you can switch this off by setting `spring.grpc.server.security.csrf.enabled` to `false`. To help with manual Security configuration, Spring Boot provides request matchers for gRPC services. Matches are available for both servlet and reactive stacks. For example, the following will include all gRPC services with the exception of “special”. * Java * Kotlin ```java import org.springframework.boot.grpc.server.autoconfigure.security.web.servlet.GrpcRequest; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.web.SecurityFilterChain; import static org.springframework.security.config.Customizer.withDefaults; @Configuration(proxyBeanMethods = false) public class MySecurityConfiguration { @Bean public SecurityFilterChain securityFilterChain(HttpSecurity http) { http.securityMatcher(GrpcRequest.toAnyService().excluding("special")); http.authorizeHttpRequests((requests) -> requests.anyRequest().hasRole("GRPC_ADMIN")); http.httpBasic(withDefaults()); return http.build(); } } ``` ```kotlin import org.springframework.boot.grpc.server.autoconfigure.security.web.servlet.GrpcRequest import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.security.config.Customizer.withDefaults import org.springframework.security.config.annotation.web.builders.HttpSecurity import org.springframework.security.web.SecurityFilterChain @Configuration(proxyBeanMethods = false) class MySecurityConfiguration { @Bean fun securityFilterChain(http: HttpSecurity): SecurityFilterChain { http.securityMatcher(GrpcRequest.toAnyService().excluding("special")) http.authorizeHttpRequests { requests -> requests.anyRequest().hasRole("GRPC_ADMIN") } http.httpBasic(withDefaults()) return http.build() } } ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | For reactive matches use [`org.springframework.boot.grpc.server.autoconfigure.security.web.servlet.GrpcRequest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/grpc/server/autoconfigure/security/web/servlet/GrpcRequest.html). | #### [](#io.grpc.server.security.oauth-resource-server)OAuth2 Resource Server [OAuth2](https://oauth.net/2/) is a widely used authorization framework. Spring Boot’s OAuth2 Resource Server support in compatible with gRPC and may be configured in the usual way. For details of how to configure an OAuth2 Resource Server to use with your gRPC server application, see the [“OAuth2” section](../security/oauth2.html#security.oauth2.server) of under “Security”. ## [](#io.grpc.client)Writing a gRPC Client Application Spring Boot provides a `spring-boot-grpc-client` module and a `spring-boot-starter-grpc-client` starter POM that you can use for client applications. Clients can call remote gRPC services by importing one or more of the “stub” classes generated from their `.proto` file. You can use the [`@ImportGrpcClients`](https://docs.spring.io/spring-grpc/reference/1.1/api/java/org/springframework/grpc/client/ImportGrpcClients.html) annotation to import the stub classes you want to use. Each import includes a `target` which can either be a logical channel name, or the base URL of the remote server. We typically recommend using channel names rather than hard-coding targets. Here’s a typical example: * Java * Kotlin ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.grpc.client.ImportGrpcClients; @SpringBootApplication(proxyBeanMethods = false) @ImportGrpcClients(target = "hello", types = HelloWorldGrpc.HelloWorldBlockingStub.class) public class MyApplication { public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } ``` ```kotlin import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.docs.features.springapplication.MyApplication import org.springframework.boot.runApplication import org.springframework.grpc.client.ImportGrpcClients @SpringBootApplication(proxyBeanMethods = false) @ImportGrpcClients(target = "hello", types = [HelloWorldGrpc.HelloWorldBlockingStub::class]) class MyApplication fun main(args: Array) { runApplication(*args) } ``` | | | | -- | ------------------------------------------------------- | | ** | If you don’t specify a `target` then “default” is used. | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can use the `basePackageClasses` or `basePackages` attribute of [`@ImportGrpcClients`](https://docs.spring.io/spring-grpc/reference/1.1/api/java/org/springframework/grpc/client/ImportGrpcClients.html) to import all stubs in given package. | ### [](#io.grpc.client.channel-properties)Channel Properties When the `target` attribute of [`@ImportGrpcClients`](https://docs.spring.io/spring-grpc/reference/1.1/api/java/org/springframework/grpc/client/ImportGrpcClients.html) uses a logical channel name, you’ll need to provide some properties so that Spring Boot can find the actual gRPC server to call. To do that, you can add an entry using `spring.grpc.channel..*` properties. Typically, you’ll configure the actual real `target`, along with any other settings that are unique to the channel. For example, the following will configure `myservice` to use the real target of `static://grpc.example.com:9090`. It also changes the keep-alive timeout and the maximum message size permitted: * Properties * YAML ```properties spring.grpc.client.channel.myservice.target=static://grpc.example.com:9090 spring.grpc.client.channel.myservice.inbound.keepalive.timeout=40s spring.grpc.client.channel.myservice.inbound.message.max-size=8MB ``` ```yaml spring: grpc: client: channel: myservice: target: static://grpc.example.com:9090 inbound: keepalive: timeout: 40s message: max-size: 8MB ``` ### [](#io.grpc.client.stub-beans)Using Stub Beans With your [`@ImportGrpcClients`](https://docs.spring.io/spring-grpc/reference/1.1/api/java/org/springframework/grpc/client/ImportGrpcClients.html) annotations in place, and your properties written, you can use stubs as you would any other bean. For example, here’s the `HelloWorldStub` being injected into a `ApplicationRunner` bean: * Java * Kotlin ```java import org.springframework.boot.ApplicationArguments; import org.springframework.boot.ApplicationRunner; import org.springframework.boot.docs.io.grpc.client.stubbeans.HelloWorldGrpc.HelloWorldBlockingStub; import org.springframework.stereotype.Component; @Component class MyApplicationRunner implements ApplicationRunner { private final HelloWorldBlockingStub helloStub; MyApplicationRunner(HelloWorldGrpc.HelloWorldBlockingStub helloStub) { this.helloStub = helloStub; } @Override public void run(ApplicationArguments args) throws Exception { HelloRequest request = HelloRequest.newBuilder().setName("Spring").build(); HelloReply reply = this.helloStub.sayHello(request); System.out.println(reply.getMessage()); } } ``` ```kotlin import org.springframework.boot.ApplicationArguments import org.springframework.boot.ApplicationRunner class MyApplicationRunner(val helloStub: HelloWorldGrpc.HelloWorldBlockingStub) : ApplicationRunner { override fun run(args: ApplicationArguments) { val request = HelloRequest.newBuilder().setName("Spring").build() val reply: HelloReply = helloStub.sayHello(request) println(reply.getMessage()) } } ``` ### [](#io.grpc.client.netty-shaded)Switching to Netty Shaded Client Transport Under the hood, remote gRPC network calls are made using Netty. If you find that the version of Netty provided by the `spring-boot-starter-grpc-client` starter POM isn’t compatible with other libraries you use, you can switch to a “shaded” version. To switch, you can excluded `io.grpc:grpc-netty` and include `io.grpc:grpc-netty-shaded`. For example: * Maven * Gradle ```xml org.springframework.boot spring-boot-starter-grpc-client io.grpc grpc-netty io.grpc grpc-netty-shaded ``` ```gradle dependencies { implementation('org.springframework.boot:spring-boot-starter-grpc-client') { // Exclude the gRPC Netty dependency exclude group: 'io.grpc', module: 'grpc-netty' } // Use gRPC Netty Shaded instead implementation "io.grpc:grpc-netty-shaded" } ``` ### [](#io.grpc.client.ssl)SSL Support Client gRPC applications can connect to gRPC services using SSL/TSL encrypted connections. You can configure gRPC connections to use standard one-way-TLS, or mutual TLS #### [](#io.grpc.client.ssl.one-way)Standard one-way TLS To use standard one-way TLS, you can set the `ssl.enabled` property to `true` in your channel properties. For example, the following will enable an SSL/TLS connection for the `myservice` channel: * Properties * YAML ```properties spring.grpc.client.channel.myservice.target=static://grpc.example.com:9090 spring.grpc.client.channel.myservice.ssl.enabled=true ``` ```yaml spring: grpc: client: channel: myservice: target: static://grpc.example.com:9090 ssl: enabled: true ``` #### [](#io.grpc.client.ssl.mutual)Mutual TLS Mutual TLS (mTLS) is a security protocol that requires both the client and the server to present certificates to each other. To use mutual TLS, you can set the `ssl.bundle` property in your channel properties. See the [SSL core features documentation](../features/ssl.html) for details on how to declare an SSL bundle. Here is an example the configures the `myservice` channel to use the `mybundle` bundle for mutual TLS: * Properties * YAML ```properties spring.grpc.client.channel.myservice.target=static://grpc.example.com:9090 spring.grpc.client.channel.myservice.ssl.bundle=mybundle ``` ```yaml spring: grpc: client: channel: myservice: target: static://grpc.example.com:9090 ssl: bundle: mybundle ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | To temporarily disable client SSL support – to aid with testing, for example – set `bypass-certificate-validation` to `true` on your channel config:- Properties - YAML```properties spring.grpc.client.channel.myservice.bypass-certificate-validation=true ``````yaml spring: grpc: client: channel: myservice: bypass-certificate-validation: true ``` | ### [](#io.grpc.client.in-process)Using In-Process Channels You can communicate with an [in-process server](#io.grpc.server.in-process) (i.e. not listening on a network port) by including the `io.grpc.grpc-inprocess` dependency on your classpath. In this mode, the in-process channel factory is auto-configured in addition to the regular channel factories (e.g. Netty). To prevent users from having to deal with multiple channel factories, a composite channel factory is configured as the primary channel factory bean. The composite consults its composed factories to find the first one that supports the channel target. To use the in-process server, the channel target must be set to `in-process:` | | | | -- | ---------------------------------------------------------------------------------------------------------------------- | | ** | To disable the in-process channel factory, you can set the `spring.grpc.client.inprocess.enabled` property to `false`. | ### [](#io.grpc.client.observability)Observability Spring Boot provides auto-configuration of the [`ObservationGrpcClientInterceptor`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/binder/grpc/ObservationGrpcClientInterceptor.html) whenever Micrometer is available. This interceptor provides observability into your gRPC client applications. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------- | | ** | If you use Micrometer, but prefer to not to use it for gRPC, you can set `spring.grpc.client.observation.enabled` to `false`. | ### [](#io.grpc.client.channel-customization)Channel Customization If you need to customize your gRPC channel beyond the basic properties, you can use a [`GrpcChannelBuilderCustomizer`](https://docs.spring.io/spring-grpc/reference/1.1/api/java/org/springframework/grpc/client/GrpcChannelBuilderCustomizer.html). Each customizer is called with the logical target name and the [`ManagedChannelBuilder`](https://javadoc.io/doc/io.grpc/grpc-api/1.83.1/io/grpc/ManagedChannelBuilder.html) that will build the channel. There’s also a convenient `matching(String pattern)` factory method that will limit customizations to targets that match the given regex pattern. A common customizer use-case is to add [security interceptors](https://docs.spring.io/spring-grpc/reference/1.1/client.html#_http_headers) to the builder. For example, here we’re adding the [`BearerTokenAuthenticationInterceptor`](https://docs.spring.io/spring-grpc/reference/1.1/api/java/org/springframework/grpc/client/interceptor/security/BearerTokenAuthenticationInterceptor.html) to the target matching “hello”: * Java * Kotlin ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.grpc.client.GrpcChannelBuilderCustomizer; import org.springframework.grpc.client.interceptor.security.BasicAuthenticationInterceptor; @Configuration(proxyBeanMethods = false) public class MyGrpcConfiguration { @Bean GrpcChannelBuilderCustomizer helloChannelCustomizer() { return GrpcChannelBuilderCustomizer.matching("hello", (builder) -> builder.intercept(new BasicAuthenticationInterceptor("user", "password"))); } } ``` ```kotlin import io.grpc.ManagedChannelBuilder import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.grpc.client.GrpcChannelBuilderCustomizer import org.springframework.grpc.client.interceptor.security.BasicAuthenticationInterceptor import java.util.function.Consumer @Configuration(proxyBeanMethods = false) class MyGrpcConfiguration { @Bean fun helloChannelCustomizer(): GrpcChannelBuilderCustomizer<*> { return GrpcChannelBuilderCustomizer.matching("hello", { builder -> builder.intercept(BasicAuthenticationInterceptor("user", "password")) }) } } ``` ## [](#io.grpc.testing)Testing gRPC Applications To help test your gRPC client and server applications, you can use the `spring-boot-grpc-test` module or the `spring-boot-starter-grpc-client-test` / `spring-boot-starter-grpc-server-test` starter POMs. ### [](#io.grpc.testing.test-transport)Using In-Process Test Transport The [`@AutoConfigureTestGrpcTransport`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/grpc/test/autoconfigure/AutoConfigureTestGrpcTransport.html) annotation allows you to quickly replace gRPC communication channels with in-process channels specifically designed for testing. Unlike regular in-process channels, these test channels do not require any configuration. Using test gRPC transport means that you don’t need to actually listen on a network port to start your application. This allows your tests to run quickly, whilst still ensuring that your application works as expected. By default, using [`@AutoConfigureTestGrpcTransport`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/grpc/test/autoconfigure/AutoConfigureTestGrpcTransport.html) will: * Configure test [`GrpcServerFactory`](https://docs.spring.io/spring-grpc/reference/1.1/api/java/org/springframework/grpc/server/GrpcServerFactory.html) / [`GrpcChannelFactory`](https://docs.spring.io/spring-grpc/reference/1.1/api/java/org/springframework/grpc/client/GrpcChannelFactory.html) beans * Disable any gRPC servelt registration. * Disable [`GrpcServerFactory`](https://docs.spring.io/spring-grpc/reference/1.1/api/java/org/springframework/grpc/server/GrpcServerFactory.html) bean auto-configuration. * Disable [`GrpcChannelFactory`](https://docs.spring.io/spring-grpc/reference/1.1/api/java/org/springframework/grpc/client/GrpcChannelFactory.html) bean auto-configuration. The following example shows how you can use [`@AutoConfigureTestGrpcTransport`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/grpc/test/autoconfigure/AutoConfigureTestGrpcTransport.html) to test a gRPC server application: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.grpc.test.autoconfigure.AutoConfigureTestGrpcTransport; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.grpc.client.ImportGrpcClients; import static org.assertj.core.api.Assertions.assertThat; @SpringBootTest @AutoConfigureTestGrpcTransport @ImportGrpcClients(types = HelloWorldGrpc.HelloWorldBlockingStub.class) class MyGrpcTests { @Autowired private HelloWorldGrpc.HelloWorldBlockingStub helloStub; @Test void sayHello() { HelloRequest request = HelloRequest.newBuilder().setName("Spring").build(); HelloReply reply = this.helloStub.sayHello(request); assertThat(reply.getMessage()).isEqualTo("Hello 'Spring'"); } } ``` ```kotlin import org.assertj.core.api.Assertions.assertThat import org.jooq.DSLContext import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.grpc.test.autoconfigure.AutoConfigureTestGrpcTransport import org.springframework.boot.test.context.SpringBootTest import org.springframework.grpc.client.ImportGrpcClients @SpringBootTest @AutoConfigureTestGrpcTransport @ImportGrpcClients(types = [HelloWorldGrpc.HelloWorldBlockingStub::class]) class MyGrpcTests(@Autowired val helloStub: HelloWorldGrpc.HelloWorldBlockingStub) { @Test fun sayHello() { val request = HelloRequest.newBuilder().setName("Spring").build() val reply = helloStub.sayHello(request) assertThat(reply.getMessage()).isEqualTo("Hello 'Spring'") } } ``` ### [](#io.grpc.testing.local-server-port)Testing With a Running Server If you prefer to test your gRPC application by starting the real server and using the actual network connection, we recommend that you use random ports. This will ensure that you can run your tests in any environment, and that you won’t accidentally call real services. To start a gRPC server using a random port, set `spring.grpc.server.port` to `0`. You can use the [`@LocalGrpcServerPort`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/grpc/test/autoconfigure/LocalGrpcServerPort.html) annotation to obtain the actual port that the server started on. Here’s an example test: * Java * Kotlin ```java import io.grpc.ManagedChannel; import io.grpc.netty.NettyChannelBuilder; import org.junit.jupiter.api.Test; import org.springframework.boot.docs.io.grpc.testing.localserverport.HelloWorldGrpc.HelloWorldBlockingStub; import org.springframework.boot.grpc.test.autoconfigure.LocalGrpcServerPort; import org.springframework.boot.test.context.SpringBootTest; import static org.assertj.core.api.Assertions.assertThat; @SpringBootTest(properties = "spring.grpc.server.port=0") class MyGrpcIntegrationTests { @LocalGrpcServerPort private int port; @Test void sayHello() { String target = "localhost:%s".formatted(this.port); ManagedChannel channel = NettyChannelBuilder.forTarget(target).usePlaintext().build(); try { HelloWorldBlockingStub hello = HelloWorldGrpc.newBlockingStub(channel); HelloRequest request = HelloRequest.newBuilder().setName("Spring").build(); assertThat(hello.sayHello(request).getMessage()).isEqualTo("Hello 'Spring'"); } finally { channel.shutdown(); } } } ``` ```kotlin import io.grpc.ManagedChannel import io.grpc.netty.NettyChannelBuilder import org.assertj.core.api.Assertions.assertThat import org.junit.jupiter.api.Test import org.springframework.boot.grpc.test.autoconfigure.LocalGrpcServerPort import org.springframework.boot.test.context.SpringBootTest @SpringBootTest(properties = ["spring.grpc.server.port=0"]) class MyGrpcIntegrationTests { @LocalGrpcServerPort var port = 0 @Test fun sayHello() { val target = "localhost:${port}" val channel: ManagedChannel = NettyChannelBuilder.forTarget(target).usePlaintext().build() try { val hello: HelloWorldGrpc.HelloWorldBlockingStub = HelloWorldGrpc.newBlockingStub(channel) val request = HelloRequest.newBuilder().setName("Spring").build() assertThat(hello.sayHello(request).getMessage()).isEqualTo("Hello 'Spring'") } finally { channel.shutdown() } } } ``` * [Spring Boot](../../index.html) * [4.1.1](grpc.html) * [4.0.8](../../4.0/index.html) * [3.5.16](../../3.5/index.html) * [3.4.13](../../3.4/index.html) * [3.3.13](../../3.3/index.html) - [4.2.0-M2](../../4.2/reference/io/grpc.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/io/grpc.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/io/grpc.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/how-to/testing.html ---- # Testing Spring Boot includes a number of testing utilities and support classes as well as a dedicated starter that provides common test dependencies. This section answers common questions about testing. ## [](#howto.testing.with-spring-security)Testing With Spring Security Spring Security provides support for running tests as a specific user. For example, the test in the snippet below will run with an authenticated user that has the `ADMIN` role. * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.webmvc.test.autoconfigure.WebMvcTest; import org.springframework.security.test.context.support.WithMockUser; import org.springframework.test.web.servlet.assertj.MockMvcTester; import static org.assertj.core.api.Assertions.assertThat; @WebMvcTest(UserController.class) class MySecurityTests { @Autowired private MockMvcTester mvc; @Test @WithMockUser(roles = "ADMIN") void requestProtectedUrlWithUser() { assertThat(this.mvc.get().uri("/")).doesNotHaveFailed(); } } ``` ```kotlin import org.assertj.core.api.Assertions.assertThat import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.webmvc.test.autoconfigure.WebMvcTest import org.springframework.security.test.context.support.WithMockUser import org.springframework.test.web.servlet.assertj.MockMvcTester @WebMvcTest(UserController::class) class MySecurityTests(@Autowired val mvc: MockMvcTester) { @Test @WithMockUser(roles = ["ADMIN"]) fun requestProtectedUrlWithUser() { assertThat(mvc.get().uri("/")) .doesNotHaveFailed() } } ``` Spring Security provides comprehensive integration with Spring MVC Test, and this can also be used when testing controllers using the [`@WebMvcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/test/autoconfigure/WebMvcTest.html) slice and [`MockMvc`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/MockMvc.html). For additional details on Spring Security’s testing support, see Spring Security’s [reference documentation](https://docs.spring.io/spring-security/reference/7.1/servlet/test/index.html). ## [](#howto.testing.slice-tests)Structure [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) Classes for Inclusion in Slice Tests Slice tests work by restricting Spring Framework’s component scanning to a limited set of components based on their type. For any beans that are not created through component scanning, for example, beans that are created using the [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) annotation, slice tests will not be able to include/exclude them from the application context. Consider this example: ```java import com.zaxxer.hikari.HikariDataSource; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.jdbc.DataSourceBuilder; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.web.SecurityFilterChain; @Configuration(proxyBeanMethods = false) public class MyConfiguration { @Bean public SecurityFilterChain securityFilterChain(HttpSecurity http) { http.authorizeHttpRequests((requests) -> requests.anyRequest().authenticated()); return http.build(); } @Bean @ConfigurationProperties("app.datasource.second") public HikariDataSource secondDataSource() { return DataSourceBuilder.create().type(HikariDataSource.class).build(); } } ``` For a [`@WebMvcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/test/autoconfigure/WebMvcTest.html) for an application with the above [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class, you might expect to have the [`SecurityFilterChain`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/SecurityFilterChain.html) bean in the application context so that you can test if your controller endpoints are secured properly. However, `MyConfiguration` is not picked up by @WebMvcTest’s component scanning filter because it doesn’t match any of the types specified by the filter. You can include the configuration explicitly by annotating the test class with `@Import(MyConfiguration.class)`. This will load all the beans in `MyConfiguration` including the [`HikariDataSource`](https://javadoc.io/doc/com.zaxxer/HikariCP/7.0.2/com.zaxxer.hikari/com/zaxxer/hikari/HikariDataSource.html) bean which isn’t required when testing the web tier. Splitting the configuration class into two will enable importing just the security configuration. ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.web.SecurityFilterChain; @Configuration(proxyBeanMethods = false) public class MySecurityConfiguration { @Bean public SecurityFilterChain securityFilterChain(HttpSecurity http) { http.authorizeHttpRequests((requests) -> requests.anyRequest().authenticated()); return http.build(); } } ``` ```java import com.zaxxer.hikari.HikariDataSource; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.jdbc.DataSourceBuilder; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyDatasourceConfiguration { @Bean @ConfigurationProperties("app.datasource.second") public HikariDataSource secondDataSource() { return DataSourceBuilder.create().type(HikariDataSource.class).build(); } } ``` Having a single configuration class can be inefficient when beans from a certain domain need to be included in slice tests. Instead, structuring the application’s configuration as multiple granular classes with beans for a specific domain can enable importing them only for specific slice tests. * [Spring Boot](../index.html) * [4.1.1](testing.html) * [4.0.8](../4.0/how-to/testing.html) * [3.5.16](../3.5/how-to/testing.html) * [3.4.13](../3.4/how-to/testing.html) * [3.3.13](../3.3/how-to/testing.html) - [4.2.0-M2](../4.2/how-to/testing.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/testing.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/testing.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/testing.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/class-use/DockerSpec.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.bundling.DockerSpec ========================================================= Packages that use [DockerSpec](../DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Package Description [org.springframework.boot.gradle.tasks.bundling](#org.springframework.boot.gradle.tasks.bundling) Support for creating executable jars and wars. * ## Uses of [DockerSpec](../DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) Methods in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) that return [DockerSpec](../DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Modifier and Type Method Description `DockerSpec` BootBuildImage.`getDocker()` Returns the Docker configuration the builder will use. Method parameters in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) with type arguments of type [DockerSpec](../DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Modifier and Type Method Description `void` BootBuildImage.`docker(Action action)` Configures the Docker connection using the given `action`. ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/dsl/class-use/SpringBootExtension.html ---- Uses of Class\ org.springframework.boot.gradle.dsl.SpringBootExtension ======================================================= No usage of org.springframework.boot.gradle.dsl.SpringBootExtension ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/ProcessAotMojo.html ---- Uses of Class\ org.springframework.boot.maven.ProcessAotMojo ============================================= No usage of org.springframework.boot.maven.ProcessAotMojo ---- url: https://docs.spring.io/spring-boot/reference/using/index.html ---- # Developing with Spring Boot This section goes into more detail about how you should use Spring Boot. It covers topics such as build systems, auto-configuration, and how to run your applications. We also cover some Spring Boot best practices. Although there is nothing particularly special about Spring Boot (it is just another library that you can consume), there are a few recommendations that, when followed, make your development process a little easier. If you are starting out with Spring Boot, you should probably read the [Developing Your First Spring Boot Application](../../tutorial/first-application/index.html) tutorial before diving into this section. * [Spring Boot](../../index.html) * [4.1.1](index.html) * [4.0.8](../../4.0/reference/using/index.html) * [3.5.16](../../3.5/reference/using/index.html) * [3.4.13](../../3.4/reference/using/index.html) * [3.3.13](../../3.3/reference/using/index.html) - [4.2.0-M2](../../4.2/reference/using/index.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/using/index.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/using/index.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/using/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/how-to/webserver.html ---- # Embedded Web Servers Each Spring Boot web application includes an embedded web server. This feature leads to a number of how-to questions, including how to change the embedded server and how to configure the embedded server. This section answers those questions. ## [](#howto.webserver.use-another)Use Another Web Server Many Spring Boot starters include default embedded containers. * For servlet stack applications, the `spring-boot-starter-web` includes Tomcat by including `spring-boot-starter-tomcat`, but you can use `spring-boot-starter-jetty` instead. * For reactive stack applications, the `spring-boot-starter-webflux` includes Reactor Netty by including `spring-boot-starter-reactor-netty`, but you can use `spring-boot-starter-tomcat` or `spring-boot-starter-jetty` instead. When switching to a different HTTP server, you need to swap the default dependencies for those that you need instead. To help with this process, Spring Boot provides a separate starter for each of the supported HTTP servers. The following example shows how to exclude Tomcat and include Jetty for Spring MVC: * Maven * Gradle ```xml org.springframework.boot spring-boot-starter-webmvc org.springframework.boot spring-boot-starter-tomcat org.springframework.boot spring-boot-starter-jetty ``` ```gradle dependencies { implementation('org.springframework.boot:spring-boot-starter-webmvc') { // Exclude the Tomcat dependency exclude group: 'org.springframework.boot', module: 'spring-boot-starter-tomcat' } // Use Jetty instead implementation "org.springframework.boot:spring-boot-starter-jetty" } ``` If you are creating a war file, you can use a similar approach, but you must indicate provided dependencies: * Maven * Gradle ```xml org.springframework.boot spring-boot-starter-webmvc org.springframework.boot spring-boot-starter-tomcat org.springframework.boot spring-boot-starter-jetty provided ``` ```gradle dependencies { implementation('org.springframework.boot:spring-boot-starter-webmvc') { // Exclude the Tomcat dependency exclude group: 'org.springframework.boot', module: 'spring-boot-starter-tomcat' } // Use Jetty instead implementation "org.springframework.boot:spring-boot-starter-jetty" providedRuntime "org.springframework.boot:spring-boot-starter-jetty-runtime" } ``` ## [](#howto.webserver.disable)Disabling the Web Server If your classpath contains the necessary bits to start a web server, Spring Boot will automatically start it. To disable this behavior configure the [`WebApplicationType`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/WebApplicationType.html) in your `application.properties`, as shown in the following example: * Properties * YAML ```properties spring.main.web-application-type=none ``` ```yaml spring: main: web-application-type: "none" ``` ## [](#howto.webserver.change-port)Change the HTTP Port In a standalone application, the main HTTP port defaults to `8080` but can be set with `server.port` (for example, in `application.properties` or as a System property). Thanks to relaxed binding of [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) values, you can also use `SERVER_PORT` (for example, as an OS environment variable). To switch off the HTTP endpoints completely but still create a [`WebApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/context/WebApplicationContext.html), use `server.port=-1` (doing so is sometimes useful for testing). For more details, see [Customizing Embedded Servlet Containers](../reference/web/servlet.html#web.servlet.embedded-container.customizing) in the ‘Spring Boot Features’ section, or the [`ServerProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/autoconfigure/ServerProperties.html) class. ## [](#howto.webserver.use-random-port)Use a Random Unassigned HTTP Port To scan for a free port (using OS natives to prevent clashes) use `server.port=0`. ## [](#howto.webserver.discover-port)Discover the HTTP Port at Runtime You can access the port the server is running on from log output or from the [`WebServerApplicationContext`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/context/WebServerApplicationContext.html) through its [`WebServer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/WebServer.html). The best way to get that and be sure it has been initialized is to add a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) of type `ApplicationListener` and pull the container out of the event when it is published. Tests that use `@SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT)` can also inject the actual port into a field by using the [`@LocalServerPort`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/web/server/LocalServerPort.html) annotation, as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest.WebEnvironment; import org.springframework.boot.test.web.server.LocalServerPort; @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) class MyWebIntegrationTests { @LocalServerPort int port; // ... } ``` ```kotlin import org.springframework.boot.test.context.SpringBootTest import org.springframework.boot.test.context.SpringBootTest.WebEnvironment import org.springframework.boot.test.web.server.LocalServerPort @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) class MyWebIntegrationTests { @LocalServerPort var port = 0 // ... } ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | [`@LocalServerPort`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/web/server/LocalServerPort.html) is a meta-annotation for `@Value("${local.server.port}")`. Do not try to inject the port in a regular application. As we just saw, the value is set only after the container has been initialized. Contrary to a test, application code callbacks are processed early (before the value is actually available). | ## [](#howto.webserver.build-uri-test-web-server)Build URI Against the Test Web Server Tests that start a [`WebServer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/WebServer.html) such as `@SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT)` can get information about the running server using [`LocalTestWebServer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/http/server/LocalTestWebServer.html), as shown in the following example: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest.WebEnvironment; import org.springframework.boot.test.http.server.LocalTestWebServer; import org.springframework.context.ApplicationContext; @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) class MyWebIntegrationTests { @Autowired ApplicationContext context; // ... @Test void test() { String urlToTest = LocalTestWebServer.obtain(this.context).uri("/test"); } } ``` ```kotlin import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.test.context.SpringBootTest import org.springframework.boot.test.context.SpringBootTest.WebEnvironment import org.springframework.boot.test.http.server.LocalTestWebServer import org.springframework.context.ApplicationContext @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) class MyWebIntegrationTests(@Autowired val context: ApplicationContext) { // ... @Test fun test() { val urlToTest = LocalTestWebServer.obtain(this.context).uri("/test") } } ``` [`LocalTestWebServer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/http/server/LocalTestWebServer.html) provides access to a suitable [`UriBuilderFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/util/UriBuilderFactory.html). It can also be customized to build such an instance on a sub-path of your application. ## [](#howto.webserver.enable-response-compression)Enable HTTP Response Compression HTTP response compression is supported by Jetty, Tomcat and Reactor Netty. It can be enabled in `application.properties`, as follows: * Properties * YAML ```properties server.compression.enabled=true ``` ```yaml server: compression: enabled: true ``` By default, responses must be at least 2048 bytes in length for compression to be performed. You can configure this behavior by setting the `server.compression.min-response-size` property. By default, responses are compressed only if their content type is one of the following: * `text/html` * `text/xml` * `text/plain` * `text/css` * `text/javascript` * `application/javascript` * `application/json` * `application/xml` To configure the mime types that will be compressed, replacing the defaults, set the `server.compression.mime-types` property. To keep the defaults and configure additional mime types, set the `server.compression.additional-mime-types` property instead. ## [](#howto.webserver.configure-ssl)Configure SSL SSL can be configured declaratively by setting the various `server.ssl.*` properties, typically in `application.properties` or `application.yaml`. See [`Ssl`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/Ssl.html) for details of all of the supported properties. The following example shows setting SSL properties using a Java KeyStore file: * Properties * YAML ```properties server.port=8443 server.ssl.key-store=classpath:keystore.jks server.ssl.key-store-password=secret server.ssl.key-password=another-secret ``` ```yaml server: port: 8443 ssl: key-store: "classpath:keystore.jks" key-store-password: "secret" key-password: "another-secret" ``` Using configuration such as the preceding example means the application no longer supports a plain HTTP connector at port 8080. Spring Boot does not support the configuration of both an HTTP connector and an HTTPS connector through `application.properties`. If you want to have both, you need to configure one of them programmatically. We recommend using `application.properties` to configure HTTPS, as the HTTP connector is the easier of the two to configure programmatically. ### [](#howto.webserver.configure-ssl.pem-files)Using PEM-encoded files You can use PEM-encoded files instead of Java KeyStore files. You should use PKCS#8 key files wherever possible. PEM-encoded PKCS#8 key files start with a `-----BEGIN PRIVATE KEY-----` or `-----BEGIN ENCRYPTED PRIVATE KEY-----` header. If you have files in other formats, e.g., PKCS#1 (`-----BEGIN RSA PRIVATE KEY-----`) or SEC 1 (`-----BEGIN EC PRIVATE KEY-----`), you can convert them to PKCS#8 using OpenSSL: ```shell openssl pkcs8 -topk8 -nocrypt -in -out ``` The following example shows setting SSL properties using PEM-encoded certificate and private key files: * Properties * YAML ```properties server.port=8443 server.ssl.certificate=classpath:my-cert.crt server.ssl.certificate-private-key=classpath:my-cert.key server.ssl.trust-certificate=classpath:ca-cert.crt ``` ```yaml server: port: 8443 ssl: certificate: "classpath:my-cert.crt" certificate-private-key: "classpath:my-cert.key" trust-certificate: "classpath:ca-cert.crt" ``` ### [](#howto.webserver.configure-ssl.bundles)Using SSL Bundles Alternatively, the SSL trust material can be configured in an [SSL bundle](../reference/features/ssl.html) and applied to the web server as shown in this example: * Properties * YAML ```properties server.port=8443 server.ssl.bundle=example ``` ```yaml server: port: 8443 ssl: bundle: "example" ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The `server.ssl.bundle` property can not be combined with the discrete Java KeyStore or PEM property options under `server.ssl`.The `server.ssl.ciphers`, `server.ssl.enabled-protocols`, `server.ssl.protocol` properties are also ignored when using a bundle. These properties should instead be defined using `spring.ssl.bundle...options` properties. | ### [](#howto.webserver.configure-ssl.sni)Configure Server Name Indication Tomcat, and Netty can be configured to use unique SSL trust material for individual host names to support Server Name Indication (SNI). SNI configuration is not supported with Jetty, but Jetty can [automatically set up SNI](https://eclipse.dev/jetty/documentation/jetty-12/operations-guide/index.html#og-protocols-ssl-sni) if multiple certificates are provided to it. Assuming [SSL bundles](../reference/features/ssl.html) named `web`, `web-alt1`, and `web-alt2` have been configured, the following configuration can be used to assign each bundle to a host name served by the embedded web server: * Properties * YAML ```properties server.port=8443 server.ssl.bundle=web server.ssl.server-name-bundles[0].server-name=alt1.example.com server.ssl.server-name-bundles[0].bundle=web-alt1 server.ssl.server-name-bundles[1].server-name=alt2.example.com server.ssl.server-name-bundles[1].bundle=web-alt2 ``` ```yaml server: port: 8443 ssl: bundle: "web" server-name-bundles: - server-name: "alt1.example.com" bundle: "web-alt1" - server-name: "alt2.example.com" bundle: "web-alt2" ``` The bundle specified with `server.ssl.bundle` will be used for the default host, and for any client that does support SNI. This default bundle must be configured if any `server.ssl.server-name-bundles` are configured. ## [](#howto.webserver.configure-http2)Configure HTTP/2 You can enable HTTP/2 support in your Spring Boot application with the `server.http2.enabled` configuration property. Both `h2` (HTTP/2 over TLS) and `h2c` (HTTP/2 over TCP) are supported. To use `h2`, SSL must also be enabled. When SSL is not enabled, `h2c` will be used. You may, for example, want to use `h2c` when your application is [running behind a proxy server](#howto.webserver.use-behind-a-proxy-server) that is performing TLS termination. ### [](#howto.webserver.configure-http2.tomcat)HTTP/2 With Tomcat Spring Boot ships by default with Tomcat 11.0.x which supports `h2c` and `h2` out of the box. Alternatively, you can use `libtcnative` for `h2` support if the library and its dependencies are installed on the host operating system. The library directory must be made available, if not already, to the JVM library path. You can do so with a JVM argument such as `-Djava.library.path=/usr/local/opt/tomcat-native/lib`. More on this in the [official Tomcat documentation](https://tomcat.apache.org/tomcat-11.0-doc/apr.html). ### [](#howto.webserver.configure-http2.jetty)HTTP/2 With Jetty For HTTP/2 support, Jetty requires the additional `org.eclipse.jetty.http2:jetty-http2-server` dependency. To use `h2c` no other dependencies are required. To use `h2`, you also need to choose one of the following dependencies, depending on your deployment: * `org.eclipse.jetty:jetty-alpn-java-server` to use the JDK built-in support * `org.eclipse.jetty:jetty-alpn-conscrypt-server` and the [Conscrypt library](https://www.conscrypt.org/) ### [](#howto.webserver.configure-http2.netty)HTTP/2 With Reactor Netty The `spring-boot-webflux-starter` is using by default Reactor Netty as a server. Reactor Netty supports `h2c` and `h2` out of the box. For optimal runtime performance, this server also supports `h2` with native libraries. To enable that, your application needs to have an additional dependency. Spring Boot manages the version for the `io.netty:netty-tcnative-boringssl-static` "uber jar", containing native libraries for all platforms. Developers can choose to import only the required dependencies using a classifier (see [the Netty official documentation](https://netty.io/wiki/forked-tomcat-native.html)). ## [](#howto.webserver.configure)Configure the Web Server Generally, you should first consider using one of the many available configuration keys and customize your web server by adding new entries in your `application.properties` or `application.yaml` file. See [Discover Built-in Options for External Properties](properties-and-configuration.html#howto.properties-and-configuration.discover-build-in-options-for-external-properties)). The `server.*` namespace is quite useful here, and it includes namespaces like `server.tomcat.*`, `server.jetty.*` and others, for server-specific features. See the list of [Common Application Properties](../appendix/application-properties/index.html). The previous sections covered already many common use cases, such as compression, SSL or HTTP/2. However, if a configuration key does not exist for your use case, you should then look at [`WebServerFactoryCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/WebServerFactoryCustomizer.html). You can declare such a component and get access to the server factory relevant to your choice: you should select the variant for the chosen Server (Tomcat, Jetty, Reactor Netty) and the chosen web stack (servlet or reactive). The example below is for Tomcat with the `spring-boot-starter-web` (servlet stack): * Java * Kotlin ```java import org.springframework.boot.tomcat.servlet.TomcatServletWebServerFactory; import org.springframework.boot.web.server.WebServerFactoryCustomizer; import org.springframework.stereotype.Component; @Component public class MyTomcatWebServerCustomizer implements WebServerFactoryCustomizer { @Override public void customize(TomcatServletWebServerFactory factory) { // customize the factory here } } ``` ```kotlin import org.springframework.boot.tomcat.servlet.TomcatServletWebServerFactory import org.springframework.boot.web.server.WebServerFactoryCustomizer import org.springframework.stereotype.Component @Component class MyTomcatWebServerCustomizer : WebServerFactoryCustomizer { override fun customize(factory: TomcatServletWebServerFactory) { // customize the factory here } } ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Spring Boot uses that infrastructure internally to auto-configure the server. Auto-configured [`WebServerFactoryCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/WebServerFactoryCustomizer.html) beans have an order of `0` and will be processed before any user-defined customizers, unless it has an explicit order that states otherwise. | Once you have got access to a [`WebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/WebServerFactory.html) using the customizer, you can use it to configure specific parts, like connectors, server resources, or the server itself - all using server-specific APIs. In addition Spring Boot provides: | Server | Servlet stack | Reactive stack | | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Tomcat | [`TomcatServletWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/tomcat/servlet/TomcatServletWebServerFactory.html) | [`TomcatReactiveWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/tomcat/reactive/TomcatReactiveWebServerFactory.html) | | Jetty | [`JettyServletWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jetty/servlet/JettyServletWebServerFactory.html) | [`JettyReactiveWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jetty/reactive/JettyReactiveWebServerFactory.html) | | Reactor | N/A | [`NettyReactiveWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/reactor/netty/NettyReactiveWebServerFactory.html) | As a last resort, you can also declare your own [`WebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/WebServerFactory.html) bean, which will override the one provided by Spring Boot. When you do so, auto-configured customizers are still applied on your custom factory, so use that option carefully. ## [](#howto.webserver.add-servlet-filter-listener)Add a Servlet, Filter, or Listener to an Application In a servlet stack application, that is with the `spring-boot-starter-web`, there are two ways to add [`Servlet`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Servlet.html), [`Filter`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Filter.html), [`ServletContextListener`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/ServletContextListener.html), and the other listeners supported by the Servlet API to your application: * [Add a Servlet, Filter, or Listener by Using a Spring Bean](#howto.webserver.add-servlet-filter-listener.spring-bean) * [Add Servlets, Filters, and Listeners by Using Classpath Scanning](#howto.webserver.add-servlet-filter-listener.using-scanning) ### [](#howto.webserver.add-servlet-filter-listener.spring-bean)Add a Servlet, Filter, or Listener by Using a Spring Bean To add a [`Servlet`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Servlet.html), [`Filter`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Filter.html), or servlet `*Listener` by using a Spring bean, you must provide a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) definition for it. Doing so can be very useful when you want to inject configuration or dependencies. However, you must be very careful that they do not cause eager initialization of too many other beans, because they have to be installed in the container very early in the application lifecycle. (For example, it is not a good idea to have them depend on your [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) or JPA configuration.) You can work around such restrictions by initializing the beans lazily when first used instead of on initialization. In the case of filters and servlets, you can also add mappings and init parameters by adding a [`FilterRegistrationBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/FilterRegistrationBean.html) or a [`ServletRegistrationBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/ServletRegistrationBean.html) instead of or in addition to the underlying component. You can also use [`@ServletRegistration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/ServletRegistration.html) and [`@FilterRegistration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/FilterRegistration.html) as an annotation-based alternative to [`ServletRegistrationBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/ServletRegistrationBean.html) and [`FilterRegistrationBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/FilterRegistrationBean.html). | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | If no `dispatcherType` is specified on a filter registration, `REQUEST` is used. This aligns with the servlet specification’s default dispatcher type. | Like any other Spring bean, you can define the order of servlet filter beans; please make sure to check the [Registering Servlets, Filters, and Listeners as Spring Beans](../reference/web/servlet.html#web.servlet.embedded-container.servlets-filters-listeners.beans) section. #### [](#howto.webserver.add-servlet-filter-listener.spring-bean.disable)Disable Registration of a Servlet or Filter As [described earlier](#howto.webserver.add-servlet-filter-listener.spring-bean), any [`Servlet`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Servlet.html) or [`Filter`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Filter.html) beans are registered with the servlet container automatically. To disable registration of a particular [`Filter`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Filter.html) or [`Servlet`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Servlet.html) bean, create a registration bean for it and mark it as disabled, as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.web.servlet.FilterRegistrationBean; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyFilterConfiguration { @Bean public FilterRegistrationBean registration(MyFilter filter) { FilterRegistrationBean registration = new FilterRegistrationBean<>(filter); registration.setEnabled(false); return registration; } } ``` ```kotlin import org.springframework.boot.web.servlet.FilterRegistrationBean import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyFilterConfiguration { @Bean fun registration(filter: MyFilter): FilterRegistrationBean { val registration = FilterRegistrationBean(filter) registration.isEnabled = false return registration } } ``` ### [](#howto.webserver.add-servlet-filter-listener.using-scanning)Add Servlets, Filters, and Listeners by Using Classpath Scanning [`@WebServlet`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/annotation/WebServlet.html), [`@WebFilter`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/annotation/WebFilter.html), and [`@WebListener`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/annotation/WebListener.html) annotated classes can be automatically registered with an embedded servlet container by annotating a [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class with [`@ServletComponentScan`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/servlet/context/ServletComponentScan.html) and specifying the package(s) containing the components that you want to register. By default, [`@ServletComponentScan`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/servlet/context/ServletComponentScan.html) scans from the package of the annotated class. ## [](#howto.webserver.configure-access-logs)Configure Access Logging Access logs can be configured for Tomcat and Jetty through their respective namespaces. For instance, the following settings log access on Tomcat with a [custom pattern](https://tomcat.apache.org/tomcat-11.0-doc/config/valve.html#Access_Logging). * Properties * YAML ```properties server.tomcat.basedir=my-tomcat server.tomcat.accesslog.enabled=true server.tomcat.accesslog.pattern=%t %a %r %s (%D microseconds) ``` ```yaml server: tomcat: basedir: "my-tomcat" accesslog: enabled: true pattern: "%t %a %r %s (%D microseconds)" ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The default location for logs is a `logs` directory relative to the Tomcat base directory. By default, the `logs` directory is a temporary directory, so you may want to fix Tomcat’s base directory or use an absolute path for the logs. In the preceding example, the logs are available in `my-tomcat/logs` relative to the working directory of the application. | Finally, access logging for Jetty can also be configured as follows: * Properties * YAML ```properties server.jetty.accesslog.enabled=true server.jetty.accesslog.filename=/var/log/jetty-access.log ``` ```yaml server: jetty: accesslog: enabled: true filename: "/var/log/jetty-access.log" ``` By default, logs are redirected to [`System.err`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/System.html#err). For more details, see the Jetty documentation. ## [](#howto.webserver.use-behind-a-proxy-server)Running Behind a Front-end Proxy Server If your application is running behind a proxy, a load-balancer or in the cloud, the request information (like the host, port, scheme…​) might change along the way. Your application may be running on `10.10.10.10:8080`, but HTTP clients should only see `example.org`. [RFC7239 "Forwarded Headers"](https://tools.ietf.org/html/rfc7239) defines the `Forwarded` HTTP header; proxies can use this header to provide information about the original request. You can configure your application to read those headers and automatically use that information when creating links and sending them to clients in HTTP 302 responses, JSON documents or HTML pages. There are also non-standard headers, like `X-Forwarded-Host`, `X-Forwarded-Port`, `X-Forwarded-Proto`, `X-Forwarded-Ssl`, and `X-Forwarded-Prefix`. If the proxy adds the commonly used `X-Forwarded-For` and `X-Forwarded-Proto` headers, setting `server.forward-headers-strategy` to `NATIVE` is enough to support those. With this option, the Web servers themselves natively support this feature; you can check their specific documentation to learn about specific behavior. If this is not enough, Spring Framework provides a [ForwardedHeaderFilter](https://docs.spring.io/spring-framework/reference/7.0/web/webmvc/filters.html#filters-forwarded-headers) for the servlet stack and a [ForwardedHeaderTransformer](https://docs.spring.io/spring-framework/reference/7.0/web/webflux/reactive-spring.html#webflux-forwarded-headers) for the reactive stack. You can use them in your application by setting `server.forward-headers-strategy` to `FRAMEWORK`. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you are using Tomcat and terminating SSL at the proxy, `server.tomcat.redirect-context-root` should be set to `false`. This allows the `X-Forwarded-Proto` header to be honored before any redirects are performed. | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If your application runs [in a supported Cloud Platform](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/cloud/CloudPlatform.html#enum-constant-summary), the `server.forward-headers-strategy` property defaults to `NATIVE`. In all other instances, it defaults to `NONE`. | ### [](#howto.webserver.use-behind-a-proxy-server.tomcat)Customize Tomcat’s Proxy Configuration If you use Tomcat, you can additionally configure the names of the headers used to carry “forwarded” information, as shown in the following example: * Properties * YAML ```properties server.tomcat.remoteip.remote-ip-header=x-your-remote-ip-header server.tomcat.remoteip.protocol-header=x-your-protocol-header ``` ```yaml server: tomcat: remoteip: remote-ip-header: "x-your-remote-ip-header" protocol-header: "x-your-protocol-header" ``` Tomcat is also configured with a regular expression that matches internal proxies that are to be trusted. See the [`server.tomcat.remoteip.internal-proxies` entry in the appendix](../appendix/application-properties/index.html#application-properties.server.server.tomcat.remoteip.internal-proxies) for its default value. You can customize the valve’s configuration by adding an entry to `application.properties`, as shown in the following example: * Properties * YAML ```properties server.tomcat.remoteip.internal-proxies=192\.168\.\d{1,3}\.\d{1,3} ``` ```yaml server: tomcat: remoteip: internal-proxies: "192\\.168\\.\\d{1,3}\\.\\d{1,3}" ``` | | | | -- | ------------------------------------------------------------------------------------------------------ | | ** | You can trust all proxies by setting the `internal-proxies` to empty (but do not do so in production). | You can take complete control of the configuration of Tomcat’s [`RemoteIpValve`](https://tomcat.apache.org/tomcat-11.0-doc/api/org/apache/catalina/valves/RemoteIpValve.html) by switching the automatic one off (to do so, set `server.forward-headers-strategy=NONE`) and adding a new valve instance using a [`WebServerFactoryCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/WebServerFactoryCustomizer.html) bean. ## [](#howto.webserver.enable-multiple-connectors)Enable Multiple Connectors ### [](#howto.webserver.enable-multiple-connectors.tomcat)Multiple Connectors with Tomcat You can add an [`Connector`](https://tomcat.apache.org/tomcat-11.0-doc/api/org/apache/catalina/connector/Connector.html) to the [`TomcatServletWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/tomcat/servlet/TomcatServletWebServerFactory.html), which can allow multiple connectors, including HTTP and HTTPS connectors, as shown in the following example: * Java * Kotlin ```java import org.apache.catalina.connector.Connector; import org.springframework.boot.tomcat.servlet.TomcatServletWebServerFactory; import org.springframework.boot.web.server.WebServerFactoryCustomizer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyTomcatConfiguration { @Bean public WebServerFactoryCustomizer connectorCustomizer() { return (tomcat) -> tomcat.addAdditionalConnectors(createConnector()); } private Connector createConnector() { Connector connector = new Connector("org.apache.coyote.http11.Http11NioProtocol"); connector.setPort(8081); return connector; } } ``` ```kotlin import org.apache.catalina.connector.Connector import org.springframework.boot.web.server.WebServerFactoryCustomizer import org.springframework.boot.tomcat.servlet.TomcatServletWebServerFactory import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyTomcatConfiguration { @Bean fun connectorCustomizer(): WebServerFactoryCustomizer { return WebServerFactoryCustomizer { tomcat: TomcatServletWebServerFactory -> tomcat.addAdditionalConnectors(createConnector()) } } private fun createConnector(): Connector { val connector = Connector("org.apache.coyote.http11.Http11NioProtocol") connector.port = 8081 return connector } } ``` ### [](#howto.webserver.enable-multiple-connectors.jetty)Multiple Connectors with Jetty You can register additional Jetty [`Connector`](https://javadoc.jetty.org/jetty-12/org/eclipse/jetty/server/Connector.html) instances by adding a [`JettyServerCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jetty/JettyServerCustomizer.html) on the [`ConfigurableJettyWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jetty/ConfigurableJettyWebServerFactory.html), as shown in the following example: * Java * Kotlin ```java import org.eclipse.jetty.server.ServerConnector; import org.springframework.boot.jetty.ConfigurableJettyWebServerFactory; import org.springframework.boot.web.server.WebServerFactoryCustomizer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyJettyConfiguration { @Bean public WebServerFactoryCustomizer connectorCustomizer() { return (jetty) -> jetty.addServerCustomizers((server) -> { ServerConnector connector = new ServerConnector(server); connector.setPort(8081); server.addConnector(connector); }); } } ``` ```kotlin import org.eclipse.jetty.server.Server import org.eclipse.jetty.server.ServerConnector import org.springframework.boot.jetty.ConfigurableJettyWebServerFactory import org.springframework.boot.jetty.JettyServerCustomizer import org.springframework.boot.web.server.WebServerFactoryCustomizer import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyJettyConfiguration { @Bean fun connectorCustomizer(): WebServerFactoryCustomizer { return WebServerFactoryCustomizer { jetty: ConfigurableJettyWebServerFactory -> jetty.addServerCustomizers(JettyServerCustomizer { server: Server -> val connector = ServerConnector(server) connector.setPort(8081) server.addConnector(connector) }) } } } ``` ## [](#howto.webserver.enable-tomcat-mbean-registry)Enable Tomcat’s MBean Registry Embedded Tomcat’s MBean registry is disabled by default. This minimizes Tomcat’s memory footprint. If you want to use Tomcat’s MBeans, for example so that they can be used by Micrometer to expose metrics, you must use the `server.tomcat.mbeanregistry.enabled` property to do so, as shown in the following example: * Properties * YAML ```properties server.tomcat.mbeanregistry.enabled=true ``` ```yaml server: tomcat: mbeanregistry: enabled: true ``` ## [](#howto.webserver.create-websocket-endpoints-using-serverendpoint)Create WebSocket Endpoints Using @ServerEndpoint If you want to use [`@ServerEndpoint`](https://jakarta.ee/specifications/websocket/2.2/apidocs/server/jakarta/websocket/server/ServerEndpoint.html) in a Spring Boot application that used an embedded container, you must declare a single [`ServerEndpointExporter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/socket/server/standard/ServerEndpointExporter.html) [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html), as shown in the following example: * Java * Kotlin ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.web.socket.server.standard.ServerEndpointExporter; @Configuration(proxyBeanMethods = false) public class MyWebSocketConfiguration { @Bean public ServerEndpointExporter serverEndpointExporter() { return new ServerEndpointExporter(); } } ``` ```kotlin import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.web.socket.server.standard.ServerEndpointExporter @Configuration(proxyBeanMethods = false) class MyWebSocketConfiguration { @Bean fun serverEndpointExporter(): ServerEndpointExporter { return ServerEndpointExporter() } } ``` The bean shown in the preceding example registers any [`@ServerEndpoint`](https://jakarta.ee/specifications/websocket/2.2/apidocs/server/jakarta/websocket/server/ServerEndpoint.html) annotated beans with the underlying WebSocket container. When deployed to a standalone servlet container, this role is performed by a servlet container initializer, and the [`ServerEndpointExporter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/socket/server/standard/ServerEndpointExporter.html) bean is not required. * [Spring Boot](../index.html) * [4.1.1](webserver.html) * [4.0.8](../4.0/how-to/webserver.html) * [3.5.16](../3.5/how-to/webserver.html) * [3.4.13](../3.4/how-to/webserver.html) * [3.3.13](../3.3/how-to/webserver.html) - [4.2.0-M2](../4.2/how-to/webserver.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/webserver.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/webserver.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/webserver.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/features/internationalization.html ---- # Internationalization Spring Boot supports localized messages so that your application can cater to users of different language preferences. By default, Spring Boot looks for the presence of a `messages` resource bundle at the root of the classpath. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The auto-configuration applies when the default properties file for the configured resource bundle is available (`messages.properties` by default). If your resource bundle contains only language-specific properties files, you are required to add the default. If no properties file is found that matches any of the configured base names, there will be no auto-configured [`MessageSource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/MessageSource.html). | The basename of the resource bundle as well as several other attributes can be configured using the `spring.messages` namespace, as shown in the following example: * Properties * YAML ```properties spring.messages.basename=messages, config.i18n.messages spring.messages.common-messages=classpath:my-common-messages.properties spring.messages.fallback-to-system-locale=false ``` ```yaml spring: messages: basename: "messages, config.i18n.messages" common-messages: "classpath:my-common-messages.properties" fallback-to-system-locale: false ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The `spring.messages.basename` property supports a list of locations, either a package qualifier or a resource resolved from the classpath root. The `spring.messages.common-messages` property supports a list of property file resources. | See [`MessageSourceProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/context/MessageSourceProperties.html) for more supported options. * [Spring Boot](../../index.html) * [4.1.1](internationalization.html) * [4.0.8](../../4.0/reference/features/internationalization.html) * [3.5.16](../../3.5/reference/features/internationalization.html) * [3.4.13](../../3.4/reference/features/internationalization.html) * [3.3.13](../../3.3/reference/features/internationalization.html) - [4.2.0-M2](../../4.2/reference/features/internationalization.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/features/internationalization.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/features/internationalization.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/features/internationalization.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/actuator/http-exchanges.html ---- # Recording HTTP Exchanges You can enable recording of HTTP exchanges by providing a bean of type [`HttpExchangeRepository`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/web/exchanges/HttpExchangeRepository.html) in your application’s configuration. For convenience, Spring Boot offers [`InMemoryHttpExchangeRepository`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/web/exchanges/InMemoryHttpExchangeRepository.html), which, by default, stores the last 100 request-response exchanges. [`InMemoryHttpExchangeRepository`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/web/exchanges/InMemoryHttpExchangeRepository.html) is limited compared to tracing solutions, and we recommend using it only for development environments. For production environments, we recommend using a production-ready tracing or observability solution, such as Zipkin or OpenTelemetry. Alternatively, you can create your own [`HttpExchangeRepository`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/web/exchanges/HttpExchangeRepository.html). You can use the `httpexchanges` endpoint to obtain information about the request-response exchanges that are stored in the [`HttpExchangeRepository`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/web/exchanges/HttpExchangeRepository.html). ## [](#actuator.http-exchanges.custom)Custom HTTP Exchange Recording To customize the items that are included in each recorded exchange, use the `management.httpexchanges.recording.include` configuration property. To disable recording entirely, set `management.httpexchanges.recording.enabled` to `false`. * [Spring Boot](../../index.html) * [4.1.1](http-exchanges.html) * [4.0.8](../../4.0/reference/actuator/http-exchanges.html) * [3.5.16](../../3.5/reference/actuator/http-exchanges.html) * [3.4.13](../../3.4/reference/actuator/http-exchanges.html) * [3.3.13](../../3.3/reference/actuator/http-exchanges.html) - [4.2.0-M2](../../4.2/reference/actuator/http-exchanges.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/actuator/http-exchanges.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/actuator/http-exchanges.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/actuator/http-exchanges.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-9.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## I * [Image](../org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Image configuration options. * [Image()](../org/springframework/boot/maven/Image.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.maven.[Image](../org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven")   * [Include](../org/springframework/boot/maven/Include.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) A model for a dependency to include. * [Include()](../org/springframework/boot/maven/Include.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.maven.[Include](../org/springframework/boot/maven/Include.html "class in org.springframework.boot.maven")   * [IncludeFilter](../org/springframework/boot/maven/IncludeFilter.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) An `ArtifactsFilter` that filters out any artifact not matching an [`Include`](../org/springframework/boot/maven/Include.html "class in org.springframework.boot.maven"). * [IncludeFilter(List)](../org/springframework/boot/maven/IncludeFilter.html#%3Cinit%3E\(java.util.List\)) - Constructor for class org.springframework.boot.maven.[IncludeFilter](../org/springframework/boot/maven/IncludeFilter.html "class in org.springframework.boot.maven")   * [includeOptional](../org/springframework/boot/maven/AbstractPackagerMojo.html#includeOptional) - Variable in class org.springframework.boot.maven.[AbstractPackagerMojo](../org/springframework/boot/maven/AbstractPackagerMojo.html "class in org.springframework.boot.maven") Include optional dependencies. * [includeSystemScope](../org/springframework/boot/maven/AbstractPackagerMojo.html#includeSystemScope) - Variable in class org.springframework.boot.maven.[AbstractPackagerMojo](../org/springframework/boot/maven/AbstractPackagerMojo.html "class in org.springframework.boot.maven") Include system scoped dependencies. * [includeTools](../org/springframework/boot/maven/AbstractPackagerMojo.html#includeTools) - Variable in class org.springframework.boot.maven.[AbstractPackagerMojo](../org/springframework/boot/maven/AbstractPackagerMojo.html "class in org.springframework.boot.maven") Include JAR tools. * [isBindHostToBuilder()](../org/springframework/boot/maven/Docker.html#isBindHostToBuilder\(\)) - Method in class org.springframework.boot.maven.[Docker](../org/springframework/boot/maven/Docker.html "class in org.springframework.boot.maven") Whether to use the configured Docker host in the builder container. * [isEnabled()](../org/springframework/boot/maven/Layers.html#isEnabled\(\)) - Method in class org.springframework.boot.maven.[Layers](../org/springframework/boot/maven/Layers.html "class in org.springframework.boot.maven") Whether a `layers.idx` file should be added to the jar. * [isTlsVerify()](../org/springframework/boot/maven/Docker.html#isTlsVerify\(\)) - Method in class org.springframework.boot.maven.[Docker](../org/springframework/boot/maven/Docker.html "class in org.springframework.boot.maven") Whether the Docker daemon requires TLS communication. * [isUseTestClasspath()](../org/springframework/boot/maven/AbstractRunMojo.html#isUseTestClasspath\(\)) - Method in class org.springframework.boot.maven.[AbstractRunMojo](../org/springframework/boot/maven/AbstractRunMojo.html "class in org.springframework.boot.maven")   * [isUseTestClasspath()](../org/springframework/boot/maven/RunMojo.html#isUseTestClasspath\(\)) - Method in class org.springframework.boot.maven.[RunMojo](../org/springframework/boot/maven/RunMojo.html "class in org.springframework.boot.maven")   * [isUseTestClasspath()](../org/springframework/boot/maven/StartMojo.html#isUseTestClasspath\(\)) - Method in class org.springframework.boot.maven.[StartMojo](../org/springframework/boot/maven/StartMojo.html "class in org.springframework.boot.maven")   * [isUseTestClasspath()](../org/springframework/boot/maven/TestRunMojo.html#isUseTestClasspath\(\)) - Method in class org.springframework.boot.maven.[TestRunMojo](../org/springframework/boot/maven/TestRunMojo.html "class in org.springframework.boot.maven")   * [isVerboseLogging()](../org/springframework/boot/maven/Image.html#isVerboseLogging\(\)) - Method in class org.springframework.boot.maven.[Image](../org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven") If verbose logging is required. [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/serialized-form.html ---- # Serialized Form * ## Package [org.springframework.boot.gradle.tasks.buildinfo](org/springframework/boot/gradle/tasks/buildinfo/package-summary.html) * ### Class [org.springframework.boot.gradle.tasks.buildinfo.BuildInfoProperties](org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") class BuildInfoProperties extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") implements [Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io") * #### Serialized Fields * ##### creationTime ``` Supplier<@Nullable String> creationTime ``` * ##### excludes ``` SetProperty excludes ``` * ## Package [org.springframework.boot.gradle.tasks.bundling](org/springframework/boot/gradle/tasks/bundling/package-summary.html) * ### Class [org.springframework.boot.gradle.tasks.bundling.LayeredSpec.ApplicationSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") class ApplicationSpec extends [LayeredSpec.IntoLayersSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling")<[LayeredSpec.IntoLayerSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling")> implements [Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io") * ### Class [org.springframework.boot.gradle.tasks.bundling.LayeredSpec.DependenciesIntoLayerSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesIntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") class DependenciesIntoLayerSpec extends [LayeredSpec.IntoLayerSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") implements [Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io") * #### Serialized Fields * ##### excludeProjectDependencies ``` boolean excludeProjectDependencies ``` * ##### includeProjectDependencies ``` boolean includeProjectDependencies ``` * ### Class [org.springframework.boot.gradle.tasks.bundling.LayeredSpec.DependenciesSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") class DependenciesSpec extends [LayeredSpec.IntoLayersSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling")<[LayeredSpec.DependenciesIntoLayerSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesIntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling")> implements [Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io") * ### Class [org.springframework.boot.gradle.tasks.bundling.LayeredSpec.IntoLayerSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") class IntoLayerSpec extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") implements [Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io") * #### Serialized Fields * ##### excludes ``` List excludes ``` * ##### includes ``` List includes ``` * ##### intoLayer ``` String intoLayer ``` * ### Class [org.springframework.boot.gradle.tasks.bundling.LayeredSpec.IntoLayersSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") class IntoLayersSpec extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") implements [Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io") * #### Serialized Fields * ##### intoLayers ``` List intoLayers ``` * ##### specFactory ``` Function specFactory ``` ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/BootWar.html ---- # Class BootWar [org.gradle.api.tasks.bundling.War](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/War.html "class or interface in org.gradle.api.tasks.bundling") org.springframework.boot.gradle.tasks.bundling.BootWar * All Implemented Interfaces: `Comparable, ContentFilterable, CopyProcessingSpec, CopySourceSpec, CopySpec, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.file.copy.CopySpecSource, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Task, PatternFilterable, Configurable, BootArchive` *** [@DisableCachingByDefault](https://docs.gradle.org/9.7.0/javadoc/org/gradle/work/DisableCachingByDefault.html "class or interface in org.gradle.work")([because](https://docs.gradle.org/9.7.0/javadoc/org/gradle/work/DisableCachingByDefault.html#because\(\) "class or interface in org.gradle.work")="Not worth caching") public abstract class BootWar extends [War](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/War.html "class or interface in org.gradle.api.tasks.bundling") implements [BootArchive](BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") A custom [`War`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/War.html "class or interface in org.gradle.api.tasks.bundling") task that produces a Spring Boot executable war. * Since: 2.0.0 * Author: Andy Wilkinson, Phillip Webb, Scott Frederick - ## Nested Class Summary ### Nested classes/interfaces inherited from interface [Named](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Named.html#nested-class-summary "class or interface in org.gradle.api") `Named.Namer` - ## Field Summary ### Fields inherited from class [War](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/War.html#field-summary "class or interface in org.gradle.api.tasks.bundling") `WAR_EXTENSION` `BootWar()` Creates a new `BootWar` task. - ## Method Summary Modifier and Type Method Description `void` `copy()`   `protected org.gradle.api.internal.file.copy.CopyAction` `createCopyAction()`   `LayeredSpec` `getLayered()` Returns the spec that describes the layers in a layered jar. `@Nullable FileCollection` `getProvidedClasspath()` Returns the provided classpath, the contents of which will be included in the `WEB-INF/lib-provided` directory of the war. `protected boolean` `isLibrary(FileCopyDetails details)` Return if the [`FileCopyDetails`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCopyDetails.html "class or interface in org.gradle.api.file") are for a library. `void` `layered(Action action)` Configures the war's layering using the given `action`. `void` `providedClasspath(Object... classpath)` Adds files to the provided classpath to include in the `WEB-INF/lib-provided` directory of the war. `setProvidedClasspath(Object classpath)` Sets the provided classpath to include in the `WEB-INF/lib-provided` directory of the war. `void` `setProvidedClasspath(FileCollection classpath)` Sets the provided classpath to include in the `WEB-INF/lib-provided` directory of the war. ### Methods inherited from class [War](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/War.html#method-summary "class or interface in org.gradle.api.tasks.bundling") `classpath, getClasspath, getObjectFactory, getWebAppDirectory, getWebInf, getWebXml, getWebXmlFile, setClasspath, setClasspath, setWebXml, webInf, webInf` `createRootSpec, dirPermissions, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, expand, filePermissions, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirectoryFileTreeFactory, getDirPermissions, getDocumentationRegistry, getDuplicatesStrategy, getExcludes, getFileLookup, getFilePermissions, getFileResolver, getFileSystem, getFilteringCharset, getIncludeEmptyDirs, getIncludes, getInstantiator, getMainSpec, getPropertyFactory, getRootSpec, getSource, include, include, include, include, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDuplicatesStrategy, setExcludes, setFilteringCharset, setIncludeEmptyDirs, setIncludes, with` `classpath, getClasspath, getIncludeTools, getMainClass, getTargetJavaVersion, setClasspath, setClasspath` * ### BootWar public BootWar() Creates a new `BootWar` task. * ## Method Details * ### resolvedArtifacts public void resolvedArtifacts​([Provider](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Provider.html "class or interface in org.gradle.api.provider")<[Set](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html "class or interface in java.util")<[ResolvedArtifactResult](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/artifacts/result/ResolvedArtifactResult.html "class or interface in org.gradle.api.artifacts.result")>> resolvedArtifacts) Description copied from interface: `BootArchive` Registers the given lazily provided `resolvedArtifacts`. They are used to map from the files in the [`classpath`](BootArchive.html#getClasspath\(\)) to their dependency coordinates. * Specified by: `resolvedArtifacts` in interface `BootArchive` * Parameters: `resolvedArtifacts` - the lazily provided resolved artifacts * ### copy public void copy() * Overrides: `copy` in class `AbstractCopyTask` * ### createCopyAction protected org.gradle.api.internal.file.copy.CopyAction createCopyAction() * Overrides: `createCopyAction` in class `Zip` * ### requiresUnpack public void requiresUnpack​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")... patterns) Description copied from interface: `BootArchive` Adds Ant-style patterns that identify files that must be unpacked from the archive when it is launched. * Specified by: `requiresUnpack` in interface `BootArchive` * Parameters: `patterns` - the patterns * ### requiresUnpack public void requiresUnpack​([Spec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/specs/Spec.html "class or interface in org.gradle.api.specs")<[FileTreeElement](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileTreeElement.html "class or interface in org.gradle.api.file")> spec) Description copied from interface: `BootArchive` Adds a spec that identifies files that must be unpacked from the archive when it is launched. * Specified by: `requiresUnpack` in interface `BootArchive` * Parameters: `spec` - the spec * ### getProvidedClasspath [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") [@Classpath](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Classpath.html "class or interface in org.gradle.api.tasks") public @Nullable [FileCollection](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCollection.html "class or interface in org.gradle.api.file") getProvidedClasspath() Returns the provided classpath, the contents of which will be included in the `WEB-INF/lib-provided` directory of the war. * Returns: the provided classpath * ### providedClasspath public void providedClasspath​([Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang")... classpath) Adds files to the provided classpath to include in the `WEB-INF/lib-provided` directory of the war. The given `classpath` is evaluated as per [`Project.files(Object...)`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Project.html#files\(java.lang.Object...\) "class or interface in org.gradle.api"). * Parameters: `classpath` - the additions to the classpath * ### setProvidedClasspath public void setProvidedClasspath​([FileCollection](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCollection.html "class or interface in org.gradle.api.file") classpath) Sets the provided classpath to include in the `WEB-INF/lib-provided` directory of the war. * Parameters: `classpath` - the classpath * Since: 2.0.7 * ### setProvidedClasspath public void setProvidedClasspath​([Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") classpath) Sets the provided classpath to include in the `WEB-INF/lib-provided` directory of the war. The given `classpath` is evaluated as per [`Project.files(Object...)`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Project.html#files\(java.lang.Object...\) "class or interface in org.gradle.api"). * Parameters: `classpath` - the classpath * Since: 2.0.7 * ### resolveZipCompression protected [ZipCompression](ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") resolveZipCompression​([FileCopyDetails](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCopyDetails.html "class or interface in org.gradle.api.file") details) Return the [`ZipCompression`](ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") that should be used when adding the file represented by the given `details` to the jar. By default, any [`library`](#isLibrary\(org.gradle.api.file.FileCopyDetails\)) is [`stored`](ZipCompression.html#STORED) and all other files are [`deflated`](ZipCompression.html#DEFLATED). * Parameters: `details` - the file copy details * Returns: the compression to use * ### getLayered public [LayeredSpec](LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling") getLayered() Returns the spec that describes the layers in a layered jar. * Returns: the spec for the layers * Since: 2.5.0 * ### layered public void layered​([Action](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Action.html "class or interface in org.gradle.api")<[LayeredSpec](LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling")> action) Configures the war's layering using the given `action`. * Parameters: `action` - the action to apply * Since: 2.5.0 * ### isLibrary protected boolean isLibrary​([FileCopyDetails](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCopyDetails.html "class or interface in org.gradle.api.file") details) Return if the [`FileCopyDetails`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCopyDetails.html "class or interface in org.gradle.api.file") are for a library. By default any file in `WEB-INF/lib` or `WEB-INF/lib-provided` is considered to be a library. * Parameters: `details` - the file copy details * Returns: `true` if the details are for a library ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/plugin/package-summary.html ---- # Package org.springframework.boot.gradle.plugin *** @NullMarked package org.springframework.boot.gradle.plugin Central classes for the Spring Boot Gradle plugin. * Classes Class Description [ResolveMainClassName](ResolveMainClassName.html "class in org.springframework.boot.gradle.plugin") [`Task`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") for resolving the name of the application's main class. [SpringBootAotPlugin](SpringBootAotPlugin.html "class in org.springframework.boot.gradle.plugin") Gradle plugin for Spring Boot AOT. [SpringBootPlugin](SpringBootPlugin.html "class in org.springframework.boot.gradle.plugin") Gradle plugin for Spring Boot. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-18.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## T * [TestRunMojo](../org/springframework/boot/maven/TestRunMojo.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Run an application in place using the test runtime classpath. * [TestRunMojo(ToolchainManager)](../org/springframework/boot/maven/TestRunMojo.html#%3Cinit%3E\(org.apache.maven.toolchain.ToolchainManager\)) - Constructor for class org.springframework.boot.maven.[TestRunMojo](../org/springframework/boot/maven/TestRunMojo.html "class in org.springframework.boot.maven")   * [toString()](../org/springframework/boot/maven/AbstractAotMojo.Errors.html#toString\(\)) - Method in class org.springframework.boot.maven.[AbstractAotMojo.Errors](../org/springframework/boot/maven/AbstractAotMojo.Errors.html "class in org.springframework.boot.maven")   * [toURL(File)](../org/springframework/boot/maven/AbstractDependencyFilterMojo.html#toURL\(java.io.File\)) - Method in class org.springframework.boot.maven.[AbstractDependencyFilterMojo](../org/springframework/boot/maven/AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven")   [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/reference/testing/spring-applications.html ---- # Testing Spring Applications One of the major advantages of dependency injection is that it should make your code easier to unit test. You can instantiate objects by using the `new` operator without even involving Spring. You can also use *mock objects* instead of real dependencies. Often, you need to move beyond unit testing and start integration testing (with a Spring [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html)). It is useful to be able to perform integration testing without requiring deployment of your application or needing to connect to other infrastructure. The Spring Framework includes a dedicated test module for such integration testing. You can declare a dependency directly to `org.springframework:spring-test` or use the `spring-boot-starter-test` starter to pull it in transitively. If you have not used the `spring-test` module before, you should start by reading the [relevant section](https://docs.spring.io/spring-framework/reference/7.0/testing.html) of the Spring Framework reference documentation. * [Spring Boot](../../index.html) * [4.1.1](spring-applications.html) * [4.0.8](../../4.0/reference/testing/spring-applications.html) * [3.5.16](../../3.5/reference/testing/spring-applications.html) * [3.4.13](../../3.4/reference/testing/spring-applications.html) * [3.3.13](../../3.3/reference/testing/spring-applications.html) - [4.2.0-M2](../../4.2/reference/testing/spring-applications.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/testing/spring-applications.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/testing/spring-applications.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/testing/spring-applications.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/how-to/hotswapping.html ---- # Hot Swapping Spring Boot supports hot swapping. This section answers questions about how it works. ## [](#howto.hotswapping.reload-static-content)Reload Static Content There are several options for hot reloading. The recommended approach is to use [`spring-boot-devtools`](../reference/using/devtools.html), as it provides additional development-time features, such as support for fast application restarts as well as sensible development-time configuration (such as template caching). Devtools works by monitoring the classpath for changes. This means that static resource changes must be "built" for the change to take effect. By default, this happens automatically in Eclipse when you save your changes. In IntelliJ IDEA, the Make Project command triggers the necessary build. Due to the [default restart exclusions](../reference/using/devtools.html#using.devtools.restart.excluding-resources), changes to static resources do not trigger a restart of your application. Alternatively, running in an IDE (especially with debugging on) is a good way to do development (all modern IDEs allow reloading of static resources and usually also allow hot-swapping of Java class changes). Finally, the [Maven and Gradle plugins](../build-tool-plugin/index.html) can be configured (see the `addResources` property) to support running from the command line with reloading of static files directly from source. You can use that with an external css/js compiler process if you are writing that code with higher-level tools. ## [](#howto.hotswapping.reload-templates)Reload Templates without Restarting the Container Most of the templating technologies supported by Spring Boot include a configuration option to disable caching (described later in this document). If you use the `spring-boot-devtools` module, these properties are [automatically configured](../reference/using/devtools.html#using.devtools.property-defaults) for you at development time. ### [](#howto.hotswapping.reload-templates.thymeleaf)Thymeleaf Templates If you use Thymeleaf, set `spring.thymeleaf.cache` to `false`. See [`ThymeleafAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-thymeleaf/src/main/java/org/springframework/boot/thymeleaf/autoconfigure/ThymeleafAutoConfiguration.java) for other Thymeleaf customization options. ### [](#howto.hotswapping.reload-templates.freemarker)FreeMarker Templates If you use FreeMarker, set `spring.freemarker.cache` to `false`. See [`FreeMarkerAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-freemarker/src/main/java/org/springframework/boot/freemarker/autoconfigure/FreeMarkerAutoConfiguration.java) for other FreeMarker customization options. | | | | -- | -------------------------------------------------------------- | | ** | Template caching for FreeMarker is not supported with WebFlux. | ### [](#howto.hotswapping.reload-templates.groovy)Groovy Templates If you use Groovy templates, set `spring.groovy.template.cache` to `false`. See [`GroovyTemplateAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-groovy-templates/src/main/java/org/springframework/boot/groovy/template/autoconfigure/GroovyTemplateAutoConfiguration.java) for other Groovy customization options. ## [](#howto.hotswapping.fast-application-restarts)Fast Application Restarts The `spring-boot-devtools` module includes support for automatic application restarts. While not as fast as technologies such as [JRebel](https://www.jrebel.com/products/jrebel) it is usually significantly faster than a “cold start”. You should probably give it a try before investigating some of the more complex reload options discussed later in this document. For more details, see the [Developer Tools](../reference/using/devtools.html) section. ## [](#howto.hotswapping.reload-java-classes-without-restarting)Reload Java Classes without Restarting the Container Many modern IDEs (Eclipse, IntelliJ IDEA, and others) support hot swapping of bytecode. Consequently, if you make a change that does not affect class or method signatures, it should reload cleanly with no side effects. * [Spring Boot](../index.html) * [4.1.1](hotswapping.html) * [4.0.8](../4.0/how-to/hotswapping.html) * [3.5.16](../3.5/how-to/hotswapping.html) * [3.4.13](../3.4/how-to/hotswapping.html) * [3.3.13](../3.3/how-to/hotswapping.html) - [4.2.0-M2](../4.2/how-to/hotswapping.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/hotswapping.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/hotswapping.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/hotswapping.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/DependencyFilter.html ---- # Class DependencyFilter [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.shared.artifact.filter.collection.AbstractArtifactsFilter org.springframework.boot.maven.DependencyFilter * All Implemented Interfaces: `org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter` - Direct Known Subclasses: `ExcludeFilter, IncludeFilter` *** public abstract class DependencyFilter extends org.apache.maven.shared.artifact.filter.collection.AbstractArtifactsFilter Base class for `ArtifactsFilter` based on a [`FilterableDependency`](FilterableDependency.html "class in org.springframework.boot.maven") list. * Since: 1.2.0 * Author: Stephane Nicoll, David Turanski - ## Constructor Summary Constructors Constructor Description `DependencyFilter(List dependencies)` Create a new instance with the list of [`FilterableDependency`](FilterableDependency.html "class in org.springframework.boot.maven") instance(s) to use. - ## Method Summary Modifier and Type Method Description `protected final boolean` `equals(org.apache.maven.artifact.Artifact artifact, FilterableDependency dependency)` Check if the specified `Artifact` matches the specified [`FilterableDependency`](FilterableDependency.html "class in org.springframework.boot.maven"). `static DependencyFilter` `exclude(Predicate filter)` Return a new [`DependencyFilter`](DependencyFilter.html "class in org.springframework.boot.maven") the excludes artifacts based on the given predicate. `Set` `filter(Set artifacts)`   `protected abstract boolean` `filter(org.apache.maven.artifact.Artifact artifact)`   `protected final List` `getFilters()`   ### Methods inherited from class org.apache.maven.shared.artifact.filter.collection.AbstractArtifactsFilter `isArtifactIncluded` ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### DependencyFilter public DependencyFilter​([List](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html "class or interface in java.util")\ dependencies) Create a new instance with the list of [`FilterableDependency`](FilterableDependency.html "class in org.springframework.boot.maven") instance(s) to use. * Parameters: `dependencies` - the source dependencies * ## Method Details * ### filter public [Set](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html "class or interface in java.util")\ filter​([Set](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html "class or interface in java.util")\ artifacts) throws org.apache.maven.shared.artifact.filter.collection.ArtifactFilterException * Throws: `org.apache.maven.shared.artifact.filter.collection.ArtifactFilterException` * ### filter protected abstract boolean filter​(org.apache.maven.artifact.Artifact artifact) * ### equals protected final boolean equals​(org.apache.maven.artifact.Artifact artifact, [FilterableDependency](FilterableDependency.html "class in org.springframework.boot.maven") dependency) Check if the specified `Artifact` matches the specified [`FilterableDependency`](FilterableDependency.html "class in org.springframework.boot.maven"). Returns `true` if it should be excluded * Parameters: * `artifact` - the Maven `Artifact` * `dependency` - the [`FilterableDependency`](FilterableDependency.html "class in org.springframework.boot.maven") * Returns: `true` if the artifact matches the dependency * ### getFilters protected final [List](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html "class or interface in java.util")\ getFilters() * ### exclude public static [DependencyFilter](DependencyFilter.html "class in org.springframework.boot.maven") exclude​([Predicate](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html "class or interface in java.util.function")\ filter) Return a new [`DependencyFilter`](DependencyFilter.html "class in org.springframework.boot.maven") the excludes artifacts based on the given predicate. * Parameters: `filter` - the predicate used to filter the artifacts. * Returns: a new [`DependencyFilter`](DependencyFilter.html "class in org.springframework.boot.maven") instance * Since: 3.5.7 ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/AbstractPackagerMojo.html ---- Uses of Class\ org.springframework.boot.maven.AbstractPackagerMojo =================================================== * ## Uses of [AbstractPackagerMojo](../AbstractPackagerMojo.html "class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Subclasses of [AbstractPackagerMojo](../AbstractPackagerMojo.html "class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Modifier and Type Class Description `RepackageMojo` Repackage existing JAR and WAR archives so that they can be executed from the command line using java -jar. ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/class-use/LayeredSpec.IntoLayerSpec.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.bundling.LayeredSpec.IntoLayerSpec ======================================================================== Packages that use [LayeredSpec.IntoLayerSpec](../LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Package Description [org.springframework.boot.gradle.tasks.bundling](#org.springframework.boot.gradle.tasks.bundling) Support for creating executable jars and wars. * ## Uses of [LayeredSpec.IntoLayerSpec](../LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) Classes in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) with type parameters of type [LayeredSpec.IntoLayerSpec](../LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Modifier and Type Class Description `static class ` `LayeredSpec.IntoLayersSpec` Base class for specs that control the layers to which a category of content should belong. Subclasses of [LayeredSpec.IntoLayerSpec](../LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) Modifier and Type Class Description `static class ` `LayeredSpec.DependenciesIntoLayerSpec` Spec that controls the dependencies that should be part of a particular layer. Subclasses with type arguments of type [LayeredSpec.IntoLayerSpec](../LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) Modifier and Type Class Description `static class ` `LayeredSpec.ApplicationSpec` An [`LayeredSpec.IntoLayersSpec`](../LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which application classes and resources belong. Constructors in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) with parameters of type [LayeredSpec.IntoLayerSpec](../LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Modifier Constructor Description ` ` `ApplicationSpec(LayeredSpec.IntoLayerSpec... contents)` Creates a new `ApplicationSpec` with the given `contents`. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/CacheInfo.html ---- Uses of Class\ org.springframework.boot.maven.CacheInfo ======================================== No usage of org.springframework.boot.maven.CacheInfo ---- url: https://docs.spring.io/spring-boot/how-to/logging.html ---- # Logging Spring Boot has no mandatory logging dependency, except for the Commons Logging API, which is typically provided by Spring Framework’s `spring-jcl` module. To use [Logback](https://logback.qos.ch), you need to include it and `spring-jcl` on the classpath. The recommended way to do that is through the starters, which all depend on `spring-boot-starter-logging`. For a web application, you only need `spring-boot-starter-web`, since it depends transitively on the logging starter. If you use Maven, the following dependency adds logging for you: ```xml org.springframework.boot spring-boot-starter-web ``` Spring Boot has a [`LoggingSystem`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/logging/LoggingSystem.html) abstraction that attempts to configure logging based on the content of the classpath. If Logback is available, it is the first choice. If the only change you need to make to logging is to set the levels of various loggers, you can do so in `application.properties` by using the "logging.level" prefix, as shown in the following example: * Properties * YAML ```properties logging.level.org.springframework.web=debug logging.level.org.hibernate=error ``` ```yaml logging: level: org.springframework.web: "debug" org.hibernate: "error" ``` You can also set the location of a file to which the log will be written (in addition to the console) by using `logging.file.name`. To configure the more fine-grained settings of a logging system, you need to use the native configuration format supported by the [`LoggingSystem`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/logging/LoggingSystem.html) in question. By default, Spring Boot picks up the native configuration from its default location for the system (such as `classpath:logback.xml` for Logback), but you can set the location of the config file by using the `logging.config` property. ## [](#howto.logging.logback)Configure Logback for Logging If you need to apply customizations to logback beyond those that can be achieved with `application.properties`, you will need to add a standard logback configuration file. You can add a `logback.xml` file to the root of your classpath for logback to find. You can also use `logback-spring.xml` if you want to use the Spring Boot [Logback Extensions](../reference/features/logging.html#features.logging.logback-extensions). | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The Logback documentation has a [dedicated section that covers configuration](https://logback.qos.ch/manual/configuration.html) in some detail. | Spring Boot provides a number of logback configurations that can be `included` in your own configuration. These includes are designed to allow certain common Spring Boot conventions to be re-applied. The following files are provided under `org/springframework/boot/logging/logback/`: * `defaults.xml` - Provides conversion rules, pattern properties and common logger configurations. * `console-appender.xml` - Adds a [`ConsoleAppender`](https://logback.qos.ch/apidocs/ch.qos.logback.core/ch/qos/logback/core/ConsoleAppender.html) using the `CONSOLE_LOG_PATTERN`. * `structured-console-appender.xml` - Adds a [`ConsoleAppender`](https://logback.qos.ch/apidocs/ch.qos.logback.core/ch/qos/logback/core/ConsoleAppender.html) using structured logging in the `CONSOLE_LOG_STRUCTURED_FORMAT`. * `file-appender.xml` - Adds a [`RollingFileAppender`](https://logback.qos.ch/apidocs/ch.qos.logback.core/ch/qos/logback/core/rolling/RollingFileAppender.html) using the `FILE_LOG_PATTERN` and `ROLLING_FILE_NAME_PATTERN` with appropriate settings. * `structured-file-appender.xml` - Adds a [`RollingFileAppender`](https://logback.qos.ch/apidocs/ch.qos.logback.core/ch/qos/logback/core/rolling/RollingFileAppender.html) using the `ROLLING_FILE_NAME_PATTERN` with structured logging in the `FILE_LOG_STRUCTURED_FORMAT`. In addition, a legacy `base.xml` file is provided for compatibility with earlier versions of Spring Boot. A typical custom `logback.xml` file would look something like this: ```xml ``` Your logback configuration file can also make use of System properties that the [`LoggingSystem`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/logging/LoggingSystem.html) takes care of creating for you: * `${PID}`: The current process ID. * `${LOG_FILE}`: Whether `logging.file.name` was set in Boot’s external configuration. * `${LOG_PATH}`: Whether `logging.file.path` (representing a directory for log files to live in) was set in Boot’s external configuration. * `${LOG_EXCEPTION_CONVERSION_WORD}`: Whether `logging.exception-conversion-word` was set in Boot’s external configuration. * `${ROLLING_FILE_NAME_PATTERN}`: Whether `logging.pattern.rolling-file-name` was set in Boot’s external configuration. Spring Boot also provides some nice ANSI color terminal output on a console (but not in a log file) by using a custom Logback converter. See the `CONSOLE_LOG_PATTERN` in the `defaults.xml` configuration for an example. If Groovy is on the classpath, you should be able to configure Logback with `logback.groovy` as well. If present, this setting is given preference. | | | | -- | ---------------------------------------------------------------------------------------------------------------------- | | ** | Spring extensions are not supported with Groovy configuration. Any `logback-spring.groovy` files will not be detected. | ### [](#howto.logging.logback.file-only-output)Configure Logback for File-only Output If you want to disable console logging and write output only to a file, you need a custom `logback-spring.xml` that imports `file-appender.xml` but not `console-appender.xml`, as shown in the following example: ```xml ``` You also need to add `logging.file.name` to your `application.properties` or `application.yaml`, as shown in the following example: * Properties * YAML ```properties logging.file.name=myapplication.log ``` ```yaml logging: file: name: "myapplication.log" ``` ## [](#howto.logging.log4j)Configure Log4j for Logging Spring Boot supports [Log4j 2](https://logging.apache.org/log4j/2.x/) for logging configuration if it is on the classpath. If you use the starters for assembling dependencies, you have to exclude Logback and then include Log4j 2 instead. If you do not use the starters, you need to provide (at least) `spring-jcl` in addition to Log4j 2. The recommended path is through the starters, even though it requires some jiggling. The following example shows how to set up the starters in Maven: ```xml org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter org.springframework.boot spring-boot-starter-logging org.springframework.boot spring-boot-starter-log4j2 ``` Gradle provides a few different ways to set up the starters. One way is to use a [module replacement](https://docs.gradle.org/current/userguide/resolution_rules.html#sec:module-replacement). To do so, declare a dependency on the Log4j 2 starter and tell Gradle that any occurrences of the default logging starter should be replaced by the Log4j 2 starter, as shown in the following example: ```gradle dependencies { implementation "org.springframework.boot:spring-boot-starter-log4j2" modules { module("org.springframework.boot:spring-boot-starter-logging") { replacedBy("org.springframework.boot:spring-boot-starter-log4j2", "Use Log4j2 instead of Logback") } } } ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The Log4j starters gather together the dependencies for common logging requirements (such as having Tomcat use `java.util.logging` but configuring the output using Log4j 2). | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | To ensure that debug logging performed using `java.util.logging` is routed into Log4j 2, configure its [JDK logging adapter](https://logging.apache.org/log4j/2.x/log4j-jul.html) by setting the `java.util.logging.manager` system property to `org.apache.logging.log4j.jul.LogManager`. | ### [](#howto.logging.log4j.yaml-or-json-config)Use YAML or JSON to Configure Log4j 2 In addition to its default XML configuration format, Log4j 2 also supports YAML and JSON configuration files. To configure Log4j 2 to use an alternative configuration file format, add the appropriate dependencies to the classpath and name your configuration files to match your chosen file format, as shown in the following example: | Format | Dependencies | File names | | ------ | ---------------------------------------------------------------------------------------------------------- | ---------------------------- | | YAML | `com.fasterxml.jackson.core:jackson-databind` + `com.fasterxml.jackson.dataformat:jackson-dataformat-yaml` | `log4j2.yaml` + `log4j2.yml` | | JSON | `com.fasterxml.jackson.core:jackson-databind` | `log4j2.json` + `log4j2.jsn` | ### [](#howto.logging.log4j.composite-configuration)Use Composite Configuration to Configure Log4j 2 Log4j 2 has support for combining multiple configuration files into a single composite configuration. To use this support in Spring Boot, configure `logging.log4j2.config.override` with the locations of one or more secondary configuration files. The secondary configuration files will be merged with the primary configuration, whether the primary’s source is Spring Boot’s defaults, a standard location such as `log4j.xml`, or the location configured by the `logging.config` property. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Log4j2 override configuration file locations can be prefixed with `optional:`. For example, `optional:classpath:log4j2-override.xml` indicates that `log4j2-override.xml` should only be loaded if the resource exists. | * [Spring Boot](../index.html) * [4.1.1](logging.html) * [4.0.8](../4.0/how-to/logging.html) * [3.5.16](../3.5/how-to/logging.html) * [3.4.13](../3.4/how-to/logging.html) * [3.3.13](../3.3/how-to/logging.html) - [4.2.0-M2](../4.2/how-to/logging.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/logging.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/logging.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/logging.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/StopMojo.html ---- Uses of Class\ org.springframework.boot.maven.StopMojo ======================================= No usage of org.springframework.boot.maven.StopMojo ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/BuildImageMojo.html ---- Uses of Class\ org.springframework.boot.maven.BuildImageMojo ============================================= * ## Uses of [BuildImageMojo](../BuildImageMojo.html "class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Subclasses of [BuildImageMojo](../BuildImageMojo.html "class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Modifier and Type Class Description `class ` `BuildImageForkMojo` Package an application into an OCI image using a buildpack, forking the lifecycle to make sure that `package` ran. `class ` `BuildImageNoForkMojo` Package an application into an OCI image using a buildpack, but without forking the lifecycle. ---- url: https://docs.spring.io/spring-boot/reference/index.html ---- # Reference This section provides information on using the features and capabilities of Spring Boot. * [Spring Boot](../index.html) * [4.1.1](index.html) * [4.0.8](../4.0/reference/index.html) * [3.5.16](../3.5/reference/index.html) * [3.4.13](../3.4/reference/index.html) * [3.3.13](../3.3/reference/index.html) - [4.2.0-M2](../4.2/reference/index.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/reference/index.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/reference/index.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/reference/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/tutorial/index.html ---- # Tutorials This section provides tutorials to help you get started using Spring Boot. * [Spring Boot](../index.html) * [4.1.1](index.html) * [4.0.8](../4.0/tutorial/index.html) * [3.5.16](../3.5/tutorial/index.html) * [3.4.13](../3.4/tutorial/index.html) * [3.3.13](../3.3/tutorial/index.html) - [4.2.0-M2](../4.2/tutorial/index.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/tutorial/index.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/tutorial/index.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/tutorial/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/class-use/BootJar.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.bundling.BootJar ====================================================== No usage of org.springframework.boot.gradle.tasks.bundling.BootJar ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/aot/class-use/ProcessAot.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.aot.ProcessAot ==================================================== No usage of org.springframework.boot.gradle.tasks.aot.ProcessAot ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/plugin/SpringBootPlugin.html ---- # Class SpringBootPlugin [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.gradle.plugin.SpringBootPlugin * All Implemented Interfaces: `Plugin` *** public class SpringBootPlugin extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") implements [Plugin](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Plugin.html "class or interface in org.gradle.api")<[Project](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Project.html "class or interface in org.gradle.api")> Gradle plugin for Spring Boot. * Since: 1.2.7 * Author: Phillip Webb, Dave Syer, Andy Wilkinson, Danny Hyun, Scott Frederick - ## Field Summary Fields Modifier and Type Field Description `static final String` `BOM_COORDINATES` The coordinates `(group:name:version)` of the `spring-boot-dependencies` bom. `static final String` `BOOT_ARCHIVES_CONFIGURATION_NAME` The name of the [`Configuration`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/artifacts/Configuration.html "class or interface in org.gradle.api.artifacts") that contains Spring Boot archives. `static final String` `BOOT_BUILD_IMAGE_TASK_NAME` The name of the default [`BootBuildImage`](../tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") task. `static final String` `BOOT_JAR_TASK_NAME` The name of the default [`BootJar`](../tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling") task. `static final String` `BOOT_WAR_TASK_NAME` The name of the default [`BootWar`](../tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling") task. `static final String` `DEVELOPMENT_ONLY_CONFIGURATION_NAME` The name of the `developmentOnly` configuration. `static final String` `PRODUCTION_RUNTIME_CLASSPATH_CONFIGURATION_NAME` The name of the `productionRuntimeClasspath` configuration. `static final String` `RESOLVE_MAIN_CLASS_NAME_TASK_NAME` The name of the [`ResolveMainClassName`](ResolveMainClassName.html "class in org.springframework.boot.gradle.plugin") task used to resolve a main class from the output of the `main` source set. `static final String` `RESOLVE_TEST_MAIN_CLASS_NAME_TASK_NAME` The name of the [`ResolveMainClassName`](ResolveMainClassName.html "class in org.springframework.boot.gradle.plugin") task used to resolve a main class from the output of the `test` source set then, if needed, the output of the `main` source set. `static final String` `TEST_AND_DEVELOPMENT_ONLY_CONFIGURATION_NAME` The name of the `testAndDevelopmentOnly` configuration. - ## Constructor Summary Constructors Constructor Description `SpringBootPlugin()` * ### BOOT\_ARCHIVES\_CONFIGURATION\_NAME public static final [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") BOOT\_ARCHIVES\_CONFIGURATION\_NAME The name of the [`Configuration`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/artifacts/Configuration.html "class or interface in org.gradle.api.artifacts") that contains Spring Boot archives. * Since: 2.0.0 * See Also: * [Constant Field Values](../../../../../constant-values.html#org.springframework.boot.gradle.plugin.SpringBootPlugin.BOOT_ARCHIVES_CONFIGURATION_NAME) * ### BOOT\_JAR\_TASK\_NAME public static final [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") BOOT\_JAR\_TASK\_NAME The name of the default [`BootJar`](../tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling") task. * Since: 2.0.0 * See Also: * [Constant Field Values](../../../../../constant-values.html#org.springframework.boot.gradle.plugin.SpringBootPlugin.BOOT_JAR_TASK_NAME) * ### BOOT\_WAR\_TASK\_NAME public static final [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") BOOT\_WAR\_TASK\_NAME The name of the default [`BootWar`](../tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling") task. * Since: 2.0.0 * See Also: * [Constant Field Values](../../../../../constant-values.html#org.springframework.boot.gradle.plugin.SpringBootPlugin.BOOT_WAR_TASK_NAME) * ### BOOT\_BUILD\_IMAGE\_TASK\_NAME public static final [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") BOOT\_BUILD\_IMAGE\_TASK\_NAME The name of the default [`BootBuildImage`](../tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") task. * Since: 2.3.0 * See Also: * [Constant Field Values](../../../../../constant-values.html#org.springframework.boot.gradle.plugin.SpringBootPlugin.BOOT_BUILD_IMAGE_TASK_NAME) * ### DEVELOPMENT\_ONLY\_CONFIGURATION\_NAME public static final [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") DEVELOPMENT\_ONLY\_CONFIGURATION\_NAME The name of the `developmentOnly` configuration. * Since: 2.3.0 * See Also: * [Constant Field Values](../../../../../constant-values.html#org.springframework.boot.gradle.plugin.SpringBootPlugin.DEVELOPMENT_ONLY_CONFIGURATION_NAME) * ### TEST\_AND\_DEVELOPMENT\_ONLY\_CONFIGURATION\_NAME public static final [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") TEST\_AND\_DEVELOPMENT\_ONLY\_CONFIGURATION\_NAME The name of the `testAndDevelopmentOnly` configuration. * Since: 3.2.0 * See Also: * [Constant Field Values](../../../../../constant-values.html#org.springframework.boot.gradle.plugin.SpringBootPlugin.TEST_AND_DEVELOPMENT_ONLY_CONFIGURATION_NAME) * ### PRODUCTION\_RUNTIME\_CLASSPATH\_CONFIGURATION\_NAME public static final [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") PRODUCTION\_RUNTIME\_CLASSPATH\_CONFIGURATION\_NAME The name of the `productionRuntimeClasspath` configuration. * See Also: * [Constant Field Values](../../../../../constant-values.html#org.springframework.boot.gradle.plugin.SpringBootPlugin.PRODUCTION_RUNTIME_CLASSPATH_CONFIGURATION_NAME) * ### RESOLVE\_MAIN\_CLASS\_NAME\_TASK\_NAME public static final [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") RESOLVE\_MAIN\_CLASS\_NAME\_TASK\_NAME The name of the [`ResolveMainClassName`](ResolveMainClassName.html "class in org.springframework.boot.gradle.plugin") task used to resolve a main class from the output of the `main` source set. * Since: 3.0.0 * See Also: * [Constant Field Values](../../../../../constant-values.html#org.springframework.boot.gradle.plugin.SpringBootPlugin.RESOLVE_MAIN_CLASS_NAME_TASK_NAME) * ### RESOLVE\_TEST\_MAIN\_CLASS\_NAME\_TASK\_NAME public static final [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") RESOLVE\_TEST\_MAIN\_CLASS\_NAME\_TASK\_NAME The name of the [`ResolveMainClassName`](ResolveMainClassName.html "class in org.springframework.boot.gradle.plugin") task used to resolve a main class from the output of the `test` source set then, if needed, the output of the `main` source set. * Since: 3.1.0 * See Also: * [Constant Field Values](../../../../../constant-values.html#org.springframework.boot.gradle.plugin.SpringBootPlugin.RESOLVE_TEST_MAIN_CLASS_NAME_TASK_NAME) * ### BOM\_COORDINATES public static final [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") BOM\_COORDINATES The coordinates `(group:name:version)` of the `spring-boot-dependencies` bom. * ## Constructor Details * ### SpringBootPlugin public SpringBootPlugin() * ## Method Details * ### apply public void apply​([Project](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Project.html "class or interface in org.gradle.api") project) * Specified by: `apply` in interface `Plugin` ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/class-use/CacheSpec.BindCacheSpec.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.bundling.CacheSpec.BindCacheSpec ====================================================================== Packages that use [CacheSpec.BindCacheSpec](../CacheSpec.BindCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Package Description [org.springframework.boot.gradle.tasks.bundling](#org.springframework.boot.gradle.tasks.bundling) Support for creating executable jars and wars. * ## Uses of [CacheSpec.BindCacheSpec](../CacheSpec.BindCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) Method parameters in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) with type arguments of type [CacheSpec.BindCacheSpec](../CacheSpec.BindCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Modifier and Type Method Description `void` CacheSpec.`bind(Action action)` Configures a bind cache using the given `action`. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/ExcludeFilter.html ---- Uses of Class\ org.springframework.boot.maven.ExcludeFilter ============================================ No usage of org.springframework.boot.maven.ExcludeFilter ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/RepackageMojo.html ---- Uses of Class\ org.springframework.boot.maven.RepackageMojo ============================================ No usage of org.springframework.boot.maven.RepackageMojo ---- url: https://docs.spring.io/spring-boot/reference/using/using-the-springbootapplication-annotation.html ---- # Using the @SpringBootApplication Annotation Many Spring Boot developers like their apps to use auto-configuration, component scan and be able to define extra configuration on their "application class". A single [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html) annotation can be used to enable those three features, that is: * [`@EnableAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/EnableAutoConfiguration.html): enable [Spring Boot’s auto-configuration mechanism](auto-configuration.html) * [`@ComponentScan`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/ComponentScan.html): enable [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) scan on the package where the application is located (see [the best practices](structuring-your-code.html)) * [`@SpringBootConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringBootConfiguration.html): enable registration of extra beans in the context or the import of additional configuration classes. An alternative to Spring’s standard [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) that aids [configuration detection](../testing/spring-boot-applications.html#testing.spring-boot-applications.detecting-configuration) in your integration tests. - Java - Kotlin ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; // Same as @SpringBootConfiguration @EnableAutoConfiguration @ComponentScan @SpringBootApplication public class MyApplication { public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } ``` ```kotlin import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.runApplication // Same as @SpringBootConfiguration @EnableAutoConfiguration @ComponentScan @SpringBootApplication class MyApplication fun main(args: Array) { runApplication(*args) } ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html) also provides aliases to customize the attributes of [`@EnableAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/EnableAutoConfiguration.html) and [`@ComponentScan`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/ComponentScan.html). | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | None of these features are mandatory and you may choose to replace this single annotation by any of the features that it enables. For instance, you may not want to use component scan or configuration properties scan in your application:- Java - Kotlin```java import org.springframework.boot.SpringApplication; import org.springframework.boot.SpringBootConfiguration; import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.context.annotation.Import; @SpringBootConfiguration(proxyBeanMethods = false) @EnableAutoConfiguration @Import({ SomeConfiguration.class, AnotherConfiguration.class }) public class MyApplication { public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } ``````kotlin import org.springframework.boot.SpringBootConfiguration import org.springframework.boot.autoconfigure.EnableAutoConfiguration import org.springframework.boot.docs.using.structuringyourcode.locatingthemainclass.MyApplication import org.springframework.boot.runApplication import org.springframework.context.annotation.Import @SpringBootConfiguration(proxyBeanMethods = false) @EnableAutoConfiguration @Import(SomeConfiguration::class, AnotherConfiguration::class) class MyApplication fun main(args: Array) { runApplication(*args) } ```In this example, `MyApplication` is just like any other Spring Boot application except that [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html)-annotated classes and [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html)-annotated classes are not detected automatically and the user-defined beans are imported explicitly (see [`@Import`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Import.html)). | * [Spring Boot](../../index.html) * [4.1.1](using-the-springbootapplication-annotation.html) * [4.0.8](../../4.0/reference/using/using-the-springbootapplication-annotation.html) * [3.5.16](../../3.5/reference/using/using-the-springbootapplication-annotation.html) * [3.4.13](../../3.4/reference/using/using-the-springbootapplication-annotation.html) * [3.3.13](../../3.3/reference/using/using-the-springbootapplication-annotation.html) - [4.2.0-M2](../../4.2/reference/using/using-the-springbootapplication-annotation.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/using/using-the-springbootapplication-annotation.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/using/using-the-springbootapplication-annotation.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/using/using-the-springbootapplication-annotation.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/CacheSpec.html ---- # Class CacheSpec [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.gradle.tasks.bundling.CacheSpec *** public class CacheSpec extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") Configuration for an image building cache. `CacheSpec.BindCacheSpec` Configuration for an image building cache stored in a bind mount. `static class ` `CacheSpec.VolumeCacheSpec` Configuration for an image building cache stored in a Docker volume. - ## Constructor Summary Constructors Constructor Description `CacheSpec(ObjectFactory objectFactory)`   - ## Method Summary Modifier and Type Method Description `@Nullable org.springframework.boot.buildpack.platform.build.Cache` `asCache()`   `void` `bind(Action action)` Configures a bind cache using the given `action`. `void` `volume(Action action)` Configures a volume cache using the given `action`. ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### CacheSpec @Inject public CacheSpec​([ObjectFactory](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/model/ObjectFactory.html "class or interface in org.gradle.api.model") objectFactory) * ## Method Details * ### asCache public @Nullable org.springframework.boot.buildpack.platform.build.Cache asCache() * ### volume public void volume​([Action](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Action.html "class or interface in org.gradle.api")<[CacheSpec.VolumeCacheSpec](CacheSpec.VolumeCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling")> action) Configures a volume cache using the given `action`. * Parameters: `action` - the action * ### bind public void bind​([Action](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Action.html "class or interface in org.gradle.api")<[CacheSpec.BindCacheSpec](CacheSpec.BindCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling")> action) Configures a bind cache using the given `action`. * Parameters: `action` - the action ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/class-use/BootBuildImage.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.bundling.BootBuildImage ============================================================= No usage of org.springframework.boot.gradle.tasks.bundling.BootBuildImage ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/AbstractAotMojo.Errors.html ---- # Class AbstractAotMojo.Errors [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.maven.AbstractAotMojo.Errors * All Implemented Interfaces: `DiagnosticListener` - Enclosing class: `AbstractAotMojo` *** protected static class AbstractAotMojo.Errors extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") implements [DiagnosticListener](https://docs.oracle.com/en/java/javase/17/docs/api/java.compiler/javax/tools/DiagnosticListener.html "class or interface in javax.tools")<[JavaFileObject](https://docs.oracle.com/en/java/javase/17/docs/api/java.compiler/javax/tools/JavaFileObject.html "class or interface in javax.tools")> [`DiagnosticListener`](https://docs.oracle.com/en/java/javase/17/docs/api/java.compiler/javax/tools/DiagnosticListener.html "class or interface in javax.tools") used to collect errors. * Since: 3.0.0 * Author: Phillip Webb, Scott Frederick, Omar YAYA - ## Constructor Summary Constructors Modifier Constructor Description `protected` `Errors()`   - ## Method Summary Modifier and Type Method Description `void` `report(Diagnostic diagnostic)`   `String` `toString()`   ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait` * ## Constructor Details * ### Errors protected Errors() * ## Method Details * ### report public void report​([Diagnostic](https://docs.oracle.com/en/java/javase/17/docs/api/java.compiler/javax/tools/Diagnostic.html "class or interface in javax.tools")\ diagnostic) * Specified by: `report` in interface `DiagnosticListener` * ### toString public [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") toString() * Overrides: `toString` in class `Object` ---- url: https://docs.spring.io/spring-boot/reference/io/caching.html ---- # Caching The Spring Framework provides support for transparently adding caching to an application. At its core, the abstraction applies caching to methods, thus reducing the number of executions based on the information available in the cache. The caching logic is applied transparently, without any interference to the invoker. For more details, check the [relevant section](https://docs.spring.io/spring-framework/reference/7.0/integration/cache.html) of the Spring Framework reference documentation. Spring Boot auto-configures the cache infrastructure as long as caching support is enabled by using the [`@EnableCaching`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/annotation/EnableCaching.html) annotation. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Avoid adding [`@EnableCaching`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/annotation/EnableCaching.html) to the main method’s application class. Doing so makes caching a mandatory feature, including [when running a test suite](#io.caching.testing). | To add caching to an operation of your service add the relevant annotation to its method, as shown in the following example: * Java * Kotlin ```java import org.springframework.cache.annotation.Cacheable; import org.springframework.stereotype.Component; @Component public class MyMathService { @Cacheable("piDecimals") public int computePiDecimal(int precision) { ... } } ``` ```kotlin import org.springframework.cache.annotation.Cacheable import org.springframework.stereotype.Component @Component class MyMathService { @Cacheable("piDecimals") fun computePiDecimal(precision: Int): Int { ... } } ``` This example demonstrates the use of caching on a potentially costly operation. Before invoking `computePiDecimal`, the abstraction looks for an entry in the `piDecimals` cache that matches the `precision` argument. If an entry is found, the content in the cache is immediately returned to the caller, and the method is not invoked. Otherwise, the method is invoked, and the cache is updated before returning the value. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can also use the standard JSR-107 (JCache) annotations (such as [`@CacheResult`](https://javadoc.io/doc/javax.cache/cache-api/1.1.1/javax/cache/annotation/CacheResult.html)) transparently. However, we strongly advise you to not mix and match the Spring Cache and JCache annotations. | If you do not add any specific cache library, Spring Boot auto-configures a [simple provider](#io.caching.provider.simple) that uses concurrent maps in memory. When a cache is required (such as `piDecimals` in the preceding example), this provider creates it for you. The simple provider is not really recommended for production usage, but it is great for getting started and making sure that you understand the features. When you have made up your mind about the cache provider to use, please make sure to read its documentation to figure out how to configure the caches that your application uses. Nearly all providers require you to explicitly configure every cache that you use in the application. Some offer a way to customize the default caches defined by the `spring.cache.cache-names` property. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | It is also possible to transparently [update](https://docs.spring.io/spring-framework/reference/7.0/integration/cache/annotations.html#cache-annotations-put) or [evict](https://docs.spring.io/spring-framework/reference/7.0/integration/cache/annotations.html#cache-annotations-evict) data from the cache. | ## [](#io.caching.provider)Supported Cache Providers The cache abstraction does not provide an actual store and relies on abstraction materialized by the [`Cache`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/Cache.html) and [`CacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/CacheManager.html) interfaces. If you have not defined a bean of type [`CacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/CacheManager.html) or a [`CacheResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/interceptor/CacheResolver.html) named `cacheResolver` (see [`CachingConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/annotation/CachingConfigurer.html)), Spring Boot tries to detect the following providers (in the indicated order): 1. [Generic](#io.caching.provider.generic) 2. [JCache (JSR-107)](#io.caching.provider.jcache) (EhCache 3, Hazelcast, Infinispan, and others) 3. [Hazelcast](#io.caching.provider.hazelcast) 4. [Infinispan](#io.caching.provider.infinispan) 5. [Couchbase](#io.caching.provider.couchbase) 6. [Redis](#io.caching.provider.redis) 7. [Caffeine](#io.caching.provider.caffeine) 8. [Cache2k](#io.caching.provider.cache2k) 9. [Simple](#io.caching.provider.simple) | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If the [`CacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/CacheManager.html) is auto-configured by Spring Boot, it is possible to *force* a particular cache provider by setting the `spring.cache.type` property. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Use the `spring-boot-starter-cache` starter to quickly add basic caching dependencies. The starter brings in `spring-context-support`. If you add dependencies manually, you must include `spring-context-support` in order to use the JCache or Caffeine support. | If the [`CacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/CacheManager.html) is auto-configured by Spring Boot, you can further tune its configuration before it is fully initialized by exposing a bean that implements the [`CacheManagerCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/cache/autoconfigure/CacheManagerCustomizer.html) interface. The following example sets a flag to say that `null` values should not be passed down to the underlying map: * Java * Kotlin ```java import org.springframework.boot.cache.autoconfigure.CacheManagerCustomizer; import org.springframework.cache.concurrent.ConcurrentMapCacheManager; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyCacheManagerConfiguration { @Bean public CacheManagerCustomizer cacheManagerCustomizer() { return (cacheManager) -> cacheManager.setAllowNullValues(false); } } ``` ```kotlin import org.springframework.boot.cache.autoconfigure.CacheManagerCustomizer import org.springframework.cache.concurrent.ConcurrentMapCacheManager import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyCacheManagerConfiguration { @Bean fun cacheManagerCustomizer(): CacheManagerCustomizer { return CacheManagerCustomizer { cacheManager -> cacheManager.isAllowNullValues = false } } } ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | In the preceding example, an auto-configured [`ConcurrentMapCacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/concurrent/ConcurrentMapCacheManager.html) is expected. If that is not the case (either you provided your own config or a different cache provider was auto-configured), the customizer is not invoked at all. You can have as many customizers as you want, and you can also order them by using [`@Order`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/annotation/Order.html) or [`Ordered`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/Ordered.html). | ### [](#io.caching.provider.generic)Generic Generic caching is used if the context defines *at least* one [`Cache`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/Cache.html) bean. A [`CacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/CacheManager.html) wrapping all beans of that type is created. ### [](#io.caching.provider.jcache)JCache (JSR-107) [JCache](https://jcp.org/en/jsr/detail?id=107) is bootstrapped through the presence of a [`CachingProvider`](https://javadoc.io/doc/javax.cache/cache-api/1.1.1/javax/cache/spi/CachingProvider.html) on the classpath (that is, a JSR-107 compliant caching library exists on the classpath), and the [`JCacheCacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/jcache/JCacheCacheManager.html) is provided by the `spring-boot-starter-cache` starter. Various compliant libraries are available, and Spring Boot provides dependency management for Ehcache 3, Hazelcast, and Infinispan. Any other compliant library can be added as well. It might happen that more than one provider is present, in which case the provider must be explicitly specified. Even if the JSR-107 standard does not enforce a standardized way to define the location of the configuration file, Spring Boot does its best to accommodate setting a cache with implementation details, as shown in the following example: * Properties * YAML ```properties spring.cache.jcache.provider=com.example.MyCachingProvider spring.cache.jcache.config=classpath:example.xml ``` ```yaml # Only necessary if more than one provider is present spring: cache: jcache: provider: "com.example.MyCachingProvider" config: "classpath:example.xml" ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | When a cache library offers both a native implementation and JSR-107 support, Spring Boot prefers the JSR-107 support, so that the same features are available if you switch to a different JSR-107 implementation. | | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Spring Boot has [general support for Hazelcast](hazelcast.html). If a single [`HazelcastInstance`](https://docs.hazelcast.org/docs/5.5.0/javadoc/com/hazelcast/core/HazelcastInstance.html) is available, it is automatically reused for the [`CacheManager`](https://javadoc.io/doc/javax.cache/cache-api/1.1.1/javax/cache/CacheManager.html) as well, unless the `spring.cache.jcache.config` property is specified. | There are two ways to customize the underlying [`CacheManager`](https://javadoc.io/doc/javax.cache/cache-api/1.1.1/javax/cache/CacheManager.html): * Caches can be created on startup by setting the `spring.cache.cache-names` property. If a custom [`Configuration`](https://javadoc.io/doc/javax.cache/cache-api/1.1.1/javax/cache/configuration/Configuration.html) bean is defined, it is used to customize them. * [`CacheManagerCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/cache/autoconfigure/CacheManagerCustomizer.html) beans are invoked with the reference of the [`CacheManager`](https://javadoc.io/doc/javax.cache/cache-api/1.1.1/javax/cache/CacheManager.html) for full customization. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If a standard [`CacheManager`](https://javadoc.io/doc/javax.cache/cache-api/1.1.1/javax/cache/CacheManager.html) bean is defined, it is wrapped automatically in an [`CacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/CacheManager.html) implementation that the abstraction expects. No further customization is applied to it. | ### [](#io.caching.provider.hazelcast)Hazelcast Spring Boot has [general support for Hazelcast](hazelcast.html). If a [`HazelcastInstance`](https://docs.hazelcast.org/docs/5.5.0/javadoc/com/hazelcast/core/HazelcastInstance.html) has been auto-configured and `com.hazelcast:hazelcast-spring` is on the classpath, it is automatically wrapped in a [`CacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/CacheManager.html). | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Hazelcast can be used as a JCache compliant cache or as a Spring [`CacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/CacheManager.html) compliant cache. When setting `spring.cache.type` to `hazelcast`, Spring Boot will use the [`CacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/CacheManager.html) based implementation. If you want to use Hazelcast as a JCache compliant cache, set `spring.cache.type` to `jcache`. If you have multiple JCache compliant cache providers and want to force the use of Hazelcast, you have to [explicitly set the JCache provider](#io.caching.provider.jcache). | ### [](#io.caching.provider.infinispan)Infinispan [Infinispan](https://infinispan.org/) has no default configuration file location, so it must be specified explicitly. Otherwise, the default bootstrap is used. * Properties * YAML ```properties spring.cache.infinispan.config=infinispan.xml ``` ```yaml spring: cache: infinispan: config: "infinispan.xml" ``` Caches can be created on startup by setting the `spring.cache.cache-names` property. If a custom [`ConfigurationBuilder`](https://docs.jboss.org/infinispan/16.1/apidocs/org/infinispan/configuration/cache/ConfigurationBuilder.html) bean is defined, it is used to customize the caches. For more details, see [the documentation](https://infinispan.org/docs/stable/titles/spring/spring.html). ### [](#io.caching.provider.couchbase)Couchbase If Spring Data Couchbase is available and Couchbase is [configured](../data/nosql.html#data.nosql.couchbase), a [`CouchbaseCacheManager`](https://docs.spring.io/spring-data/couchbase/docs/6.1.x/api/org/springframework/data/couchbase/cache/CouchbaseCacheManager.html) is auto-configured. It is possible to create additional caches on startup by setting the `spring.cache.cache-names` property and cache defaults can be configured by using `spring.cache.couchbase.*` properties. For instance, the following configuration creates `cache1` and `cache2` caches with an entry *expiration* of 10 minutes: * Properties * YAML ```properties spring.cache.cache-names=cache1,cache2 spring.cache.couchbase.expiration=10m ``` ```yaml spring: cache: cache-names: "cache1,cache2" couchbase: expiration: "10m" ``` If you need more control over the configuration, consider registering a [`CouchbaseCacheManagerBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/cache/autoconfigure/CouchbaseCacheManagerBuilderCustomizer.html) bean. The following example shows a customizer that configures a specific entry expiration for `cache1` and `cache2`: * Java * Kotlin ```java import java.time.Duration; import org.springframework.boot.cache.autoconfigure.CouchbaseCacheManagerBuilderCustomizer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.data.couchbase.cache.CouchbaseCacheConfiguration; @Configuration(proxyBeanMethods = false) public class MyCouchbaseCacheManagerConfiguration { @Bean public CouchbaseCacheManagerBuilderCustomizer myCouchbaseCacheManagerBuilderCustomizer() { return (builder) -> builder .withCacheConfiguration("cache1", CouchbaseCacheConfiguration .defaultCacheConfig().entryExpiry(Duration.ofSeconds(10))) .withCacheConfiguration("cache2", CouchbaseCacheConfiguration .defaultCacheConfig().entryExpiry(Duration.ofMinutes(1))); } } ``` ```kotlin import org.springframework.boot.cache.autoconfigure.CouchbaseCacheManagerBuilderCustomizer import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.data.couchbase.cache.CouchbaseCacheConfiguration import java.time.Duration @Configuration(proxyBeanMethods = false) class MyCouchbaseCacheManagerConfiguration { @Bean fun myCouchbaseCacheManagerBuilderCustomizer(): CouchbaseCacheManagerBuilderCustomizer { return CouchbaseCacheManagerBuilderCustomizer { builder -> builder .withCacheConfiguration( "cache1", CouchbaseCacheConfiguration .defaultCacheConfig().entryExpiry(Duration.ofSeconds(10)) ) .withCacheConfiguration( "cache2", CouchbaseCacheConfiguration .defaultCacheConfig().entryExpiry(Duration.ofMinutes(1)) ) } } } ``` ### [](#io.caching.provider.redis)Redis If [Redis](https://redis.io/) is available and configured, a [`RedisCacheManager`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/cache/RedisCacheManager.html) is auto-configured. It is possible to create additional caches on startup by setting the `spring.cache.cache-names` property and cache defaults can be configured by using `spring.cache.redis.*` properties. For instance, the following configuration creates `cache1` and `cache2` caches with a *time to live* of 10 minutes: * Properties * YAML ```properties spring.cache.cache-names=cache1,cache2 spring.cache.redis.time-to-live=10m ``` ```yaml spring: cache: cache-names: "cache1,cache2" redis: time-to-live: "10m" ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | By default, a key prefix is added so that, if two separate caches use the same key, Redis does not have overlapping keys and cannot return invalid values. We strongly recommend keeping this setting enabled if you create your own [`RedisCacheManager`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/cache/RedisCacheManager.html). | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can take full control of the default configuration by adding a [`RedisCacheConfiguration`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/cache/RedisCacheConfiguration.html) [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) of your own. This can be useful if you need to customize the default serialization strategy. | If you need more control over the configuration, consider registering a [`RedisCacheManagerBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/cache/autoconfigure/RedisCacheManagerBuilderCustomizer.html) bean. The following example shows a customizer that configures a specific time to live for `cache1` and `cache2`: * Java * Kotlin ```java import java.time.Duration; import org.springframework.boot.cache.autoconfigure.RedisCacheManagerBuilderCustomizer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.data.redis.cache.RedisCacheConfiguration; @Configuration(proxyBeanMethods = false) public class MyRedisCacheManagerConfiguration { @Bean public RedisCacheManagerBuilderCustomizer myRedisCacheManagerBuilderCustomizer() { return (builder) -> builder .withCacheConfiguration("cache1", RedisCacheConfiguration .defaultCacheConfig().entryTtl(Duration.ofSeconds(10))) .withCacheConfiguration("cache2", RedisCacheConfiguration .defaultCacheConfig().entryTtl(Duration.ofMinutes(1))); } } ``` ```kotlin import org.springframework.boot.cache.autoconfigure.RedisCacheManagerBuilderCustomizer import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.data.redis.cache.RedisCacheConfiguration import java.time.Duration @Configuration(proxyBeanMethods = false) class MyRedisCacheManagerConfiguration { @Bean fun myRedisCacheManagerBuilderCustomizer(): RedisCacheManagerBuilderCustomizer { return RedisCacheManagerBuilderCustomizer { builder -> builder .withCacheConfiguration( "cache1", RedisCacheConfiguration .defaultCacheConfig().entryTtl(Duration.ofSeconds(10)) ) .withCacheConfiguration( "cache2", RedisCacheConfiguration .defaultCacheConfig().entryTtl(Duration.ofMinutes(1)) ) } } } ``` ### [](#io.caching.provider.caffeine)Caffeine [Caffeine](https://github.com/ben-manes/caffeine) is a Java 8 rewrite of Guava’s cache that supersedes support for Guava. If Caffeine is present, a [`CaffeineCacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/caffeine/CaffeineCacheManager.html) (provided by the `spring-boot-starter-cache` starter) is auto-configured. Caches can be created on startup by setting the `spring.cache.cache-names` property and can be customized by one of the following (in the indicated order): 1. A cache spec defined by `spring.cache.caffeine.spec` 2. A [`CaffeineSpec`](https://javadoc.io/doc/com.github.ben-manes.caffeine/caffeine/3.2.4/com/github/benmanes/caffeine/cache/CaffeineSpec.html) bean is defined 3. A [`Caffeine`](https://javadoc.io/doc/com.github.ben-manes.caffeine/caffeine/3.2.4/com/github/benmanes/caffeine/cache/Caffeine.html) bean is defined For instance, the following configuration creates `cache1` and `cache2` caches with a maximum size of 500 and a *time to live* of 10 minutes * Properties * YAML ```properties spring.cache.cache-names=cache1,cache2 spring.cache.caffeine.spec=maximumSize=500,expireAfterAccess=600s ``` ```yaml spring: cache: cache-names: "cache1,cache2" caffeine: spec: "maximumSize=500,expireAfterAccess=600s" ``` If a [`CacheLoader`](https://javadoc.io/doc/com.github.ben-manes.caffeine/caffeine/3.2.4/com/github/benmanes/caffeine/cache/CacheLoader.html) bean is defined, it is automatically associated to the [`CaffeineCacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/caffeine/CaffeineCacheManager.html). Since the [`CacheLoader`](https://javadoc.io/doc/com.github.ben-manes.caffeine/caffeine/3.2.4/com/github/benmanes/caffeine/cache/CacheLoader.html) is going to be associated with *all* caches managed by the cache manager, it must be defined as `CacheLoader`. The auto-configuration ignores any other generic type. ### [](#io.caching.provider.cache2k)Cache2k [Cache2k](https://cache2k.org/) is an in-memory cache. If the Cache2k spring integration is present, a `SpringCache2kCacheManager` is auto-configured. Caches can be created on startup by setting the `spring.cache.cache-names` property. Cache defaults can be customized using a [`Cache2kBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/cache/autoconfigure/Cache2kBuilderCustomizer.html) bean. The following example shows a customizer that configures the capacity of the cache to 200 entries, with an expiration of 5 minutes: * Java * Kotlin ```java import java.util.concurrent.TimeUnit; import org.springframework.boot.cache.autoconfigure.Cache2kBuilderCustomizer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyCache2kDefaultsConfiguration { @Bean public Cache2kBuilderCustomizer myCache2kDefaultsCustomizer() { return (builder) -> builder.entryCapacity(200) .expireAfterWrite(5, TimeUnit.MINUTES); } } ``` ```kotlin import org.springframework.boot.cache.autoconfigure.Cache2kBuilderCustomizer import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import java.util.concurrent.TimeUnit @Configuration(proxyBeanMethods = false) class MyCache2kDefaultsConfiguration { @Bean fun myCache2kDefaultsCustomizer(): Cache2kBuilderCustomizer { return Cache2kBuilderCustomizer { builder -> builder.entryCapacity(200) .expireAfterWrite(5, TimeUnit.MINUTES) } } } ``` ### [](#io.caching.provider.simple)Simple If none of the other providers can be found, a simple implementation using a [`ConcurrentHashMap`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/ConcurrentHashMap.html) as the cache store is configured. This is the default if no caching library is present in your application. By default, caches are created as needed, but you can restrict the list of available caches by setting the `cache-names` property. For instance, if you want only `cache1` and `cache2` caches, set the `cache-names` property as follows: * Properties * YAML ```properties spring.cache.cache-names=cache1,cache2 ``` ```yaml spring: cache: cache-names: "cache1,cache2" ``` If you do so and your application uses a cache not listed, then it fails at runtime when the cache is needed, but not on startup. This is similar to the way the "real" cache providers behave if you use an undeclared cache. ### [](#io.caching.provider.none)None If you need to use a no-op cache rather than the auto-configured cache manager in a certain environment, set the cache type to `none`, as shown in the following example: * Properties * YAML ```properties spring.cache.type=none ``` ```yaml spring: cache: type: "none" ``` ## [](#io.caching.testing)Testing It is generally useful to use a no-op implementation when running a test suite. This section lists a number of strategies that are useful for tests. When a custom [`CacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/CacheManager.html) is defined, the best option is to make sure that caching configuration is defined in an isolated [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class. Doing so makes sure that caching is not required by slice tests. For tests that enable a full context, such as [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html), an explicit configuration overriding the regular configuration is required. If caching is auto-configured, more options are available. Tests can be annotated with [`@AutoConfigureCache`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/cache/test/autoconfigure/AutoConfigureCache.html) to replace the auto-configured [`CacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/CacheManager.html) by a no-op implementation. * Java * Kotlin ```java import org.springframework.boot.cache.test.autoconfigure.AutoConfigureCache; import org.springframework.boot.test.context.SpringBootTest; @SpringBootTest @AutoConfigureCache public class MyIntegrationTests { // Tests use a no-op cache manager } ``` ```kotlin import org.springframework.boot.cache.test.autoconfigure.AutoConfigureCache import org.springframework.boot.test.context.SpringBootTest @SpringBootTest @AutoConfigureCache class MyIntegrationTests { // Tests use a no-op cache manager } ``` Another option is to force a no-op implementation for the auto-configured [`CacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/CacheManager.html): * Properties * YAML ```properties spring.cache.type=none ``` ```yaml spring: cache: type: "none" ``` * [Spring Boot](../../index.html) * [4.1.1](caching.html) * [4.0.8](../../4.0/reference/io/caching.html) * [3.5.16](../../3.5/reference/io/caching.html) * [3.4.13](../../3.4/reference/io/caching.html) * [3.3.13](../../3.3/reference/io/caching.html) - [4.2.0-M2](../../4.2/reference/io/caching.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/io/caching.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/io/caching.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/io/caching.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/cli/installation.html ---- # Installing the CLI The Spring Boot CLI (Command-Line Interface) can be installed manually by using SDKMAN! (the SDK Manager) or by using Homebrew or MacPorts if you are an OSX user. See [Installing the Spring Boot CLI](../installing.html#getting-started.installing.cli) in the “Getting Started” section for comprehensive installation instructions. * [Spring Boot](../index.html) * [4.1.1](installation.html) * [4.0.8](../4.0/cli/installation.html) * [3.5.16](../3.5/cli/installation.html) * [3.4.13](../3.4/cli/installation.html) * [3.3.13](../3.3/cli/installation.html) - [4.2.0-M2](../4.2/cli/installation.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/cli/installation.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/cli/installation.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/cli/installation.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/testing/test-modules.html ---- # Test Modules Spring Boot offers several focused, feature-specific `-test` modules: | Module | Purpose | | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | `spring-boot-cache-test` | Testing applications that use Spring Framework’s cache abstraction. | | `spring-boot-data-cassandra-test` | Testing applications that use Spring Data Cassandra. Provides the `@DataCassandraTest` test slice. | | `spring-boot-data-couchbase-test` | Testing applications that use Spring Data Couchbase. Provides the `@DataCouchbaseTest` test slice. | | `spring-boot-data-elasticsearch-test` | Testing applications that use Spring Data Elasticsearch. Provides the `@DataElasticsearchTest` test slice. | | `spring-boot-data-jdbc-test` | Testing applications that use Spring Data JDBC. Provides the `@DataJdbcTest` test slice. | | `spring-boot-data-jpa-test` | Testing applications that use Spring Data JPA. Provides the `@DataJpaTest` test slice. | | `spring-boot-data-ldap-test` | Testing applications that use Spring Data LDAP. Provides the `@DataLdapTest` test slice. | | `spring-boot-mongodb-test` | Testing applications that use Spring Data MongoDB. Provides the `@DataMongoTest` test slice. | | `spring-boot-data-neo4j-test` | Testing applications that use Spring Data JPA. Provides the `@DataNeo4jTest` test slice. | | `spring-boot-data-r2dbc-test` | Testing applications that use Spring Data R2DBC. Provides the `@DataR2dbcTest` test slice. | | `spring-boot-data-redis-test` | Testing applications that use Spring Data Redis. Provides the `@DataRedisTest` test slice. | | `spring-boot-graphql-test` | Testing applications that use Spring GraphQL. Provides the `@GraphQlTest` test slice. | | `spring-boot-grpc-test` | Testing applications that use Spring gRPC. | | `spring-boot-jdbc-test` | Testing applications that using Spring JDBC. Provides the `@JdbcTest` test slice. | | `spring-boot-jooq-test` | Testing applications that using jOOQ. Provides the `@JooqTest` test slice. | | `spring-boot-jpa-test` | Testing applications that use JPA. | | `spring-boot-micrometer-metrics-test` | Testing applications that use Micrometer Metrics. | | `spring-boot-micrometer-tracing-test` | Testing applications that use Micrometer Tracing. | | `spring-boot-restclient-test` | Testing applications that use REST clients. Provides the `@RestClientTest` test slice. | | `spring-boot-security-test` | Testing applications that use Spring Security. | | `spring-boot-webserver-test` | Testing applications that use `WebServer` implementations. Provides the `@AutoconfigureWebServer` annotation. | | `spring-boot-webclient-test` | Testing applications that use `WebClient`. Provides the `@WebClientTest` test slice. | | `spring-boot-webflux-test` | Testing applications that use Spring WebFlux. Provides the `@WebFluxTest` test slice. | | `spring-boot-webmvc-test` | Testing applications that use Spring Web MVC. Provides the `@WebMvcTest` test slice. | | `spring-boot-webservices-test` | Testing applications that use Spring Web Services. Provides the `@WebServiceClientTest` and `@WebServiceServerTest` test slices. | * [Spring Boot](../../index.html) * [4.1.1](test-modules.html) * [4.0.8](../../4.0/reference/testing/test-modules.html) * [3.5.16](../../3.5/index.html) * [3.4.13](../../3.4/index.html) * [3.3.13](../../3.3/index.html) - [4.2.0-M2](../../4.2/reference/testing/test-modules.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/testing/test-modules.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/testing/test-modules.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/testing/test-modules.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/how-to/application.html ---- # Spring Boot Application This section includes topics relating directly to Spring Boot applications. ## [](#howto.application.failure-analyzer)Create Your Own FailureAnalyzer [`FailureAnalyzer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/diagnostics/FailureAnalyzer.html) is a great way to intercept an exception on startup and turn it into a human-readable message, wrapped in a [`FailureAnalysis`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/diagnostics/FailureAnalysis.html). Spring Boot provides such an analyzer for application-context-related exceptions, JSR-303 validations, and more. You can also create your own. [`AbstractFailureAnalyzer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/diagnostics/AbstractFailureAnalyzer.html) is a convenient extension of [`FailureAnalyzer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/diagnostics/FailureAnalyzer.html) that checks the presence of a specified exception type in the exception to handle. You can extend from that so that your implementation gets a chance to handle the exception only when it is actually present. If, for whatever reason, you cannot handle the exception, return `null` to give another implementation a chance to handle the exception. [`FailureAnalyzer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/diagnostics/FailureAnalyzer.html) implementations must be registered in `META-INF/spring.factories`. The following example registers `ProjectConstraintViolationFailureAnalyzer`: ```properties org.springframework.boot.diagnostics.FailureAnalyzer=\ com.example.ProjectConstraintViolationFailureAnalyzer ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you need access to the [`BeanFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/BeanFactory.html) or the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html), declare them as constructor arguments in your [`FailureAnalyzer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/diagnostics/FailureAnalyzer.html) implementation. | ## [](#howto.application.troubleshoot-auto-configuration)Troubleshoot Auto-configuration The Spring Boot auto-configuration tries its best to “do the right thing”, but sometimes things fail, and it can be hard to tell why. There is a really useful [`ConditionEvaluationReport`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionEvaluationReport.html) available in any Spring Boot [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html). You can see it if you enable `DEBUG` logging output. If you use the `spring-boot-actuator` (see the [Actuator](actuator.html) section), there is also a `conditions` endpoint that renders the report in JSON. Use that endpoint to debug the application and see what features have been added (and which have not been added) by Spring Boot at runtime. Many more questions can be answered by looking at the source code and the API documentation. When reading the code, remember the following rules of thumb: * Look for classes called `*AutoConfiguration` and read their sources. Pay special attention to the `@Conditional*` annotations to find out what features they enable and when. Add `--debug` to the command line or the System property `-Ddebug` to get a log on the console of all the auto-configuration decisions that were made in your app. In a running application with actuator enabled, look at the `conditions` endpoint (`/actuator/conditions` or the JMX equivalent) for the same information. * Look for classes that are [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) (such as [`ServerProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/autoconfigure/ServerProperties.html)) and read from there the available external configuration options. The [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) annotation has a `name` attribute that acts as a prefix to external properties. Thus, [`ServerProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/autoconfigure/ServerProperties.html) has `prefix="server"` and its configuration properties are `server.port`, `server.address`, and others. In a running application with actuator enabled, look at the `configprops` endpoint. * Look for uses of the `bind` method on the [`Binder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/bind/Binder.html) to pull configuration values explicitly out of the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) in a relaxed manner. It is often used with a prefix. * Look for [`@Value`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Value.html) annotations that bind directly to the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html). * Look for [`@ConditionalOnExpression`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/condition/ConditionalOnExpression.html) annotations that switch features on and off in response to SpEL expressions, normally evaluated with placeholders resolved from the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html). ## [](#howto.application.customize-the-environment-or-application-context)Customize the Environment or ApplicationContext Before It Starts A [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) has [`ApplicationListener`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationListener.html) and [`ApplicationContextInitializer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContextInitializer.html) implementations that are used to apply customizations to the context or environment. Spring Boot loads a number of such customizations for use internally from `META-INF/spring.factories`. There is more than one way to register additional customizations: * Programmatically, per application, by calling the `addListeners` and `addInitializers` methods on [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) before you run it. * Declaratively, for all applications, by adding a `META-INF/spring.factories` and packaging a jar file that the applications all use as a library. The [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) sends some special [`ApplicationEvents`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/context/event/ApplicationEvents.html) to the listeners (some even before the context is created) and then registers the listeners for events published by the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) as well. See [Application Events and Listeners](../reference/features/spring-application.html#features.spring-application.application-events-and-listeners) in the “Spring Boot Features” section for a complete list. It is also possible to customize the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) before the application context is refreshed by using [`EnvironmentPostProcessor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/EnvironmentPostProcessor.html). Each implementation should be registered in `META-INF/spring.factories`, as shown in the following example: ```none org.springframework.boot.EnvironmentPostProcessor=com.example.YourEnvironmentPostProcessor ``` The implementation can load arbitrary files and add them to the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html). For instance, the following example loads a YAML configuration file from the classpath: * Java * Kotlin ```java import java.io.IOException; import org.springframework.boot.EnvironmentPostProcessor; import org.springframework.boot.SpringApplication; import org.springframework.boot.env.YamlPropertySourceLoader; import org.springframework.core.env.ConfigurableEnvironment; import org.springframework.core.env.PropertySource; import org.springframework.core.io.ClassPathResource; import org.springframework.core.io.Resource; import org.springframework.util.Assert; public class MyEnvironmentPostProcessor implements EnvironmentPostProcessor { private final YamlPropertySourceLoader loader = new YamlPropertySourceLoader(); @Override public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) { Resource path = new ClassPathResource("com/example/myapp/config.yml"); PropertySource propertySource = loadYaml(path); environment.getPropertySources().addLast(propertySource); } private PropertySource loadYaml(Resource path) { Assert.isTrue(path.exists(), () -> "'path' [%s] must exist".formatted(path)); try { return this.loader.load("custom-resource", path).get(0); } catch (IOException ex) { throw new IllegalStateException("Failed to load yaml configuration from " + path, ex); } } } ``` ```kotlin import org.springframework.boot.EnvironmentPostProcessor import org.springframework.boot.SpringApplication import org.springframework.boot.env.YamlPropertySourceLoader import org.springframework.core.env.ConfigurableEnvironment import org.springframework.core.env.PropertySource import org.springframework.core.io.ClassPathResource import org.springframework.core.io.Resource import org.springframework.util.Assert import java.io.IOException class MyEnvironmentPostProcessor : EnvironmentPostProcessor { private val loader = YamlPropertySourceLoader() override fun postProcessEnvironment(environment: ConfigurableEnvironment, application: SpringApplication) { val path: Resource = ClassPathResource("com/example/myapp/config.yml") val propertySource = loadYaml(path) environment.propertySources.addLast(propertySource) } private fun loadYaml(path: Resource): PropertySource<*> { Assert.isTrue(path.exists()) { "'path' [$path] must exist" } return try { loader.load("custom-resource", path)[0] } catch (ex: IOException) { throw IllegalStateException("Failed to load yaml configuration from $path", ex) } } } ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) has already been prepared with all the usual property sources that Spring Boot loads by default. It is therefore possible to get the location of the file from the environment. The preceding example adds the `custom-resource` property source at the end of the list so that a key defined in any of the usual other locations takes precedence. A custom implementation may define another order. | | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | While using [`@PropertySource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/PropertySource.html) on your [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html) may seem to be a convenient way to load a custom resource in the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html), we do not recommend it. Such property sources are not added to the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) until the application context is being refreshed. This is too late to configure certain properties such as `logging.*` and `spring.main.*` which are read before refresh begins. | ## [](#howto.application.context-hierarchy)Build an ApplicationContext Hierarchy (Adding a Parent or Root Context) You can use the [`SpringApplicationBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/builder/SpringApplicationBuilder.html) class to create parent/child [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) hierarchies. See [Fluent Builder API](../reference/features/spring-application.html#features.spring-application.fluent-builder-api) in the “Spring Boot Features” section for more information. ## [](#howto.application.non-web-application)Create a Non-web Application Not all Spring applications have to be web applications (or web services). If you want to execute some code in a `main` method but also bootstrap a Spring application to set up the infrastructure to use, you can use the [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) features of Spring Boot. A [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) changes its [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) class, depending on whether it thinks it needs a web application or not. The first thing you can do to help it is to leave server-related dependencies (such as the servlet API) off the classpath. If you cannot do that (for example, if you run two applications from the same code base) then you can explicitly call `setWebApplicationType(WebApplicationType.NONE)` on your [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) instance or set the `applicationContextClass` property (through the Java API or with external properties). Application code that you want to run as your business logic can be implemented as a [`CommandLineRunner`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/CommandLineRunner.html) and dropped into the context as a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) definition. * [Spring Boot](../index.html) * [4.1.1](application.html) * [4.0.8](../4.0/how-to/application.html) * [3.5.16](../3.5/how-to/application.html) * [3.4.13](../3.4/how-to/application.html) * [3.3.13](../3.3/how-to/application.html) - [4.2.0-M2](../4.2/how-to/application.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/application.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/application.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/application.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/actuator/tracing.html ---- # Tracing Spring Boot Actuator provides dependency management and auto-configuration for [Micrometer Tracing](https://docs.micrometer.io/tracing/reference/1.7), a facade for popular tracer libraries. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------- | | ** | To learn more about Micrometer Tracing capabilities, see its [reference documentation](https://docs.micrometer.io/tracing/reference/1.7). | ## [](#actuator.micrometer-tracing.tracers)Supported Tracers Spring Boot ships auto-configuration for the following tracers: * [OpenTelemetry](https://opentelemetry.io/) with [OTLP](https://opentelemetry.io/docs/reference/specification/protocol/). * [OpenZipkin Brave](https://github.com/openzipkin/brave) with [Zipkin](https://zipkin.io/). ## [](#actuator.micrometer-tracing.getting-started)Getting Started We need an example application that we can use to get started with tracing. For our purposes, the simple “Hello World!” web application that’s covered in the [Developing Your First Spring Boot Application](../../tutorial/first-application/index.html) section will suffice. We’re going to use the Brave tracer with Zipkin as trace backend. To recap, our main application code looks like this: * Java * Kotlin ```java import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController @SpringBootApplication public class MyApplication { private static final Log logger = LogFactory.getLog(MyApplication.class); @RequestMapping("/") String home() { logger.info("home() has been called"); return "Hello World!"; } public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } ``` ```kotlin import org.apache.commons.logging.Log import org.apache.commons.logging.LogFactory import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.runApplication import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController @RestController @SpringBootApplication class MyApplication { private val logger: Log = LogFactory.getLog(MyApplication::class.java) @RequestMapping("/") fun home(): String { logger.info("home() has been called") return "Hello, World!" } } fun main(args: Array) { runApplication(*args) } ``` | | | | -- | ---------------------------------------------------------------------------------------- | | ** | There’s an added logger statement in the `home()` method, which will be important later. | Now we have to add the `org.springframework.boot:spring-boot-starter-zipkin` dependency. Then add the following application properties: * Properties * YAML ```properties management.tracing.sampling.probability=1 ``` ```yaml management: tracing: sampling: probability: 1.0 ``` By default, Spring Boot samples only 10% of requests to prevent overwhelming the trace backend. This property switches it to 100% so that every request is sent to the trace backend. To collect and visualize the traces, we need a running trace backend. We use Zipkin as our trace backend here. The [Zipkin Quickstart guide](https://zipkin.io/pages/quickstart) provides instructions how to start Zipkin locally. After Zipkin is running, you can start your application. If you open a web browser to `localhost:8080`, you should see the following output: ```none Hello World! ``` Behind the scenes, an observation has been created for the HTTP request, which in turn gets bridged to Brave, which reports a new trace to Zipkin. Now open the Zipkin UI at `localhost:9411` and press the "Run Query" button to list all collected traces. You should see one trace. Press the "Show" button to see the details of that trace. ## [](#actuator.micrometer-tracing.logging)Logging Correlation IDs Correlation IDs provide a helpful way to link lines in your log files to spans/traces. If you are using Micrometer Tracing, Spring Boot will include correlation IDs in your logs by default. The default correlation ID is built from `traceId` and `spanId` [MDC](https://logback.qos.ch/manual/mdc.html) values. For example, if Micrometer Tracing has added an MDC `traceId` of `803B448A0489F84084905D3093480352` and an MDC `spanId` of `3425F23BB2432450` the log output will include the correlation ID `[803B448A0489F84084905D3093480352-3425F23BB2432450]`. If you prefer to use a different format for your correlation ID, you can use the `logging.pattern.correlation` property to define one. For example, the following will provide a correlation ID for Logback in format previously used by Spring Cloud Sleuth: * Properties * YAML ```properties logging.pattern.correlation=[${spring.application.name:},%X{traceId:-},%X{spanId:-}] logging.include-application-name=false ``` ```yaml logging: pattern: correlation: "[${spring.application.name:},%X{traceId:-},%X{spanId:-}] " include-application-name: false ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | In the example above, `logging.include-application-name` is set to `false` to avoid the application name being duplicated in the log messages (`logging.pattern.correlation` already contains it). It’s also worth mentioning that `logging.pattern.correlation` contains a trailing space so that it is separated from the logger name that comes right after it by default. | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Correlation IDs rely on context propagation. Please read [this documentation for more details](observability.html#actuator.observability.context-propagation). | ## [](#actuator.micrometer-tracing.propagating-traces)Propagating Traces To automatically propagate traces over the network, use the auto-configured [`RestTemplateBuilder`](../io/rest-client.html#io.rest-client.resttemplate), [`RestClient.Builder`](../io/rest-client.html#io.rest-client.restclient) or [`WebClient.Builder`](../io/rest-client.html#io.rest-client.webclient) to construct the client. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you create the [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html), the [`RestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.html) or the [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html) without using the auto-configured builders, automatic trace propagation won’t work! | ## [](#actuator.micrometer-tracing.tracer-implementations)Tracer Implementations As Micrometer Tracer supports multiple tracer implementations, there are multiple dependency combinations possible with Spring Boot. The combinations OpenTelemetry with OTLP and Brave with Zipkin are common and have dedicated starters. ### [](#actuator.micrometer-tracing.tracer-implementations.otel-otlp)OpenTelemetry With OTLP Tracing with OpenTelemetry and reporting using OTLP requires the following dependencies: * `org.springframework.boot:spring-boot-starter-opentelemetry` Use the `management.opentelemetry.tracing.export.otlp.*` configuration properties to configure reporting using OTLP. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you need to apply advanced customizations to OTLP span exporters, consider registering [`OtlpHttpSpanExporterBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/tracing/opentelemetry/autoconfigure/otlp/OtlpHttpSpanExporterBuilderCustomizer.html) or [`OtlpGrpcSpanExporterBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/tracing/opentelemetry/autoconfigure/otlp/OtlpGrpcSpanExporterBuilderCustomizer.html) beans. These will be invoked before the creation of the `OtlpHttpSpanExporter` or `OtlpGrpcSpanExporter`. The customizers take precedence over anything applied by the auto-configuration. | ### [](#actuator.micrometer-tracing.tracer-implementations.otel-zipkin)OpenTelemetry With Zipkin | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | OpenTelemetry has [deprecated their Zipkin support](https://opentelemetry.io/docs/specs/otel/trace/sdk_exporters/zipkin/). The auto-configuration for it will be removed in Spring Boot 4.2. Either switch to Brave or consider using [the Zipkin OTel module](https://github.com/openzipkin-contrib/zipkin-otel) for ingesting OTLP directly. | Tracing with OpenTelemetry and reporting to Zipkin requires the following dependencies: * `org.springframework.boot:spring-boot-micrometer-tracing-opentelemetry` - Spring Boot’s support for Micrometer Tracing over OpenTelemetry. * `io.micrometer:micrometer-tracing-bridge-otel` - bridges the Micrometer Observation API to OpenTelemetry. * `org.springframework.boot:spring-boot-zipkin` - Spring Boot’s support for Zipkin. * `io.opentelemetry:opentelemetry-exporter-zipkin` - OpenTelemetry exporter that reports traces to Zipkin. Use the `management.tracing.export.zipkin.*` configuration properties to configure reporting to Zipkin. ### [](#actuator.micrometer-tracing.tracer-implementations.brave-zipkin)OpenZipkin Brave With Zipkin Tracing with OpenZipkin Brave and reporting to Zipkin requires the following dependencies: * `org.springframework.boot:spring-boot-starter-zipkin` Use the `management.tracing.export.zipkin.*` configuration properties to configure reporting to Zipkin. ## [](#actuator.micrometer-tracing.sampling)Sampling By default, Spring Boot samples only 10% of requests to prevent overwhelming the trace backend. The `management.tracing.sampling.probability` property can be used to configure this. When using OpenTelemetry, you can also configure which sampler is used via the `management.opentelemetry.tracing.sampler` property. The following samplers are supported: | Sampler | Description | | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `always-on` | Samples every trace. | | `always-off` | Discards every trace. | | `trace-id-ratio` | Samples a fraction of traces based on `management.tracing.sampling.probability`. | | `parent-based-always-on` | If the parent span is sampled, samples the child span. If there is no parent, samples every trace. | | `parent-based-always-off` | If the parent span is sampled, samples the child span. If there is no parent, discards every trace. | | `parent-based-trace-id-ratio` (default) | If the parent span is sampled, samples the child span. If there is no parent, samples a fraction of traces based on `management.tracing.sampling.probability`. | ## [](#actuator.micrometer-tracing.span-limits)Span Limits When using OpenTelemetry, you can configure span limits via the `management.opentelemetry.tracing.limits.*` configuration properties. These allow you to control the maximum number of attributes, events, and links per span, as well as the maximum length of string attribute values. For example, to limit the number of attributes per span to 64 and the maximum attribute value length to 256 characters: * Properties * YAML ```properties management.opentelemetry.tracing.limits.max-attributes=64 management.opentelemetry.tracing.limits.max-attribute-value-length=256 ``` ```yaml management: opentelemetry: tracing: limits: max-attributes: 64 max-attribute-value-length: 256 ``` If you need full control, you can register a custom [`SpanLimits`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-trace/1.62.0/io/opentelemetry/sdk/trace/SpanLimits.html) bean. ## [](#actuator.micrometer-tracing.micrometer-observation)Integration with Micrometer Observation A [`TracingAwareMeterObservationHandler`](https://javadoc.io/doc/io.micrometer/micrometer-tracing/1.7.1/io/micrometer/tracing/handler/TracingAwareMeterObservationHandler.html) is automatically registered on the [`ObservationRegistry`](https://javadoc.io/doc/io.micrometer/micrometer-observation/1.17.1/io/micrometer/observation/ObservationRegistry.html), which creates spans for every completed observation. ## [](#actuator.micrometer-tracing.creating-spans)Creating Custom Spans You can create your own spans by starting an observation. For this, inject [`ObservationRegistry`](https://javadoc.io/doc/io.micrometer/micrometer-observation/1.17.1/io/micrometer/observation/ObservationRegistry.html) into your component: * Java * Kotlin ```java import io.micrometer.observation.Observation; import io.micrometer.observation.ObservationRegistry; import org.springframework.stereotype.Component; @Component class CustomObservation { private final ObservationRegistry observationRegistry; CustomObservation(ObservationRegistry observationRegistry) { this.observationRegistry = observationRegistry; } void someOperation() { Observation observation = Observation.createNotStarted("some-operation", this.observationRegistry); observation.lowCardinalityKeyValue("some-tag", "some-value"); observation.observe(() -> { // Business logic ... }); } } ``` ```kotlin import io.micrometer.observation.Observation import io.micrometer.observation.ObservationRegistry import org.springframework.stereotype.Component @Component class CustomObservation(private val observationRegistry: ObservationRegistry) { fun someOperation() { Observation.createNotStarted("some-operation", observationRegistry) .lowCardinalityKeyValue("some-tag", "some-value") .observe { // Business logic ... } } } ``` This will create an observation named "some-operation" with the tag "some-tag=some-value". | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you want to create a span without creating a metric, you need to use the [lower-level `Tracer` API](https://docs.micrometer.io/tracing/reference/1.7/api) from Micrometer. | ## [](#actuator.micrometer-tracing.baggage)Baggage You can create baggage with the [`Tracer`](https://javadoc.io/doc/io.micrometer/micrometer-tracing/1.7.1/io/micrometer/tracing/Tracer.html) API: * Java * Kotlin ```java import io.micrometer.tracing.BaggageInScope; import io.micrometer.tracing.Tracer; import org.springframework.stereotype.Component; @Component class CreatingBaggage { private final Tracer tracer; CreatingBaggage(Tracer tracer) { this.tracer = tracer; } void doSomething() { try (BaggageInScope scope = this.tracer.createBaggageInScope("baggage1", "value1")) { // Business logic } } } ``` ```kotlin import io.micrometer.tracing.Tracer import org.springframework.stereotype.Component @Component class CreatingBaggage(private val tracer: Tracer) { fun doSomething() { tracer.createBaggageInScope("baggage1", "value1").use { // Business logic } } } ``` This example creates baggage named `baggage1` with the value `value1`. The baggage is automatically propagated over the network if you’re using W3C propagation. If you’re using B3 propagation, baggage is not automatically propagated. To manually propagate baggage over the network, use the `management.tracing.baggage.remote-fields` configuration property (this works for W3C, too). For the example above, setting this property to `baggage1` results in an HTTP header `baggage1: value1`. If you want to propagate the baggage to the MDC, use the `management.tracing.baggage.correlation.fields` configuration property. For the example above, setting this property to `baggage1` results in an MDC entry named `baggage1`. ## [](#actuator.micrometer-tracing.tests)Tests Tracing components which are reporting data are not auto-configured when using [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html). See [Using Tracing](../testing/spring-boot-applications.html#testing.spring-boot-applications.tracing) for more details. * [Spring Boot](../../index.html) * [4.1.1](tracing.html) * [4.0.8](../../4.0/reference/actuator/tracing.html) * [3.5.16](../../3.5/reference/actuator/tracing.html) * [3.4.13](../../3.4/reference/actuator/tracing.html) * [3.3.13](../../3.3/reference/actuator/tracing.html) - [4.2.0-M2](../../4.2/reference/actuator/tracing.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/actuator/tracing.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/actuator/tracing.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/actuator/tracing.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/io/hazelcast.html ---- # Hazelcast If [Hazelcast](https://hazelcast.com/) is on the classpath and a suitable configuration is found, Spring Boot auto-configures a [`HazelcastInstance`](https://docs.hazelcast.org/docs/5.5.0/javadoc/com/hazelcast/core/HazelcastInstance.html) that you can inject in your application. Spring Boot first attempts to create a client by checking the following configuration options: * The presence of a [`ClientConfig`](https://docs.hazelcast.org/docs/5.5.0/javadoc/com/hazelcast/client/config/ClientConfig.html) bean. * A configuration file defined by the `spring.hazelcast.config` property. * The presence of the `hazelcast.client.config` system property. * A `hazelcast-client.xml` in the working directory or at the root of the classpath. * A `hazelcast-client.yaml` (or `hazelcast-client.yml`) in the working directory or at the root of the classpath. If a client can not be created, Spring Boot attempts to configure an embedded server. If you define a [`Config`](https://docs.hazelcast.org/docs/5.5.0/javadoc/com/hazelcast/config/Config.html) bean, Spring Boot uses it at is. If your configuration defines an instance name, Spring Boot tries to locate an existing instance rather than creating a new one. You could also specify the Hazelcast configuration file to use through configuration, as shown in the following example: * Properties * YAML ```properties spring.hazelcast.config=classpath:config/my-hazelcast.xml ``` ```yaml spring: hazelcast: config: "classpath:config/my-hazelcast.xml" ``` Otherwise, Spring Boot tries to find the Hazelcast configuration from the default locations: `hazelcast.xml` in the working directory or at the root of the classpath, or a YAML counterpart in the same locations. We also check if the `hazelcast.config` system property is set. See the [Hazelcast documentation](https://docs.hazelcast.org/docs/latest/manual/html-single/) for more details. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | By default, [`@SpringAware`](https://docs.hazelcast.org/docs/5.5.0/javadoc/com/hazelcast/spring/context/SpringAware.html) on Hazelcast components is supported. The [`ManagedContext`](https://docs.hazelcast.org/docs/5.5.0/javadoc/com/hazelcast/core/ManagedContext.html) can be overridden by declaring a [`HazelcastConfigCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/hazelcast/autoconfigure/HazelcastConfigCustomizer.html) bean with an [`@Order`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/annotation/Order.html) higher than zero. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Spring Boot also has [explicit caching support for Hazelcast](caching.html#io.caching.provider.hazelcast). If caching is enabled, the [`HazelcastInstance`](https://docs.hazelcast.org/docs/5.5.0/javadoc/com/hazelcast/core/HazelcastInstance.html) is automatically wrapped in a [`CacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/CacheManager.html) implementation. | * [Spring Boot](../../index.html) * [4.1.1](hazelcast.html) * [4.0.8](../../4.0/reference/io/hazelcast.html) * [3.5.16](../../3.5/reference/io/hazelcast.html) * [3.4.13](../../3.4/reference/io/hazelcast.html) * [3.3.13](../../3.3/reference/io/hazelcast.html) - [4.2.0-M2](../../4.2/reference/io/hazelcast.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/io/hazelcast.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/io/hazelcast.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/io/hazelcast.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/Layers.html ---- # Class Layers [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.maven.Layers *** public class Layers extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") Layer configuration options. * Since: 2.3.0 * Author: Madhura Bhave - ## Constructor Summary Constructors Constructor Description `Layers()`   - ## Method Summary Modifier and Type Method Description `@Nullable File` `getConfiguration()` The location of the layers configuration file. `@Nullable String` `getConfigurationName()` The name of the layers configuration to load from the classpath. `boolean` `isEnabled()` Whether a `layers.idx` file should be added to the jar. `void` `setConfiguration(@Nullable File configuration)`   `void` `setConfigurationName(@Nullable String configurationName)`   ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### Layers public Layers() * ## Method Details * ### isEnabled public boolean isEnabled() Whether a `layers.idx` file should be added to the jar. * Returns: true if a `layers.idx` file should be added. * ### getConfiguration public @Nullable [File](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html "class or interface in java.io") getConfiguration() The location of the layers configuration file. If no file is provided, a default configuration is used with four layers: `application`, `resources`, `snapshot-dependencies` and `dependencies`. * Returns: the layers configuration file * ### setConfiguration public void setConfiguration​(@Nullable [File](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html "class or interface in java.io") configuration) * ### getConfigurationName public @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getConfigurationName() The name of the layers configuration to load from the classpath. A matching file is expected at `META-INF/spring/layers/.xml` * Returns: the layers configuration name to load from the classpath * ### setConfigurationName public void setConfigurationName​(@Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") configurationName) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/run/BootRun.html ---- # Class BootRun [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.gradle.api.internal.AbstractTask [org.gradle.api.DefaultTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/DefaultTask.html "class or interface in org.gradle.api") org.gradle.api.internal.ConventionTask [org.gradle.api.tasks.JavaExec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") org.springframework.boot.gradle.tasks.run.BootRun * All Implemented Interfaces: `Comparable, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Task, BaseExecSpec, JavaExecSpec, JavaForkOptions, ProcessForkOptions, Configurable` *** [@DisableCachingByDefault](https://docs.gradle.org/9.7.0/javadoc/org/gradle/work/DisableCachingByDefault.html "class or interface in org.gradle.work")([because](https://docs.gradle.org/9.7.0/javadoc/org/gradle/work/DisableCachingByDefault.html#because\(\) "class or interface in org.gradle.work")="Application should always run") public abstract class BootRun extends [JavaExec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") Custom [`JavaExec`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") task for running a Spring Boot application. `BootRun()`   - ## Method Summary Modifier and Type Method Description `void` `exec()`   `abstract Property` `getOptimizedLaunch()` Returns the property for whether the JVM's launch should be optimized. `void` `sourceResources(SourceSet sourceSet)` Adds the [`source directories`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/SourceDirectorySet.html#getSrcDirs\(\) "class or interface in org.gradle.api.file") of the given `sourceSet's` [`resources`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html#getResources\(\) "class or interface in org.gradle.api.tasks") to the start of the classpath in place of the [`output's`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html#getOutput\(\) "class or interface in org.gradle.api.tasks") [`resources directory`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSetOutput.html#getResourcesDir\(\) "class or interface in org.gradle.api.tasks"). ### Methods inherited from class [JavaExec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html#method-summary "class or interface in org.gradle.api.tasks") `args, args, bootstrapClasspath, classpath, copyTo, copyTo, debugOptions, environment, environment, executable, getAllJvmArgs, getArgs, getArgumentProviders, getBootstrapClasspath, getClasspath, getCommandLine, getDebug, getDebugOptions, getDefaultCharacterEncoding, getEnableAssertions, getEnvironment, getErrorOutput, getExecActionFactory, getExecutable, getExecutionResult, getJavaLauncher, getJavaToolchainService, getJavaVersion, getJvmArgs, getJvmArgumentProviders, getJvmArguments, getMainClass, getMainModule, getMaxHeapSize, getMinHeapSize, getModularity, getObjectFactory, getPropertyFactory, getProviderFactory, getStandardInput, getStandardOutput, getSystemProperties, getWorkingDir, getWorkingDirectory, isIgnoreExitValue, jvmArgs, jvmArgs, setAllJvmArgs, setAllJvmArgs, setArgs, setArgs, setArgsString, setBootstrapClasspath, setClasspath, setDebug, setDefaultCharacterEncoding, setEnableAssertions, setEnvironment, setErrorOutput, setExecutable, setExecutable, setIgnoreExitValue, setJvmArgs, setJvmArgs, setMaxHeapSize, setMinHeapSize, setStandardInput, setStandardOutput, setSystemProperties, setWorkingDir, setWorkingDir, systemProperties, systemProperty, workingDir` * ### BootRun public BootRun() * ## Method Details * ### getOptimizedLaunch [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[Boolean](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html "class or interface in java.lang")> getOptimizedLaunch() Returns the property for whether the JVM's launch should be optimized. The property defaults to `true`. * Returns: whether the JVM's launch should be optimized * Since: 3.0.0 * ### sourceResources public void sourceResources​([SourceSet](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html "class or interface in org.gradle.api.tasks") sourceSet) Adds the [`source directories`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/SourceDirectorySet.html#getSrcDirs\(\) "class or interface in org.gradle.api.file") of the given `sourceSet's` [`resources`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html#getResources\(\) "class or interface in org.gradle.api.tasks") to the start of the classpath in place of the [`output's`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html#getOutput\(\) "class or interface in org.gradle.api.tasks") [`resources directory`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSetOutput.html#getResourcesDir\(\) "class or interface in org.gradle.api.tasks"). * Parameters: `sourceSet` - the source set * ### exec public void exec() * Overrides: `exec` in class `JavaExec` ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/dsl/SpringBootExtension.html ---- # Class SpringBootExtension [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.gradle.dsl.SpringBootExtension *** public class SpringBootExtension extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") Entry point to Spring Boot's Gradle DSL. * Since: 2.0.0 * Author: Andy Wilkinson, Scott Frederick - ## Constructor Summary Constructors Constructor Description `SpringBootExtension(Project project)` Creates a new `SpringBootPluginExtension` that is associated with the given `project`. - ## Method Summary Modifier and Type Method Description `void` `buildInfo()` Creates a new [`BuildInfo`](../tasks/buildinfo/BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") task named `bootBuildInfo` and adds its output as a [`source directory`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/SourceDirectorySet.html#srcDir\(java.lang.Object\) "class or interface in org.gradle.api.file") of the main source set's [`resources`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html#getResources\(\) "class or interface in org.gradle.api.tasks"). `void` `buildInfo(@Nullable Action configurer)` Creates a new [`BuildInfo`](../tasks/buildinfo/BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") task named `bootBuildInfo` and adds its output as a [`source directory`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/SourceDirectorySet.html#srcDir\(java.lang.Object\) "class or interface in org.gradle.api.file") of the main source set's [`resources`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html#getResources\(\) "class or interface in org.gradle.api.tasks"). `Property` `getMainClass()` Returns the fully-qualified name of the application's main class. ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### SpringBootExtension public SpringBootExtension​([Project](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Project.html "class or interface in org.gradle.api") project) Creates a new `SpringBootPluginExtension` that is associated with the given `project`. * Parameters: `project` - the project * ## Method Details * ### getMainClass public [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getMainClass() Returns the fully-qualified name of the application's main class. * Returns: the fully-qualified name of the application's main class * Since: 2.4.0 * ### buildInfo public void buildInfo() Creates a new [`BuildInfo`](../tasks/buildinfo/BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") task named `bootBuildInfo` and adds its output as a [`source directory`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/SourceDirectorySet.html#srcDir\(java.lang.Object\) "class or interface in org.gradle.api.file") of the main source set's [`resources`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html#getResources\(\) "class or interface in org.gradle.api.tasks"). By default, the task's project artifact will be the archive base name of the `bootWar` or `bootJar` task. * ### buildInfo public void buildInfo​(@Nullable [Action](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Action.html "class or interface in org.gradle.api")<[BuildInfo](../tasks/buildinfo/BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo")> configurer) Creates a new [`BuildInfo`](../tasks/buildinfo/BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") task named `bootBuildInfo` and adds its output as a [`source directory`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/SourceDirectorySet.html#srcDir\(java.lang.Object\) "class or interface in org.gradle.api.file") of the main source set's [`resources`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html#getResources\(\) "class or interface in org.gradle.api.tasks"). The task is passed to the given `configurer` for further configuration. By default, the task's project artifact will be the archive base name of the `bootWar` or `bootJar` task. * Parameters: `configurer` - the task configurer ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/BuildInfoMojo.html ---- # Class BuildInfoMojo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.plugin.AbstractMojo org.springframework.boot.maven.BuildInfoMojo * All Implemented Interfaces: `org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo` *** @Mojo(name="build-info", defaultPhase=GENERATE\_RESOURCES, threadSafe=true) public class BuildInfoMojo extends org.apache.maven.plugin.AbstractMojo Generate a `build-info.properties` file based on the content of the current `MavenProject`. * Since: 1.4.0 * Author: Stephane Nicoll, Vedran Pavic `BuildInfoMojo(org.sonatype.plexus.build.incremental.BuildContext buildContext)` * ### BuildInfoMojo @Inject public BuildInfoMojo​(org.sonatype.plexus.build.incremental.BuildContext buildContext) * ## Method Details * ### execute public void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException * Throws: * `org.apache.maven.plugin.MojoExecutionException` * `org.apache.maven.plugin.MojoFailureException` ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/aot/class-use/AbstractAot.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.aot.AbstractAot ===================================================== Packages that use [AbstractAot](../AbstractAot.html "class in org.springframework.boot.gradle.tasks.aot") Package Description [org.springframework.boot.gradle.tasks.aot](#org.springframework.boot.gradle.tasks.aot) Support for ahead-of-time processing of an application built with Gradle. * ## Uses of [AbstractAot](../AbstractAot.html "class in org.springframework.boot.gradle.tasks.aot") in [org.springframework.boot.gradle.tasks.aot](../package-summary.html) Subclasses of [AbstractAot](../AbstractAot.html "class in org.springframework.boot.gradle.tasks.aot") in [org.springframework.boot.gradle.tasks.aot](../package-summary.html) Modifier and Type Class Description `class ` `ProcessAot` Custom [`JavaExec`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") task for ahead-of-time processing of a Spring Boot application. `class ` `ProcessTestAot` Custom [`JavaExec`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") task for ahead-of-time processing of a Spring Boot application's tests. ---- url: https://docs.spring.io/spring-boot/reference/io/spring-batch.html ---- # Spring Batch Spring Boot offers several conveniences for working with [Spring Batch](https://spring.io/projects/spring-batch), including running a Job on startup. When building a batch application, the following stores can be auto-configured: * In-memory * JDBC * MongoDB Each store has specific additional settings. For instance, it is possible to customize the tables prefix for the JDBC store, as shown in the following example: * Properties * YAML ```properties spring.batch.jdbc.table-prefix=CUSTOM_ ``` ```yaml spring: batch: jdbc: table-prefix: "CUSTOM_" ``` When using the MongoDB store, you can enable initialization of the Spring Batch job repository schema (collections and indexes): * Properties * YAML ```properties spring.batch.data.mongodb.schema.initialize=true ``` ```yaml spring: batch: data: mongodb: schema: initialize: true ``` To disable Spring Boot’s auto-configuration and take complete control of Spring Batch’s configuration, add [`@EnableBatchProcessing`](https://docs.spring.io/spring-batch/docs/6.0.x/api/org/springframework/batch/core/configuration/annotation/EnableBatchProcessing.html) to one of your [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) classes or extend [`DefaultBatchConfiguration`](https://docs.spring.io/spring-batch/docs/6.0.x/api/org/springframework/batch/core/configuration/support/DefaultBatchConfiguration.html). This will cause the auto-configuration to back off, including initialization of Spring Batch’s database schema (JDBC or MongoDB). Spring Batch can then be configured using the `@Enable*JobRepository` annotation’s attributes rather than the previously described configuration properties. To learn more about manually configuring Spring Batch, see the API documentation of: * [`DefaultBatchConfiguration`](https://docs.spring.io/spring-batch/docs/6.0.x/api/org/springframework/batch/core/configuration/support/DefaultBatchConfiguration.html) * [`@EnableBatchProcessing`](https://docs.spring.io/spring-batch/docs/6.0.x/api/org/springframework/batch/core/configuration/annotation/EnableBatchProcessing.html) * [`@EnableJdbcJobRepository`](https://docs.spring.io/spring-batch/docs/6.0.x/api/org/springframework/batch/core/configuration/annotation/EnableJdbcJobRepository.html) * [`@EnableMongoJobRepository`](https://docs.spring.io/spring-batch/docs/6.0.x/api/org/springframework/batch/core/configuration/annotation/EnableMongoJobRepository.html) For more information about Spring Batch, see the [Spring Batch project page](https://spring.io/projects/spring-batch). ## [](#io.spring-batch.running-jobs-on-startup)Running Spring Batch Jobs on Startup When Spring Boot auto-configures Spring Batch, and if a single [`Job`](https://docs.spring.io/spring-batch/docs/6.0.x/api/org/springframework/batch/core/job/Job.html) bean is found in the application context, it is executed on startup (see [`JobLauncherApplicationRunner`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/batch/autoconfigure/JobLauncherApplicationRunner.html) for details). If multiple [`Job`](https://docs.spring.io/spring-batch/docs/6.0.x/api/org/springframework/batch/core/job/Job.html) beans are found, the job that should be executed must be specified using `spring.batch.job.name`. You can disable running a [`Job`](https://docs.spring.io/spring-batch/docs/6.0.x/api/org/springframework/batch/core/job/Job.html) found in the application context, as shown in the following example: * Properties * YAML ```properties spring.batch.job.enabled=false ``` ```yaml spring: batch: job: enabled: false ``` See [`BatchAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-batch/src/main/java/org/springframework/boot/batch/autoconfigure/BatchAutoConfiguration.java), [`BatchJdbcAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-batch-jdbc/src/main/java/org/springframework/boot/batch/jdbc/autoconfigure/BatchJdbcAutoConfiguration.java), and [`BatchDataMongoAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-batch-data-mongodb/src/main/java/org/springframework/boot/batch/mongodb/autoconfigure/BatchDataMongoAutoConfiguration.java) for more details. * [Spring Boot](../../index.html) * [4.1.1](spring-batch.html) * [4.0.8](../../4.0/reference/io/spring-batch.html) * [3.5.16](../../3.5/index.html) * [3.4.13](../../3.4/index.html) * [3.3.13](../../3.3/index.html) - [4.2.0-M2](../../4.2/reference/io/spring-batch.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/io/spring-batch.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/io/spring-batch.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/io/spring-batch.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/io/webservices.html ---- # Web Services Spring Boot provides Web Services auto-configuration so that all you must do is define your [`@Endpoint`](https://docs.spring.io/spring-ws/docs/5.0.x/api/org/springframework/ws/server/endpoint/annotation/Endpoint.html) beans. The [Spring Web Services features](https://docs.spring.io/spring-ws/docs/5.0.x/reference/html) can be easily accessed with the `spring-boot-starter-webservices` module. [`SimpleWsdl11Definition`](https://docs.spring.io/spring-ws/docs/5.0.x/api/org/springframework/ws/wsdl/wsdl11/SimpleWsdl11Definition.html) and [`SimpleXsdSchema`](https://docs.spring.io/spring-ws/docs/5.0.x/api/org/springframework/xml/xsd/SimpleXsdSchema.html) beans can be automatically created for your WSDLs and XSDs respectively. To do so, configure their location, as shown in the following example: * Properties * YAML ```properties spring.webservices.wsdl-locations=classpath:/wsdl ``` ```yaml spring: webservices: wsdl-locations: "classpath:/wsdl" ``` ## [](#io.webservices.template)Calling Web Services with WebServiceTemplate If you need to call remote Web services from your application, you can use the [`WebServiceTemplate`](https://docs.spring.io/spring-ws/docs/5.0.x/reference/html#client-web-service-template) class. Since [`WebServiceTemplate`](https://docs.spring.io/spring-ws/docs/5.0.x/api/org/springframework/ws/client/core/WebServiceTemplate.html) instances often need to be customized before being used, Spring Boot does not provide any single auto-configured [`WebServiceTemplate`](https://docs.spring.io/spring-ws/docs/5.0.x/api/org/springframework/ws/client/core/WebServiceTemplate.html) bean. It does, however, auto-configure a [`WebServiceTemplateBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webservices/client/WebServiceTemplateBuilder.html), which can be used to create [`WebServiceTemplate`](https://docs.spring.io/spring-ws/docs/5.0.x/api/org/springframework/ws/client/core/WebServiceTemplate.html) instances when needed. The following code shows a typical example: * Java * Kotlin ```java import org.springframework.boot.webservices.client.WebServiceTemplateBuilder; import org.springframework.stereotype.Service; import org.springframework.ws.client.core.WebServiceTemplate; import org.springframework.ws.soap.client.core.SoapActionCallback; @Service public class MyService { private final WebServiceTemplate webServiceTemplate; public MyService(WebServiceTemplateBuilder webServiceTemplateBuilder) { this.webServiceTemplate = webServiceTemplateBuilder.build(); } public SomeResponse someWsCall(SomeRequest detailsReq) { return (SomeResponse) this.webServiceTemplate.marshalSendAndReceive(detailsReq, new SoapActionCallback("https://ws.example.com/action")); } } ``` ```kotlin import org.springframework.boot.webservices.client.WebServiceTemplateBuilder import org.springframework.stereotype.Service import org.springframework.ws.client.core.WebServiceTemplate import org.springframework.ws.soap.client.core.SoapActionCallback @Service class MyService(webServiceTemplateBuilder: WebServiceTemplateBuilder) { private val webServiceTemplate: WebServiceTemplate init { webServiceTemplate = webServiceTemplateBuilder.build() } fun someWsCall(detailsReq: SomeRequest): SomeResponse { return webServiceTemplate.marshalSendAndReceive( detailsReq, SoapActionCallback("https://ws.example.com/action") ) as SomeResponse } } ``` By default, [`WebServiceTemplateBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webservices/client/WebServiceTemplateBuilder.html) detects a suitable HTTP-based [`WebServiceMessageSender`](https://docs.spring.io/spring-ws/docs/5.0.x/api/org/springframework/ws/transport/WebServiceMessageSender.html) using the available HTTP client libraries on the classpath. You can also customize read and connection timeouts for an individual builder as follows: * Java * Kotlin ```java import java.time.Duration; import org.springframework.boot.http.client.HttpClientSettings; import org.springframework.boot.webservices.client.WebServiceMessageSenderFactory; import org.springframework.boot.webservices.client.WebServiceTemplateBuilder; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.ws.client.core.WebServiceTemplate; @Configuration(proxyBeanMethods = false) public class MyWebServiceTemplateConfiguration { @Bean public WebServiceTemplate webServiceTemplate(WebServiceTemplateBuilder builder) { HttpClientSettings settings = HttpClientSettings.defaults() .withConnectTimeout(Duration.ofSeconds(2)) .withReadTimeout(Duration.ofSeconds(2)); builder.httpMessageSenderFactory(WebServiceMessageSenderFactory.http(settings)); return builder.build(); } } ``` ```kotlin import org.springframework.boot.http.client.HttpClientSettings import org.springframework.boot.webservices.client.WebServiceMessageSenderFactory import org.springframework.boot.webservices.client.WebServiceTemplateBuilder import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.ws.client.core.WebServiceTemplate import java.time.Duration @Configuration(proxyBeanMethods = false) class MyWebServiceTemplateConfiguration { @Bean fun webServiceTemplate(builder: WebServiceTemplateBuilder): WebServiceTemplate { val settings = HttpClientSettings.defaults() .withConnectTimeout(Duration.ofSeconds(2)) .withReadTimeout(Duration.ofSeconds(2)) builder.httpMessageSenderFactory(WebServiceMessageSenderFactory.http(settings)) return builder.build() } } ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can also change the [global HTTP client configuration](rest-client.html#io.rest-client.clienthttprequestfactory.configuration) used if not specific template customization code is applied. | * [Spring Boot](../../index.html) * [4.1.1](webservices.html) * [4.0.8](../../4.0/reference/io/webservices.html) * [3.5.16](../../3.5/reference/io/webservices.html) * [3.4.13](../../3.4/reference/io/webservices.html) * [3.3.13](../../3.3/reference/io/webservices.html) - [4.2.0-M2](../../4.2/reference/io/webservices.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/io/webservices.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/io/webservices.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/io/webservices.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/AbstractPackagerMojo.LayoutType.html ---- Uses of Enum Class\ org.springframework.boot.maven.AbstractPackagerMojo.LayoutType ============================================================== * ## Uses of [AbstractPackagerMojo.LayoutType](../AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Subclasses with type arguments of type [AbstractPackagerMojo.LayoutType](../AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Modifier and Type Class Description `static enum ` `AbstractPackagerMojo.LayoutType` Archive layout types. Methods in [org.springframework.boot.maven](../package-summary.html) that return [AbstractPackagerMojo.LayoutType](../AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") Modifier and Type Method Description `protected @Nullable AbstractPackagerMojo.LayoutType` AbstractPackagerMojo.`getLayout()` Return the type of archive that should be packaged by this MOJO. `protected @Nullable AbstractPackagerMojo.LayoutType` BuildImageMojo.`getLayout()` Return the type of archive that should be used when building the image. `protected @Nullable AbstractPackagerMojo.LayoutType` RepackageMojo.`getLayout()` Return the type of archive that should be packaged by this MOJO. `static AbstractPackagerMojo.LayoutType` AbstractPackagerMojo.LayoutType.`valueOf(String name)` Returns the enum constant of this class with the specified name. `static AbstractPackagerMojo.LayoutType[]` AbstractPackagerMojo.LayoutType.`values()` Returns an array containing the constants of this enum class, in the order they are declared. ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/plugin/class-use/SpringBootAotPlugin.html ---- Uses of Class\ org.springframework.boot.gradle.plugin.SpringBootAotPlugin ========================================================== No usage of org.springframework.boot.gradle.plugin.SpringBootAotPlugin ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/class-use/LayeredSpec.DependenciesSpec.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.bundling.LayeredSpec.DependenciesSpec =========================================================================== Packages that use [LayeredSpec.DependenciesSpec](../LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Package Description [org.springframework.boot.gradle.tasks.bundling](#org.springframework.boot.gradle.tasks.bundling) Support for creating executable jars and wars. * ## Uses of [LayeredSpec.DependenciesSpec](../LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) Methods in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) that return [LayeredSpec.DependenciesSpec](../LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Modifier and Type Method Description `LayeredSpec.DependenciesSpec` LayeredSpec.`getDependencies()` Returns the [`LayeredSpec.DependenciesSpec`](../LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which dependencies belong. Methods in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) with parameters of type [LayeredSpec.DependenciesSpec](../LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Modifier and Type Method Description `void` LayeredSpec.`setDependencies(LayeredSpec.DependenciesSpec spec)` Sets the [`LayeredSpec.DependenciesSpec`](../LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which dependencies belong. Method parameters in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) with type arguments of type [LayeredSpec.DependenciesSpec](../LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Modifier and Type Method Description `void` LayeredSpec.`dependencies(Action action)` Customizes the [`LayeredSpec.DependenciesSpec`](../LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") using the given `action`. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/AbstractAotMojo.html ---- Uses of Class\ org.springframework.boot.maven.AbstractAotMojo ============================================== * ## Uses of [AbstractAotMojo](../AbstractAotMojo.html "class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Subclasses of [AbstractAotMojo](../AbstractAotMojo.html "class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Modifier and Type Class Description `class ` `ProcessAotMojo` Invoke the AOT engine on the application. `class ` `ProcessTestAotMojo` Invoke the AOT engine on tests. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/MatchingGroupIdFilter.html ---- Uses of Class\ org.springframework.boot.maven.MatchingGroupIdFilter ==================================================== No usage of org.springframework.boot.maven.MatchingGroupIdFilter ---- url: https://docs.spring.io/spring-boot/reference/packaging/index.html ---- # Packaging Spring Boot Applications Spring Boot supports several technologies for optimizing applications for deployment, including [GraalVM native images](native-image/index.html), [AOT cache](aot-cache.html), and [Checkpoint and Restore](checkpoint-restore.html). Spring Boot applications can be packaged in Docker containers using techniques described in [Container Images](container-images/index.html). * [Spring Boot](../../index.html) * [4.1.1](index.html) * [4.0.8](../../4.0/reference/packaging/index.html) * [3.5.16](../../3.5/reference/packaging/index.html) * [3.4.13](../../3.4/reference/packaging/index.html) * [3.3.13](../../3.3/reference/packaging/index.html) - [4.2.0-M2](../../4.2/reference/packaging/index.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/packaging/index.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/packaging/index.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/packaging/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/messaging/index.html ---- # Messaging The Spring Framework provides extensive support for integrating with messaging systems, from simplified use of the JMS API using [`JmsClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/core/JmsClient.html) to a complete infrastructure to receive messages asynchronously. Spring AMQP provides a similar feature set for the Advanced Message Queuing Protocol. Spring Boot also provides auto-configuration options for [`RabbitTemplate`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/core/RabbitTemplate.html) and RabbitMQ. Spring WebSocket natively includes support for STOMP messaging, and Spring Boot has support for that through starters and a small amount of auto-configuration. Spring Boot also has support for Apache Kafka and Apache Pulsar. * [Spring Boot](../../index.html) * [4.1.1](index.html) * [4.0.8](../../4.0/reference/messaging/index.html) * [3.5.16](../../3.5/reference/messaging/index.html) * [3.4.13](../../3.4/reference/messaging/index.html) * [3.3.13](../../3.3/reference/messaging/index.html) - [4.2.0-M2](../../4.2/reference/messaging/index.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/messaging/index.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/messaging/index.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/messaging/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/help.html ---- # Help Information ## [](#help.help-goal)`spring-boot:help` `org.springframework.boot:spring-boot-maven-plugin:4.1.1` Display help information on spring-boot-maven-plugin. Call `mvn spring-boot:help -Ddetail=true -Dgoal=` to display parameter details. ### [](#help.help-goal.optional-parameters)Optional parameters | Name | Type | Default | | ----------------------------------------------------------- | --------- | ------- | | [detail](#help.help-goal.parameter-details.detail) | `boolean` | `false` | | [goal](#help.help-goal.parameter-details.goal) | `String` | | | [indentSize](#help.help-goal.parameter-details.indent-size) | `int` | `2` | | [lineLength](#help.help-goal.parameter-details.line-length) | `int` | `80` | ### [](#help.help-goal.parameter-details)Parameter details #### [](#help.help-goal.parameter-details.detail)`detail` If `true`, display all settable properties for each goal. | Name | `detail` | | ------------- | --------- | | Type | `boolean` | | Default value | `false` | | User property | `detail` | | Since | | #### [](#help.help-goal.parameter-details.goal)`goal` The name of the goal for which to show help. If unspecified, all goals will be displayed. | Name | `goal` | | ------------- | ------------------ | | Type | `java.lang.String` | | Default value | | | User property | `goal` | | Since | | #### [](#help.help-goal.parameter-details.indent-size)`indentSize` The number of spaces per indentation level, should be positive. | Name | `indentSize` | | ------------- | ------------ | | Type | `int` | | Default value | `2` | | User property | `indentSize` | | Since | | #### [](#help.help-goal.parameter-details.line-length)`lineLength` The maximum length of a display line, should be positive. | Name | `lineLength` | | ------------- | ------------ | | Type | `int` | | Default value | `80` | | User property | `lineLength` | | Since | | * [Spring Boot](../index.html) * [4.1.1](help.html) * [4.0.8](../4.0/maven-plugin/help.html) * [3.5.16](../3.5/maven-plugin/help.html) * [3.4.13](../3.4/maven-plugin/help.html) * [3.3.13](../3.3/maven-plugin/help.html) - [4.2.0-M2](../4.2/maven-plugin/help.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/maven-plugin/help.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/maven-plugin/help.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/maven-plugin/help.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/packaging/efficient.html ---- # Efficient Deployments ## [](#packaging.efficient.unpacking)Unpacking the Executable jar You can run your application using the executable jar, but loading the classes from nested jars has a small startup cost. Depending on the size of the jar, running the application from an exploded structure is faster and recommended in production. Certain PaaS implementations may also choose to extract archives before they run. For example, Cloud Foundry operates this way. Spring Boot supports extracting your application to a directory using different layouts. The default layout is the most efficient, and it is [AOT cache](aot-cache.html#packaging.aot-cache.aot-cache) (and [CDS](aot-cache.html#packaging.aot-cache.cds)) friendly. In this layout, the libraries are extracted to a `lib/` folder, and the application jar contains the application classes and a manifest which references the libraries in the `lib/` folder. To unpack the executable jar, run this command: ```shell $ java -Djarmode=tools -jar my-app.jar extract ``` And then in production, you can run the extracted jar: ```shell $ java -jar my-app/my-app.jar ``` After startup, you should not expect any differences in execution time between running an executable jar and running an extracted jar. | | | | -- | ------------------------------------------------------------------------------------ | | ** | Run `java -Djarmode=tools -jar my-app.jar help extract` to see all possible options. | * [Spring Boot](../../index.html) * [4.1.1](efficient.html) * [4.0.8](../../4.0/reference/packaging/efficient.html) * [3.5.16](../../3.5/reference/packaging/efficient.html) * [3.4.13](../../3.4/reference/packaging/efficient.html) * [3.3.13](../../3.3/reference/packaging/efficient.html) - [4.2.0-M2](../../4.2/reference/packaging/efficient.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/packaging/efficient.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/packaging/efficient.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/packaging/efficient.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/how-to/messaging.html ---- # Messaging Spring Boot offers a number of starters to support messaging. This section answers questions that arise from using messaging with Spring Boot. ## [](#howto.messaging.disable-transacted-jms-session)Disable Transacted JMS Session If your JMS broker does not support transacted sessions, you have to disable the support of transactions altogether. If you create your own [`JmsListenerContainerFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jms/config/JmsListenerContainerFactory.html), there is nothing to do, since, by default it cannot be transacted. If you want to use the [`DefaultJmsListenerContainerFactoryConfigurer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jms/autoconfigure/DefaultJmsListenerContainerFactoryConfigurer.html) to reuse Spring Boot’s default, you can disable transacted sessions, as follows: * Java * Kotlin ```java import jakarta.jms.ConnectionFactory; import org.springframework.boot.jms.ConnectionFactoryUnwrapper; import org.springframework.boot.jms.autoconfigure.DefaultJmsListenerContainerFactoryConfigurer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.jms.config.DefaultJmsListenerContainerFactory; @Configuration(proxyBeanMethods = false) public class MyJmsConfiguration { @Bean public DefaultJmsListenerContainerFactory jmsListenerContainerFactory(ConnectionFactory connectionFactory, DefaultJmsListenerContainerFactoryConfigurer configurer) { DefaultJmsListenerContainerFactory listenerFactory = new DefaultJmsListenerContainerFactory(); configurer.configure(listenerFactory, ConnectionFactoryUnwrapper.unwrapCaching(connectionFactory)); listenerFactory.setTransactionManager(null); listenerFactory.setSessionTransacted(false); return listenerFactory; } } ``` ```kotlin import jakarta.jms.ConnectionFactory import org.springframework.boot.jms.ConnectionFactoryUnwrapper import org.springframework.boot.jms.autoconfigure.DefaultJmsListenerContainerFactoryConfigurer import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.jms.config.DefaultJmsListenerContainerFactory @Configuration(proxyBeanMethods = false) class MyJmsConfiguration { @Bean fun jmsListenerContainerFactory(connectionFactory: ConnectionFactory, configurer: DefaultJmsListenerContainerFactoryConfigurer): DefaultJmsListenerContainerFactory { val listenerFactory = DefaultJmsListenerContainerFactory() configurer.configure(listenerFactory, ConnectionFactoryUnwrapper.unwrapCaching(connectionFactory)) listenerFactory.setTransactionManager(null) listenerFactory.setSessionTransacted(false) return listenerFactory } } ``` The preceding example overrides the default factory, and it should be applied to any other factory that your application defines, if any. * [Spring Boot](../index.html) * [4.1.1](messaging.html) * [4.0.8](../4.0/how-to/messaging.html) * [3.5.16](../3.5/how-to/messaging.html) * [3.4.13](../3.4/how-to/messaging.html) * [3.3.13](../3.3/how-to/messaging.html) - [4.2.0-M2](../4.2/how-to/messaging.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/messaging.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/messaging.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/messaging.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/AbstractAotMojo.html ---- # Class AbstractAotMojo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.plugin.AbstractMojo [org.springframework.boot.maven.AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") org.springframework.boot.maven.AbstractAotMojo * All Implemented Interfaces: `org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo` - Direct Known Subclasses: `ProcessAotMojo, ProcessTestAotMojo` *** public abstract class AbstractAotMojo extends [AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") Abstract base class for AOT processing MOJOs. * Since: 3.0.0 * Author: Phillip Webb, Scott Frederick, Omar YAYA - ## Nested Class Summary Nested Classes Modifier and Type Class Description `protected static class ` `AbstractAotMojo.Errors` [`DiagnosticListener`](https://docs.oracle.com/en/java/javase/17/docs/api/java.compiler/javax/tools/DiagnosticListener.html "class or interface in javax.tools") used to collect errors. ### Nested classes/interfaces inherited from class [AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html#nested-class-summary "class in org.springframework.boot.maven") `AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter` - ## Field Summary ### Fields inherited from class [AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html#field-summary "class in org.springframework.boot.maven") `project` `AbstractAotMojo(org.apache.maven.toolchain.ToolchainManager toolchainManager)`   - ## Method Summary Modifier and Type Method Description `protected final void` `compileSourceFiles(URL[] classPath, File sourcesDirectory, File outputDirectory)`   `protected final void` `copyAll(Path from, Path to)`   `void` `execute()`   `protected abstract void` `executeAot()`   `protected void` `generateAotAssets(URL[] classPath, String processorClassName, String... arguments)`   `protected final URL[]` `getClassPath(File[] directories, org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter... artifactFilters)`   `protected final org.apache.maven.execution.MavenSession` `getSession()` Return Maven execution session. * ### AbstractAotMojo protected AbstractAotMojo​(org.apache.maven.toolchain.ToolchainManager toolchainManager) * ## Method Details * ### getSession protected final org.apache.maven.execution.MavenSession getSession() Return Maven execution session. * Returns: session * Since: 3.0.10 * ### execute public void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException * Throws: * `org.apache.maven.plugin.MojoExecutionException` * `org.apache.maven.plugin.MojoFailureException` * ### executeAot protected abstract void executeAot() throws [Exception](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html "class or interface in java.lang") * Throws: `Exception` * ### generateAotAssets protected void generateAotAssets​([URL](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html "class or interface in java.net")\[] classPath, [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") processorClassName, [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")... arguments) throws [Exception](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html "class or interface in java.lang") * Throws: `Exception` * ### compileSourceFiles protected final void compileSourceFiles​([URL](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html "class or interface in java.net")\[] classPath, [File](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html "class or interface in java.io") sourcesDirectory, [File](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html "class or interface in java.io") outputDirectory) throws [Exception](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html "class or interface in java.lang") * Throws: `Exception` * ### getClassPath protected final [URL](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html "class or interface in java.net")\[] getClassPath​([File](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html "class or interface in java.io")\[] directories, org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter... artifactFilters) throws org.apache.maven.plugin.MojoExecutionException * Throws: `org.apache.maven.plugin.MojoExecutionException` * ### copyAll protected final void copyAll​([Path](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/file/Path.html "class or interface in java.nio.file") from, [Path](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/file/Path.html "class or interface in java.nio.file") to) throws [IOException](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html "class or interface in java.io") * Throws: `IOException` ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/aot/ProcessAot.html ---- # Class ProcessAot [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.gradle.api.internal.AbstractTask [org.gradle.api.DefaultTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/DefaultTask.html "class or interface in org.gradle.api") org.gradle.api.internal.ConventionTask [org.gradle.api.tasks.JavaExec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") [org.springframework.boot.gradle.tasks.aot.AbstractAot](AbstractAot.html "class in org.springframework.boot.gradle.tasks.aot") org.springframework.boot.gradle.tasks.aot.ProcessAot * All Implemented Interfaces: `Comparable, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Task, BaseExecSpec, JavaExecSpec, JavaForkOptions, ProcessForkOptions, Configurable` *** [@CacheableTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/CacheableTask.html "class or interface in org.gradle.api.tasks") public abstract class ProcessAot extends [AbstractAot](AbstractAot.html "class in org.springframework.boot.gradle.tasks.aot") Custom [`JavaExec`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") task for ahead-of-time processing of a Spring Boot application. `ProcessAot()`   - ## Method Summary Modifier and Type Method Description `void` `exec()`   `abstract Property` `getApplicationMainClass()` Returns the main class of the application that is to be processed ahead-of-time. * ### ProcessAot public ProcessAot() * ## Method Details * ### getApplicationMainClass [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getApplicationMainClass() Returns the main class of the application that is to be processed ahead-of-time. * Returns: the application main class property * ### exec public void exec() * Overrides: `exec` in class `JavaExec` ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter.html ---- Uses of Class\ org.springframework.boot.maven.AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter ========================================================================================== No usage of org.springframework.boot.maven.AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/AbstractDependencyFilterMojo.html ---- # Class AbstractDependencyFilterMojo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.plugin.AbstractMojo org.springframework.boot.maven.AbstractDependencyFilterMojo * All Implemented Interfaces: `org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo` - Direct Known Subclasses: `AbstractAotMojo, AbstractPackagerMojo, AbstractRunMojo` *** public abstract class AbstractDependencyFilterMojo extends org.apache.maven.plugin.AbstractMojo A base mojo filtering the dependencies of the project. * Since: 1.1.0 * Author: Stephane Nicoll, David Turanski - ## Nested Class Summary Nested Classes Modifier and Type Class Description `protected static class ` `AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter` `ArtifactFilter` to exclude test scope dependencies. - ## Field Summary Fields Modifier and Type Field Description `protected org.apache.maven.project.MavenProject` `project` The Maven project. ### Fields inherited from interface org.apache.maven.plugin.Mojo `ROLE` - ## Constructor Summary Constructors Constructor Description `AbstractDependencyFilterMojo()`   - ## Method Summary Modifier and Type Method Description `protected final Set` `filterDependencies(Set dependencies, org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter... additionalFilters)`   `protected List` `getDependencyURLs(org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter... additionalFilters)`   `protected void` `setExcludeGroupIds(String excludeGroupIds)`   `protected void` `setExcludes(@Nullable List excludes)`   `protected void` `setIncludes(@Nullable List includes)`   `protected URL` `toURL(File file)`   @Parameter(defaultValue="${project}", readonly=true, required=true) protected org.apache.maven.project.MavenProject project The Maven project. * Since: 3.0.0 * ## Constructor Details * ### AbstractDependencyFilterMojo public AbstractDependencyFilterMojo() * ## Method Details * ### setExcludes protected void setExcludes​(@Nullable [List](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html "class or interface in java.util")<[Exclude](Exclude.html "class in org.springframework.boot.maven")> excludes) * ### setIncludes protected void setIncludes​(@Nullable [List](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html "class or interface in java.util")<[Include](Include.html "class in org.springframework.boot.maven")> includes) * ### setExcludeGroupIds protected void setExcludeGroupIds​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") excludeGroupIds) * ### getDependencyURLs protected [List](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html "class or interface in java.util")<[URL](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html "class or interface in java.net")> getDependencyURLs​(org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter... additionalFilters) throws org.apache.maven.plugin.MojoExecutionException * Throws: `org.apache.maven.plugin.MojoExecutionException` * ### filterDependencies protected final [Set](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html "class or interface in java.util")\ filterDependencies​([Set](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html "class or interface in java.util")\ dependencies, org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter... additionalFilters) throws org.apache.maven.plugin.MojoExecutionException * Throws: `org.apache.maven.plugin.MojoExecutionException` * ### toURL protected [URL](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html "class or interface in java.net") toURL​([File](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html "class or interface in java.io") file) ---- url: https://docs.spring.io/spring-boot/reference/features/spring-application.html ---- # SpringApplication The [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) class provides a convenient way to bootstrap a Spring application that is started from a `main()` method. In many situations, you can delegate to the static [`SpringApplication.run(Class, String...)`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html#run\(java.lang.Class,java.lang.String...\)) method, as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class MyApplication { public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } ``` ```kotlin import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.runApplication @SpringBootApplication class MyApplication fun main(args: Array) { runApplication(*args) } ``` When your application starts, you should see something similar to the following output: ```none . ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ \\/ ___)| |_)| | | | | || (_| | ) ) ) ) ' |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot :: (v4.1.1) 2026-08-17T10:51:43.606Z INFO 11484 --- [ main] o.s.b.d.f.logexample.MyApplication : Starting MyApplication using Java 25.0.4 with PID 11484 (/opt/apps/myapp.jar started by myuser in /opt/apps/) 2026-08-17T10:51:43.627Z INFO 11484 --- [ main] o.s.b.d.f.logexample.MyApplication : No active profile set, falling back to 1 default profile: "default" 2026-08-17T10:51:48.207Z INFO 11484 --- [ main] o.s.boot.tomcat.TomcatWebServer : Tomcat initialized with port 8080 (http) 2026-08-17T10:51:48.266Z INFO 11484 --- [ main] o.apache.catalina.core.StandardService : Starting service [Tomcat] 2026-08-17T10:51:48.275Z INFO 11484 --- [ main] o.apache.catalina.core.StandardEngine : Starting Servlet engine: [Apache Tomcat/11.0.24] 2026-08-17T10:51:48.445Z INFO 11484 --- [ main] b.w.c.s.WebApplicationContextInitializer : Root WebApplicationContext: initialization completed in 4488 ms 2026-08-17T10:51:50.163Z INFO 11484 --- [ main] o.s.boot.tomcat.TomcatWebServer : Tomcat started on port 8080 (http) with context path '/' 2026-08-17T10:51:50.190Z INFO 11484 --- [ main] o.s.b.d.f.logexample.MyApplication : Started MyApplication in 8.35 seconds (process running for 9.787) 2026-08-17T10:51:50.219Z INFO 11484 --- [ionShutdownHook] o.s.boot.tomcat.GracefulShutdown : Commencing graceful shutdown. Waiting for active requests to complete 2026-08-17T10:51:50.249Z INFO 11484 --- [tomcat-shutdown] o.s.boot.tomcat.GracefulShutdown : Graceful shutdown complete ``` By default, `INFO` logging messages are shown, including some relevant startup details, such as the user that launched the application. If you need a log level other than `INFO`, you can set it, as described in [Log Levels](logging.html#features.logging.log-levels). The application version is determined using the implementation version from the main application class’s package. Startup information logging can be turned off by setting `spring.main.log-startup-info` to `false`. This will also turn off logging of the application’s active profiles. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | To add additional logging during startup, you can override `logStartupInfo(boolean)` in a subclass of [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html). | ## [](#features.spring-application.startup-failure)Startup Failure If your application fails to start, registered [`FailureAnalyzer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/diagnostics/FailureAnalyzer.html) beans get a chance to provide a dedicated error message and a concrete action to fix the problem. For instance, if you start a web application on port `8080` and that port is already in use, you should see something similar to the following message: ```none *************************** APPLICATION FAILED TO START *************************** Description: Embedded servlet container failed to start. Port 8080 was already in use. Action: Identify and stop the process that is listening on port 8080 or configure this application to listen on another port. ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Spring Boot provides numerous [`FailureAnalyzer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/diagnostics/FailureAnalyzer.html) implementations, and you can [add your own](../../how-to/application.html#howto.application.failure-analyzer). | If no failure analyzers are able to handle the exception, you can still display the full conditions report to better understand what went wrong. To do so, you need to [enable the `debug` property](external-config.html) or [enable `DEBUG` logging](logging.html#features.logging.log-levels) for [`ConditionEvaluationReportLoggingListener`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/logging/ConditionEvaluationReportLoggingListener.html). For instance, if you are running your application by using `java -jar`, you can enable the `debug` property as follows: ```shell $ java -jar myproject-0.0.1-SNAPSHOT.jar --debug ``` ## [](#features.spring-application.lazy-initialization)Lazy Initialization [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) allows an application to be initialized lazily. When lazy initialization is enabled, beans are created as they are needed rather than during application startup. As a result, enabling lazy initialization can reduce the time that it takes your application to start. In a web application, enabling lazy initialization will result in many web-related beans not being initialized until an HTTP request is received. A downside of lazy initialization is that it can delay the discovery of a problem with the application. If a misconfigured bean is initialized lazily, a failure will no longer occur during startup and the problem will only become apparent when the bean is initialized. Care must also be taken to ensure that the JVM has sufficient memory to accommodate all of the application’s beans and not just those that are initialized during startup. For these reasons, lazy initialization is not enabled by default and it is recommended that fine-tuning of the JVM’s heap size is done before enabling lazy initialization. Lazy initialization can be enabled programmatically using the `lazyInitialization` method on [`SpringApplicationBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/builder/SpringApplicationBuilder.html) or the `setLazyInitialization` method on [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html). Alternatively, it can be enabled using the `spring.main.lazy-initialization` property as shown in the following example: * Properties * YAML ```properties spring.main.lazy-initialization=true ``` ```yaml spring: main: lazy-initialization: true ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you want to disable lazy initialization for certain beans while using lazy initialization for the rest of the application, you can explicitly set their lazy attribute to false using the `@Lazy(false)` annotation. | ## [](#features.spring-application.banner)Customizing the Banner The banner that is printed on start up can be changed by adding a `banner.txt` file to your classpath or by setting the `spring.banner.location` property to the location of such a file. If the file has an encoding other than UTF-8, you can set `spring.banner.charset`. Inside your `banner.txt` file, you can use any key available in the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) as well as any of the following placeholders: | Variable | Description | | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `${application.version}` | The version number of your application, as declared in `MANIFEST.MF`. For example, `Implementation-Version: 1.0` is printed as `1.0`. | | `${application.formatted-version}` | The version number of your application, as declared in `MANIFEST.MF` and formatted for display (surrounded with brackets and prefixed with `v`). For example `(v1.0)`. | | `${spring-boot.version}` | The Spring Boot version that you are using. For example `4.1.1`. | | `${spring-boot.formatted-version}` | The Spring Boot version that you are using, formatted for display (surrounded with brackets and prefixed with `v`). For example `(v4.1.1)`. | | `${Ansi.NAME}` (or `${AnsiColor.NAME}`, `${AnsiBackground.NAME}`, `${AnsiStyle.NAME}`) | Where `NAME` is the name of an ANSI escape code. See [`AnsiPropertySource`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ansi/AnsiPropertySource.html) for details. | | `${application.title}` | The title of your application, as declared in `MANIFEST.MF`. For example `Implementation-Title: MyApp` is printed as `MyApp`. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The `SpringApplication.setBanner(…​)` method can be used if you want to generate a banner programmatically. Use the [`Banner`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/Banner.html) interface and implement your own `printBanner()` method. | You can also use the `spring.main.banner-mode` property to determine if the banner has to be printed on [`System.out`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/System.html#out) (`console`), sent to the configured logger (`log`), or not produced at all (`off`). The printed banner is registered as a singleton bean under the following name: `springBootBanner`. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The `application.title`, `application.version`, and `application.formatted-version` properties are only available if you are using `java -jar` or `java -cp` with Spring Boot launchers. The values will not be resolved if you are running an unpacked jar and starting it with `java -cp ` or running your application as a native image.To use the `application.*` properties, launch your application as a packed jar using `java -jar` or as an unpacked jar using `java org.springframework.boot.loader.launch.JarLauncher`. This will initialize the `application.*` banner properties before building the classpath and launching your app. | ## [](#features.spring-application.customizing-spring-application)Customizing SpringApplication If the [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) defaults are not to your taste, you can instead create a local instance and customize it. For example, to turn off the banner, you could write: * Java * Kotlin ```java import org.springframework.boot.Banner; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class MyApplication { public static void main(String[] args) { SpringApplication application = new SpringApplication(MyApplication.class); application.setBannerMode(Banner.Mode.OFF); application.run(args); } } ``` ```kotlin import org.springframework.boot.Banner import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.runApplication @SpringBootApplication class MyApplication fun main(args: Array) { runApplication(*args) { setBannerMode(Banner.Mode.OFF) } } ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | The constructor arguments passed to [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) are configuration sources for Spring beans. In most cases, these are references to [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) classes, but they could also be direct references [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) classes. | It is also possible to configure the [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) by using an `application.properties` file. See [Externalized Configuration](external-config.html) for details. For a complete list of the configuration options, see the [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) API documentation. ## [](#features.spring-application.fluent-builder-api)Fluent Builder API If you need to build an [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) hierarchy (multiple contexts with a parent/child relationship) or if you prefer using a fluent builder API, you can use the [`SpringApplicationBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/builder/SpringApplicationBuilder.html). The [`SpringApplicationBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/builder/SpringApplicationBuilder.html) lets you chain together multiple method calls and includes `parent` and `child` methods that let you create a hierarchy, as shown in the following example: * Java * Kotlin ```java new SpringApplicationBuilder().sources(Parent.class) .child(Application.class) .bannerMode(Banner.Mode.OFF) .run(args); ``` ```kotlin SpringApplicationBuilder() .sources(Parent::class.java) .child(Application::class.java) .bannerMode(Banner.Mode.OFF) .run(*args) ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | There are some restrictions when creating an [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) hierarchy. For example, Web components **must** be contained within the child context, and the same [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) is used for both parent and child contexts. See the [`SpringApplicationBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/builder/SpringApplicationBuilder.html) API documentation for full details. | ## [](#features.spring-application.application-availability)Application Availability When deployed on platforms, applications can provide information about their availability to the platform using infrastructure such as [Kubernetes Probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/). Spring Boot includes out-of-the box support for the commonly used “liveness” and “readiness” availability states. If you are using Spring Boot’s “actuator” support then these states are exposed as health endpoint groups. In addition, you can also obtain availability states by injecting the [`ApplicationAvailability`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/availability/ApplicationAvailability.html) interface into your own beans. ### [](#features.spring-application.application-availability.liveness)Liveness State The “Liveness” state of an application tells whether its internal state allows it to work correctly, or recover by itself if it is currently failing. A broken “Liveness” state means that the application is in a state that it cannot recover from, and the infrastructure should restart the application. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | In general, the "Liveness" state should not be based on external checks, such as [health checks](../actuator/endpoints.html#actuator.endpoints.health). If it did, a failing external system (a database, a Web API, an external cache) would trigger massive restarts and cascading failures across the platform. | The internal state of Spring Boot applications is mostly represented by the Spring [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html). If the application context has started successfully, Spring Boot assumes that the application is in a valid state. An application is considered live as soon as the context has been refreshed, see [Spring Boot application lifecycle and related Application Events](#features.spring-application.application-events-and-listeners). ### [](#features.spring-application.application-availability.readiness)Readiness State The “Readiness” state of an application tells whether the application is ready to handle traffic. A failing “Readiness” state tells the platform that it should not route traffic to the application for now. This typically happens during startup, while [`CommandLineRunner`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/CommandLineRunner.html) and [`ApplicationRunner`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ApplicationRunner.html) components are being processed, or at any time if the application decides that it is too busy for additional traffic. An application is considered ready as soon as application and command-line runners have been called, see [Spring Boot application lifecycle and related Application Events](#features.spring-application.application-events-and-listeners). | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Tasks expected to run during startup should be executed by [`CommandLineRunner`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/CommandLineRunner.html) and [`ApplicationRunner`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ApplicationRunner.html) components instead of using Spring component lifecycle callbacks such as [`@PostConstruct`](https://jakarta.ee/specifications/annotations/3.0/apidocs/jakarta/annotation/PostConstruct.html). | ### [](#features.spring-application.application-availability.managing)Managing the Application Availability State Application components can retrieve the current availability state at any time, by injecting the [`ApplicationAvailability`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/availability/ApplicationAvailability.html) interface and calling methods on it. More often, applications will want to listen to state updates or update the state of the application. For example, we can export the "Readiness" state of the application to a file so that a Kubernetes "exec Probe" can look at this file: * Java * Kotlin ```java import org.springframework.boot.availability.AvailabilityChangeEvent; import org.springframework.boot.availability.ReadinessState; import org.springframework.context.event.EventListener; import org.springframework.stereotype.Component; @Component public class MyReadinessStateExporter { @EventListener public void onStateChange(AvailabilityChangeEvent event) { switch (event.getState()) { case ACCEPTING_TRAFFIC -> { // create file /tmp/healthy } case REFUSING_TRAFFIC -> { // remove file /tmp/healthy } } } } ``` ```kotlin import org.springframework.boot.availability.AvailabilityChangeEvent import org.springframework.boot.availability.ReadinessState import org.springframework.context.event.EventListener import org.springframework.stereotype.Component @Component class MyReadinessStateExporter { @EventListener fun onStateChange(event: AvailabilityChangeEvent) { when (event.state) { ReadinessState.ACCEPTING_TRAFFIC -> { // create file /tmp/healthy } ReadinessState.REFUSING_TRAFFIC -> { // remove file /tmp/healthy } } } } ``` We can also update the state of the application, when the application breaks and cannot recover: * Java * Kotlin ```java import org.springframework.boot.availability.AvailabilityChangeEvent; import org.springframework.boot.availability.LivenessState; import org.springframework.context.ApplicationEventPublisher; import org.springframework.stereotype.Component; @Component public class MyLocalCacheVerifier { private final ApplicationEventPublisher eventPublisher; public MyLocalCacheVerifier(ApplicationEventPublisher eventPublisher) { this.eventPublisher = eventPublisher; } public void checkLocalCache() { try { // ... } catch (CacheCompletelyBrokenException ex) { AvailabilityChangeEvent.publish(this.eventPublisher, ex, LivenessState.BROKEN); } } } ``` ```kotlin import org.springframework.boot.availability.AvailabilityChangeEvent import org.springframework.boot.availability.LivenessState import org.springframework.context.ApplicationEventPublisher import org.springframework.stereotype.Component @Component class MyLocalCacheVerifier(private val eventPublisher: ApplicationEventPublisher) { fun checkLocalCache() { try { // ... } catch (ex: CacheCompletelyBrokenException) { AvailabilityChangeEvent.publish(eventPublisher, ex, LivenessState.BROKEN) } } } ``` Spring Boot provides [Kubernetes HTTP probes for "Liveness" and "Readiness" with Actuator Health Endpoints](../actuator/endpoints.html#actuator.endpoints.kubernetes-probes). You can get more guidance about [deploying Spring Boot applications on Kubernetes in the dedicated section](../../how-to/deployment/cloud.html#howto.deployment.cloud.kubernetes). ## [](#features.spring-application.application-events-and-listeners)Application Events and Listeners In addition to the usual Spring Framework events, such as [`ContextRefreshedEvent`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/event/ContextRefreshedEvent.html), a [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) sends some additional application events. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Some events are actually triggered before the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) is created, so you cannot register a listener on those as a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html). You can register them with the `SpringApplication.addListeners(…​)` method or the `SpringApplicationBuilder.listeners(…​)` method.If you want those listeners to be registered automatically, regardless of the way the application is created, you can add a `META-INF/spring.factories` file to your project and reference your listener(s) by using the [`ApplicationListener`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationListener.html) key, as shown in the following example:```none org.springframework.context.ApplicationListener=com.example.project.MyListener ``` | Application events are sent in the following order, as your application runs: 1. An [`ApplicationStartingEvent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/event/ApplicationStartingEvent.html) is sent at the start of a run but before any processing, except for the registration of listeners and initializers. 2. An [`ApplicationEnvironmentPreparedEvent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/event/ApplicationEnvironmentPreparedEvent.html) is sent when the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) to be used in the context is known but before the context is created. 3. An [`ApplicationContextInitializedEvent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/event/ApplicationContextInitializedEvent.html) is sent when the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) is prepared and ApplicationContextInitializers have been called but before any bean definitions are loaded. 4. An [`ApplicationPreparedEvent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/event/ApplicationPreparedEvent.html) is sent just before the refresh is started but after bean definitions have been loaded. 5. An [`ApplicationStartedEvent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/event/ApplicationStartedEvent.html) is sent after the context has been refreshed but before any application and command-line runners have been called. 6. An [`AvailabilityChangeEvent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/availability/AvailabilityChangeEvent.html) is sent right after with [`LivenessState.CORRECT`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/availability/LivenessState.html#CORRECT) to indicate that the application is considered as live. 7. An [`ApplicationReadyEvent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/event/ApplicationReadyEvent.html) is sent after any [application and command-line runners](#features.spring-application.command-line-runner) have been called. 8. An [`AvailabilityChangeEvent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/availability/AvailabilityChangeEvent.html) is sent right after with [`ReadinessState.ACCEPTING_TRAFFIC`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/availability/ReadinessState.html#ACCEPTING_TRAFFIC) to indicate that the application is ready to service requests. 9. An [`ApplicationFailedEvent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/event/ApplicationFailedEvent.html) is sent if there is an exception on startup. The above list only includes `SpringApplicationEvent`s that are tied to a [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html). In addition to these, the following events are also published after [`ApplicationPreparedEvent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/event/ApplicationPreparedEvent.html) and before [`ApplicationStartedEvent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/event/ApplicationStartedEvent.html): * A [`WebServerInitializedEvent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/context/WebServerInitializedEvent.html) is sent after the [`WebServer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/WebServer.html) is ready. [`ServletWebServerInitializedEvent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/servlet/context/ServletWebServerInitializedEvent.html) and [`ReactiveWebServerInitializedEvent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/reactive/context/ReactiveWebServerInitializedEvent.html) are the servlet and reactive variants respectively. * A [`ContextRefreshedEvent`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/event/ContextRefreshedEvent.html) is sent when an [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) is refreshed. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You often need not use application events, but it can be handy to know that they exist. Internally, Spring Boot uses events to handle a variety of tasks. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Event listeners should not run potentially lengthy tasks as they execute in the same thread by default. Consider using [application and command-line runners](#features.spring-application.command-line-runner) instead. | Application events are sent by using Spring Framework’s event publishing mechanism. Part of this mechanism ensures that an event published to the listeners in a child context is also published to the listeners in any ancestor contexts. As a result of this, if your application uses a hierarchy of [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) instances, a listener may receive multiple instances of the same type of application event. To allow your listener to distinguish between an event for its context and an event for a descendant context, it should request that its application context is injected and then compare the injected context with the context of the event. The context can be injected by implementing [`ApplicationContextAware`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContextAware.html) or, if the listener is a bean, by using [`@Autowired`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Autowired.html). ## [](#features.spring-application.web-environment)Web Environment A [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) attempts to create the right type of [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) on your behalf. The algorithm used to determine a [`WebApplicationType`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/WebApplicationType.html) is the following: * If Spring MVC is present, an [`AnnotationConfigServletWebServerApplicationContext`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/servlet/context/AnnotationConfigServletWebServerApplicationContext.html) is used * If Spring MVC is not present and Spring WebFlux is present, an [`AnnotationConfigReactiveWebServerApplicationContext`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/reactive/context/AnnotationConfigReactiveWebServerApplicationContext.html) is used * Otherwise, [`AnnotationConfigApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/AnnotationConfigApplicationContext.html) is used This means that if you are using Spring MVC and the new [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html) from Spring WebFlux in the same application, Spring MVC will be used by default. You can override that easily by calling `setWebApplicationType(WebApplicationType)`. It is also possible to take complete control of the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) type that is used by calling `setApplicationContextFactory(…​)`. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | It is often desirable to call `setWebApplicationType(WebApplicationType.NONE)` when using [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) within a JUnit test. | ## [](#features.spring-application.application-arguments)Accessing Application Arguments If you need to access the application arguments that were passed to `SpringApplication.run(…​)`, you can inject a [`ApplicationArguments`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ApplicationArguments.html) bean. The [`ApplicationArguments`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ApplicationArguments.html) interface provides access to both the raw `String[]` arguments as well as parsed `option` and `non-option` arguments, as shown in the following example: * Java * Kotlin ```java import java.util.List; import org.springframework.boot.ApplicationArguments; import org.springframework.stereotype.Component; @Component public class MyBean { public MyBean(ApplicationArguments args) { boolean debug = args.containsOption("debug"); List files = args.getNonOptionArgs(); if (debug) { System.out.println(files); } // if run with "--debug logfile.txt" prints ["logfile.txt"] } } ``` ```kotlin import org.springframework.boot.ApplicationArguments import org.springframework.stereotype.Component @Component class MyBean(args: ApplicationArguments) { init { val debug = args.containsOption("debug") val files = args.nonOptionArgs if (debug) { println(files) } // if run with "--debug logfile.txt" prints ["logfile.txt"] } } ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Spring Boot also registers a [`CommandLinePropertySource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/CommandLinePropertySource.html) with the Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html). This lets you also inject single application arguments by using the [`@Value`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Value.html) annotation. | ## [](#features.spring-application.command-line-runner)Using the ApplicationRunner or CommandLineRunner If you need to run some specific code once the [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) has started, you can implement the [`ApplicationRunner`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ApplicationRunner.html) or [`CommandLineRunner`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/CommandLineRunner.html) interfaces. Both interfaces work in the same way and offer a single `run` method, which is called just before `SpringApplication.run(…​)` completes. | | | | -- | ------------------------------------------------------------------------------------------------------------------------ | | ** | This contract is well suited for tasks that should run after application startup but before it starts accepting traffic. | The [`CommandLineRunner`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/CommandLineRunner.html) interfaces provides access to application arguments as a string array, whereas the [`ApplicationRunner`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ApplicationRunner.html) uses the [`ApplicationArguments`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ApplicationArguments.html) interface discussed earlier. The following example shows a [`CommandLineRunner`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/CommandLineRunner.html) with a `run` method: * Java * Kotlin ```java import org.springframework.boot.CommandLineRunner; import org.springframework.stereotype.Component; @Component public class MyCommandLineRunner implements CommandLineRunner { @Override public void run(String... args) { // Do something... } } ``` ```kotlin import org.springframework.boot.CommandLineRunner import org.springframework.stereotype.Component @Component class MyCommandLineRunner : CommandLineRunner { override fun run(vararg args: String) { // Do something... } } ``` If several [`CommandLineRunner`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/CommandLineRunner.html) or [`ApplicationRunner`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ApplicationRunner.html) beans are defined that must be called in a specific order, you can additionally implement the [`Ordered`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/Ordered.html) interface or use the [`Order`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/annotation/Order.html) annotation. ## [](#features.spring-application.application-exit)Application Exit Each [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) registers a shutdown hook with the JVM to ensure that the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) closes gracefully on exit. All the standard Spring lifecycle callbacks (such as the [`DisposableBean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/DisposableBean.html) interface or the [`@PreDestroy`](https://jakarta.ee/specifications/annotations/3.0/apidocs/jakarta/annotation/PreDestroy.html) annotation) can be used. In addition, beans may implement the [`ExitCodeGenerator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ExitCodeGenerator.html) interface if they wish to return a specific exit code when `SpringApplication.exit()` is called. This exit code can then be passed to `System.exit()` to return it as a status code, as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.ExitCodeGenerator; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.annotation.Bean; @SpringBootApplication public class MyApplication { @Bean public ExitCodeGenerator exitCodeGenerator() { return () -> 42; } public static void main(String[] args) { System.exit(SpringApplication.exit(SpringApplication.run(MyApplication.class, args))); } } ``` ```kotlin import org.springframework.boot.ExitCodeGenerator import org.springframework.boot.SpringApplication import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.runApplication import org.springframework.context.annotation.Bean import kotlin.system.exitProcess @SpringBootApplication class MyApplication { @Bean fun exitCodeGenerator() = ExitCodeGenerator { 42 } } fun main(args: Array) { exitProcess(SpringApplication.exit( runApplication(*args))) } ``` Also, the [`ExitCodeGenerator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ExitCodeGenerator.html) interface may be implemented by exceptions. When such an exception is encountered, Spring Boot returns the exit code provided by the implemented `getExitCode()` method. If there is more than one [`ExitCodeGenerator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ExitCodeGenerator.html), the first non-zero exit code that is generated is used. To control the order in which the generators are called, additionally implement the [`Ordered`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/Ordered.html) interface or use the [`Order`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/annotation/Order.html) annotation. ## [](#features.spring-application.admin)Admin Features It is possible to enable admin-related features for the application by specifying the `spring.application.admin.enabled` property. This exposes the [`SpringApplicationAdminMXBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/admin/SpringApplicationAdminMXBean.html) on the platform [`MBeanServer`](https://docs.oracle.com/en/java/javase/17/docs/api/java.management/javax/management/MBeanServer.html). You could use this feature to administer your Spring Boot application remotely. This feature could also be useful for any service wrapper implementation. | | | | -- | ---------------------------------------------------------------------------------------------------------------------- | | ** | If you want to know on which HTTP port the application is running, get the property with a key of `local.server.port`. | ## [](#features.spring-application.startup-tracking)Application Startup tracking During the application startup, the [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) and the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) perform many tasks related to the application lifecycle, the beans lifecycle or even processing application events. With [`ApplicationStartup`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/metrics/ApplicationStartup.html), Spring Framework [allows you to track the application startup sequence with ](https://docs.spring.io/spring-framework/reference/7.0/core/beans/context-introduction.html#context-functionality-startup)[`StartupStep`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/metrics/StartupStep.html) objects. This data can be collected for profiling purposes, or just to have a better understanding of an application startup process. You can choose an [`ApplicationStartup`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/metrics/ApplicationStartup.html) implementation when setting up the [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) instance. For example, to use the [`BufferingApplicationStartup`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/metrics/buffering/BufferingApplicationStartup.html), you could write: * Java * Kotlin ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.context.metrics.buffering.BufferingApplicationStartup; @SpringBootApplication public class MyApplication { public static void main(String[] args) { SpringApplication application = new SpringApplication(MyApplication.class); application.setApplicationStartup(new BufferingApplicationStartup(2048)); application.run(args); } } ``` ```kotlin import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.context.metrics.buffering.BufferingApplicationStartup import org.springframework.boot.runApplication @SpringBootApplication class MyApplication fun main(args: Array) { runApplication(*args) { applicationStartup = BufferingApplicationStartup(2048) } } ``` The first available implementation, [`FlightRecorderApplicationStartup`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/metrics/jfr/FlightRecorderApplicationStartup.html) is provided by Spring Framework. It adds Spring-specific startup events to a Java Flight Recorder session and is meant for profiling applications and correlating their Spring context lifecycle with JVM events (such as allocations, GCs, class loading…​). Once configured, you can record data by running the application with the Flight Recorder enabled: ```shell $ java -XX:StartFlightRecording:filename=recording.jfr,duration=10s -jar demo.jar ``` Spring Boot ships with the [`BufferingApplicationStartup`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/metrics/buffering/BufferingApplicationStartup.html) variant; this implementation is meant for buffering the startup steps and draining them into an external metrics system. Applications can ask for the bean of type [`BufferingApplicationStartup`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/metrics/buffering/BufferingApplicationStartup.html) in any component. Spring Boot can also be configured to expose a [`startup` endpoint](../../api/rest/actuator/startup.html) that provides this information as a JSON document. ## [](#features.spring-application.virtual-threads)Virtual threads Virtual threads require Java 21 or later. For the best experience, Java 24 or later is strongly recommended. To enable virtual threads, set the `spring.threads.virtual.enabled` property to `true`. Before turning on this option for your application, you should consider [reading the official Java virtual threads documentation](https://docs.oracle.com/en/java/javase/24/core/virtual-threads.html). In some cases, applications can experience lower throughput because of "Pinned Virtual Threads"; this page also explains how to detect such cases with JDK Flight Recorder or the `jcmd` CLI. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | If virtual threads are enabled, properties which configure thread pools don’t have an effect anymore. That’s because virtual threads are scheduled on a JVM wide platform thread pool and not on dedicated thread pools. | | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | One side effect of virtual threads is that they are daemon threads. A JVM will exit if all of its threads are daemon threads. This behavior can be a problem when you rely on [`@Scheduled`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/annotation/Scheduled.html) beans, for example, to keep your application alive. If you use virtual threads, the scheduler thread is a virtual thread and therefore a daemon thread and won’t keep the JVM alive. This not only affects scheduling and can be the case with other technologies too. To keep the JVM running in all cases, it is recommended to set the property `spring.main.keep-alive` to `true`. This ensures that the JVM is kept alive, even if all threads are virtual threads. | * [Spring Boot](../../index.html) * [4.1.1](spring-application.html) * [4.0.8](../../4.0/reference/features/spring-application.html) * [3.5.16](../../3.5/reference/features/spring-application.html) * [3.4.13](../../3.4/reference/features/spring-application.html) * [3.3.13](../../3.3/reference/features/spring-application.html) - [4.2.0-M2](../../4.2/reference/features/spring-application.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/features/spring-application.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/features/spring-application.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/features/spring-application.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) * [Spring AI](https://docs.spring.io/spring-ai/reference/) * [Spring AMQP](https://docs.spring.io/spring-amqp/reference/) * [Spring CLI](https://docs.spring.io/spring-cli/reference/) * [Spring GraphQL](https://docs.spring.io/spring-graphql/reference/) * [Spring for Apache Kafka](https://docs.spring.io/spring-kafka/reference/) * [Spring Modulith](https://docs.spring.io/spring-modulith/reference/) * [Spring for Apache Pulsar](https://docs.spring.io/spring-pulsar/reference/) * [Spring Shell](https://docs.spring.io/spring-shell/reference/) [All Docs...](../../spring-projects.html) [Search in all Spring Docs](../../search.html) [](https://www.algolia.com/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/package-use.html ---- Uses of Package\ org.springframework.boot.maven ============================== * Classes in [org.springframework.boot.maven](package-summary.html) used by [org.springframework.boot.maven](package-summary.html) Class Description [AbstractAotMojo](class-use/AbstractAotMojo.html#org.springframework.boot.maven) Abstract base class for AOT processing MOJOs. [AbstractDependencyFilterMojo](class-use/AbstractDependencyFilterMojo.html#org.springframework.boot.maven) A base mojo filtering the dependencies of the project. [AbstractPackagerMojo](class-use/AbstractPackagerMojo.html#org.springframework.boot.maven) Abstract base class for classes that work with an `Packager`. [AbstractPackagerMojo.LayoutType](class-use/AbstractPackagerMojo.LayoutType.html#org.springframework.boot.maven) Archive layout types. [AbstractRunMojo](class-use/AbstractRunMojo.html#org.springframework.boot.maven) Base class to run a Spring Boot application. [BuildImageMojo](class-use/BuildImageMojo.html#org.springframework.boot.maven) Package an application into an OCI image using a buildpack. [CacheInfo.BindCacheInfo](class-use/CacheInfo.BindCacheInfo.html#org.springframework.boot.maven) Encapsulates configuration of an image building cache stored in a bind mount. [CacheInfo.VolumeCacheInfo](class-use/CacheInfo.VolumeCacheInfo.html#org.springframework.boot.maven) Encapsulates configuration of an image building cache stored in a volume. [DependencyFilter](class-use/DependencyFilter.html#org.springframework.boot.maven) Base class for `ArtifactsFilter` based on a [`FilterableDependency`](FilterableDependency.html "class in org.springframework.boot.maven") list. [Exclude](class-use/Exclude.html#org.springframework.boot.maven) A model for a dependency to exclude. [FilterableDependency](class-use/FilterableDependency.html#org.springframework.boot.maven) A model for a dependency to include or exclude. [Include](class-use/Include.html#org.springframework.boot.maven) A model for a dependency to include. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/BuildImageMojo.html ---- # Class BuildImageMojo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.plugin.AbstractMojo [org.springframework.boot.maven.AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") [org.springframework.boot.maven.AbstractPackagerMojo](AbstractPackagerMojo.html "class in org.springframework.boot.maven") org.springframework.boot.maven.BuildImageMojo * All Implemented Interfaces: `org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo` - Direct Known Subclasses: `BuildImageForkMojo, BuildImageNoForkMojo` *** public abstract class BuildImageMojo extends [AbstractPackagerMojo](AbstractPackagerMojo.html "class in org.springframework.boot.maven") Package an application into an OCI image using a buildpack. * Since: 2.3.0 * Author: Phillip Webb, Scott Frederick, Jeroen Meijer Modifier Constructor Description `protected` `BuildImageMojo(org.apache.maven.project.MavenProjectHelper projectHelper)` Return the type of archive that should be used when building the image. * ### BuildImageMojo protected BuildImageMojo​(org.apache.maven.project.MavenProjectHelper projectHelper) * ## Method Details * ### getLayout protected @Nullable [AbstractPackagerMojo.LayoutType](AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") getLayout() Return the type of archive that should be used when building the image. * Overrides: `getLayout` in class `AbstractPackagerMojo` * Returns: the value of the `layout` parameter, or `null` if the parameter is not provided * ### getLayoutFactory protected @Nullable org.springframework.boot.loader.tools.LayoutFactory getLayoutFactory() Return the layout factory that will be used to determine the [`AbstractPackagerMojo.LayoutType`](AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") if no explicit layout is set. * Overrides: `getLayoutFactory` in class `AbstractPackagerMojo` * Returns: the value of the `layoutFactory` parameter, or `null` if the parameter is not provided * ### execute public void execute() throws org.apache.maven.plugin.MojoExecutionException * Throws: `org.apache.maven.plugin.MojoExecutionException` ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/HelpMojo.html ---- # Class HelpMojo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.plugin.AbstractMojo org.springframework.boot.maven.HelpMojo * All Implemented Interfaces: `org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo` *** public class HelpMojo extends org.apache.maven.plugin.AbstractMojo Display help information on spring-boot-maven-plugin.\ Call `mvn spring-boot:help -Ddetail=true -Dgoal=` to display parameter details. * Author: maven-plugin-tools `HelpMojo()`   - ## Method Summary Modifier and Type Method Description `void` `execute()` ### Methods inherited from class org.apache.maven.plugin.AbstractMojo `getLog, getPluginContext, setLog, setPluginContext` ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### HelpMojo public HelpMojo() * ## Method Details * ### execute public void execute() throws org.apache.maven.plugin.MojoExecutionException * Throws: `org.apache.maven.plugin.MojoExecutionException` ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/allclasses-index.html ---- # All Classes and Interfaces Class Description [AbstractAot](org/springframework/boot/gradle/tasks/aot/AbstractAot.html "class in org.springframework.boot.gradle.tasks.aot") Specialization of [`JavaExec`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") to be used as a base class for tasks that perform ahead-of-time processing. [BootArchive](org/springframework/boot/gradle/tasks/bundling/BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") A Spring Boot "fat" archive task. [BootBuildImage](org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") A [`Task`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") for bundling an application into an OCI image using a [buildpack](https://buildpacks.io). [BootJar](org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling") A custom [`Jar`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/Jar.html "class or interface in org.gradle.api.tasks.bundling") task that produces a Spring Boot executable jar. [BootRun](org/springframework/boot/gradle/tasks/run/BootRun.html "class in org.springframework.boot.gradle.tasks.run") Custom [`JavaExec`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") task for running a Spring Boot application. [BootWar](org/springframework/boot/gradle/tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling") A custom [`War`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/War.html "class or interface in org.gradle.api.tasks.bundling") task that produces a Spring Boot executable war. [BuildInfo](org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") [`Task`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") for generating a build info properties file from [`BuildInfoProperties`](org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo"). [BuildInfoProperties](org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") The properties that are written into the `META-INF/build-info.properties` file. [CacheSpec](org/springframework/boot/gradle/tasks/bundling/CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Configuration for an image building cache. [CacheSpec.BindCacheSpec](org/springframework/boot/gradle/tasks/bundling/CacheSpec.BindCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Configuration for an image building cache stored in a bind mount. [CacheSpec.VolumeCacheSpec](org/springframework/boot/gradle/tasks/bundling/CacheSpec.VolumeCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Configuration for an image building cache stored in a Docker volume. [DockerSpec](org/springframework/boot/gradle/tasks/bundling/DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Encapsulates Docker configuration options. [DockerSpec.DockerRegistrySpec](org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") Encapsulates Docker registry authentication configuration options. [LayeredSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Encapsulates the configuration for a layered archive. [LayeredSpec.ApplicationSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") An [`LayeredSpec.IntoLayersSpec`](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which application classes and resources belong. [LayeredSpec.DependenciesIntoLayerSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesIntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Spec that controls the dependencies that should be part of a particular layer. [LayeredSpec.DependenciesSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") An [`LayeredSpec.IntoLayersSpec`](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which dependencies belong. [LayeredSpec.IntoLayerSpec](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Spec that controls the content that should be part of a particular layer. [LayeredSpec.IntoLayersSpec\](org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Base class for specs that control the layers to which a category of content should belong. [ProcessAot](org/springframework/boot/gradle/tasks/aot/ProcessAot.html "class in org.springframework.boot.gradle.tasks.aot") Custom [`JavaExec`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") task for ahead-of-time processing of a Spring Boot application. [ProcessTestAot](org/springframework/boot/gradle/tasks/aot/ProcessTestAot.html "class in org.springframework.boot.gradle.tasks.aot") Custom [`JavaExec`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") task for ahead-of-time processing of a Spring Boot application's tests. [ResolveMainClassName](org/springframework/boot/gradle/plugin/ResolveMainClassName.html "class in org.springframework.boot.gradle.plugin") [`Task`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") for resolving the name of the application's main class. [SpringBootAotPlugin](org/springframework/boot/gradle/plugin/SpringBootAotPlugin.html "class in org.springframework.boot.gradle.plugin") Gradle plugin for Spring Boot AOT. [SpringBootExtension](org/springframework/boot/gradle/dsl/SpringBootExtension.html "class in org.springframework.boot.gradle.dsl") Entry point to Spring Boot's Gradle DSL. [SpringBootPlugin](org/springframework/boot/gradle/plugin/SpringBootPlugin.html "class in org.springframework.boot.gradle.plugin") Gradle plugin for Spring Boot. [VersionExtractor](org/springframework/boot/gradle/util/VersionExtractor.html "class in org.springframework.boot.gradle.util") Extracts version information for a Class. [ZipCompression](org/springframework/boot/gradle/tasks/bundling/ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") An enumeration of supported compression options for an entry in a ZIP archive. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-16.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## R * [RepackageMojo](../org/springframework/boot/maven/RepackageMojo.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Repackage existing JAR and WAR archives so that they can be executed from the command line using java -jar. * [RepackageMojo(MavenProjectHelper)](../org/springframework/boot/maven/RepackageMojo.html#%3Cinit%3E\(org.apache.maven.project.MavenProjectHelper\)) - Constructor for class org.springframework.boot.maven.[RepackageMojo](../org/springframework/boot/maven/RepackageMojo.html "class in org.springframework.boot.maven")   * [report(Diagnostic)](../org/springframework/boot/maven/AbstractAotMojo.Errors.html#report\(javax.tools.Diagnostic\)) - Method in class org.springframework.boot.maven.[AbstractAotMojo.Errors](../org/springframework/boot/maven/AbstractAotMojo.Errors.html "class in org.springframework.boot.maven")   * [resolveApplicationArguments()](../org/springframework/boot/maven/AbstractRunMojo.html#resolveApplicationArguments\(\)) - Method in class org.springframework.boot.maven.[AbstractRunMojo](../org/springframework/boot/maven/AbstractRunMojo.html "class in org.springframework.boot.maven") Resolve the application arguments to use. * [resolveApplicationArguments()](../org/springframework/boot/maven/StartMojo.html#resolveApplicationArguments\(\)) - Method in class org.springframework.boot.maven.[StartMojo](../org/springframework/boot/maven/StartMojo.html "class in org.springframework.boot.maven")   * [resolveEnvVariables()](../org/springframework/boot/maven/AbstractRunMojo.html#resolveEnvVariables\(\)) - Method in class org.springframework.boot.maven.[AbstractRunMojo](../org/springframework/boot/maven/AbstractRunMojo.html "class in org.springframework.boot.maven") Resolve the environment variables to use. * [resolveJvmArguments()](../org/springframework/boot/maven/AbstractRunMojo.html#resolveJvmArguments\(\)) - Method in class org.springframework.boot.maven.[AbstractRunMojo](../org/springframework/boot/maven/AbstractRunMojo.html "class in org.springframework.boot.maven") Resolve the JVM arguments to use. * [resolveJvmArguments()](../org/springframework/boot/maven/RunMojo.html#resolveJvmArguments\(\)) - Method in class org.springframework.boot.maven.[RunMojo](../org/springframework/boot/maven/RunMojo.html "class in org.springframework.boot.maven")   * [resolveJvmArguments()](../org/springframework/boot/maven/StartMojo.html#resolveJvmArguments\(\)) - Method in class org.springframework.boot.maven.[StartMojo](../org/springframework/boot/maven/StartMojo.html "class in org.springframework.boot.maven")   * [resolveJvmArguments()](../org/springframework/boot/maven/TestRunMojo.html#resolveJvmArguments\(\)) - Method in class org.springframework.boot.maven.[TestRunMojo](../org/springframework/boot/maven/TestRunMojo.html "class in org.springframework.boot.maven")   * [run(JavaProcessExecutor, File, List, Map)](../org/springframework/boot/maven/AbstractRunMojo.html#run\(org.springframework.boot.maven.JavaProcessExecutor,java.io.File,java.util.List,java.util.Map\)) - Method in class org.springframework.boot.maven.[AbstractRunMojo](../org/springframework/boot/maven/AbstractRunMojo.html "class in org.springframework.boot.maven") Run the application. * [run(JavaProcessExecutor, File, List, Map)](../org/springframework/boot/maven/RunMojo.html#run\(org.springframework.boot.maven.JavaProcessExecutor,java.io.File,java.util.List,java.util.Map\)) - Method in class org.springframework.boot.maven.[RunMojo](../org/springframework/boot/maven/RunMojo.html "class in org.springframework.boot.maven")   * [run(JavaProcessExecutor, File, List, Map)](../org/springframework/boot/maven/StartMojo.html#run\(org.springframework.boot.maven.JavaProcessExecutor,java.io.File,java.util.List,java.util.Map\)) - Method in class org.springframework.boot.maven.[StartMojo](../org/springframework/boot/maven/StartMojo.html "class in org.springframework.boot.maven")   * [run(JavaProcessExecutor, File, List, Map)](../org/springframework/boot/maven/TestRunMojo.html#run\(org.springframework.boot.maven.JavaProcessExecutor,java.io.File,java.util.List,java.util.Map\)) - Method in class org.springframework.boot.maven.[TestRunMojo](../org/springframework/boot/maven/TestRunMojo.html "class in org.springframework.boot.maven")   * [RunMojo](../org/springframework/boot/maven/RunMojo.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Run an application in place. * [RunMojo(ToolchainManager)](../org/springframework/boot/maven/RunMojo.html#%3Cinit%3E\(org.apache.maven.toolchain.ToolchainManager\)) - Constructor for class org.springframework.boot.maven.[RunMojo](../org/springframework/boot/maven/RunMojo.html "class in org.springframework.boot.maven")   [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/AbstractDependencyFilterMojo.html ---- Uses of Class\ org.springframework.boot.maven.AbstractDependencyFilterMojo =========================================================== * ## Uses of [AbstractDependencyFilterMojo](../AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Subclasses of [AbstractDependencyFilterMojo](../AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Modifier and Type Class Description `class ` `AbstractAotMojo` Abstract base class for AOT processing MOJOs. `class ` `AbstractPackagerMojo` Abstract base class for classes that work with an `Packager`. `class ` `AbstractRunMojo` Base class to run a Spring Boot application. `ProcessAotMojo` Invoke the AOT engine on the application. `class ` `ProcessTestAotMojo` Invoke the AOT engine on tests. `class ` `RepackageMojo` Repackage existing JAR and WAR archives so that they can be executed from the command line using java -jar. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/HelpMojo.html ---- Uses of Class\ org.springframework.boot.maven.HelpMojo ======================================= No usage of org.springframework.boot.maven.HelpMojo ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/package-tree.html ---- # Hierarchy For Package org.springframework.boot.maven ## Class Hierarchy * java.lang.[Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") * org.springframework.boot.maven.[AbstractAotMojo.Errors](AbstractAotMojo.Errors.html "class in org.springframework.boot.maven") (implements javax.tools.[DiagnosticListener](https://docs.oracle.com/en/java/javase/17/docs/api/java.compiler/javax/tools/DiagnosticListener.html "class or interface in javax.tools")\) * org.apache.maven.shared.artifact.filter.collection.AbstractArtifactsFilter (implements org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter) * org.apache.maven.shared.artifact.filter.collection.AbstractArtifactFeatureFilter * org.springframework.boot.maven.[AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter](AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[MatchingGroupIdFilter](MatchingGroupIdFilter.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[DependencyFilter](DependencyFilter.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[ExcludeFilter](ExcludeFilter.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[IncludeFilter](IncludeFilter.html "class in org.springframework.boot.maven") * org.apache.maven.plugin.AbstractMojo (implements org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo) * org.springframework.boot.maven.[AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[AbstractAotMojo](AbstractAotMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[ProcessAotMojo](ProcessAotMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[ProcessTestAotMojo](ProcessTestAotMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[AbstractPackagerMojo](AbstractPackagerMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[BuildImageMojo](BuildImageMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[BuildImageForkMojo](BuildImageForkMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[BuildImageNoForkMojo](BuildImageNoForkMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[RepackageMojo](RepackageMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[AbstractRunMojo](AbstractRunMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[RunMojo](RunMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[StartMojo](StartMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[TestRunMojo](TestRunMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[BuildInfoMojo](BuildInfoMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[HelpMojo](HelpMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[StopMojo](StopMojo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[ArtifactsLibraries](ArtifactsLibraries.html "class in org.springframework.boot.maven") (implements org.springframework.boot.loader.tools.Libraries) * org.springframework.boot.maven.[CacheInfo](CacheInfo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[CacheInfo.BindCacheInfo](CacheInfo.BindCacheInfo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[CacheInfo.VolumeCacheInfo](CacheInfo.VolumeCacheInfo.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[Docker](Docker.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[Docker.DockerRegistry](Docker.DockerRegistry.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[FilterableDependency](FilterableDependency.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[Exclude](Exclude.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[Include](Include.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[Image](Image.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[Layers](Layers.html "class in org.springframework.boot.maven") * org.springframework.boot.maven.[PropertiesMergingResourceTransformer](PropertiesMergingResourceTransformer.html "class in org.springframework.boot.maven") (implements org.apache.maven.plugins.shade.resource.ReproducibleResourceTransformer) ## Enum Class Hierarchy * java.lang.[Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") * java.lang.[Enum](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html "class or interface in java.lang")\ (implements java.lang.[Comparable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html "class or interface in java.lang")\, java.lang.constant.[Constable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html "class or interface in java.lang.constant"), java.io.[Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io")) * org.springframework.boot.maven.[AbstractPackagerMojo.LayoutType](AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/dsl/package-tree.html ---- # Hierarchy For Package org.springframework.boot.gradle.dsl Package Hierarchies: * [All Packages](../../../../../overview-tree.html) ## Class Hierarchy * java.lang.[Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") * org.springframework.boot.gradle.dsl.[SpringBootExtension](SpringBootExtension.html "class in org.springframework.boot.gradle.dsl") ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/index-files/index-14.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ## T * [TEST\_AND\_DEVELOPMENT\_ONLY\_CONFIGURATION\_NAME](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html#TEST_AND_DEVELOPMENT_ONLY_CONFIGURATION_NAME) - Static variable in class org.springframework.boot.gradle.plugin.[SpringBootPlugin](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html "class in org.springframework.boot.gradle.plugin") The name of the `testAndDevelopmentOnly` configuration. [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-6.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## F * [filter(Set)](../org/springframework/boot/maven/DependencyFilter.html#filter\(java.util.Set\)) - Method in class org.springframework.boot.maven.[DependencyFilter](../org/springframework/boot/maven/DependencyFilter.html "class in org.springframework.boot.maven")   * [filter(Artifact)](../org/springframework/boot/maven/DependencyFilter.html#filter\(org.apache.maven.artifact.Artifact\)) - Method in class org.springframework.boot.maven.[DependencyFilter](../org/springframework/boot/maven/DependencyFilter.html "class in org.springframework.boot.maven")   * [filter(Artifact)](../org/springframework/boot/maven/ExcludeFilter.html#filter\(org.apache.maven.artifact.Artifact\)) - Method in class org.springframework.boot.maven.[ExcludeFilter](../org/springframework/boot/maven/ExcludeFilter.html "class in org.springframework.boot.maven")   * [filter(Artifact)](../org/springframework/boot/maven/IncludeFilter.html#filter\(org.apache.maven.artifact.Artifact\)) - Method in class org.springframework.boot.maven.[IncludeFilter](../org/springframework/boot/maven/IncludeFilter.html "class in org.springframework.boot.maven")   * [FilterableDependency](../org/springframework/boot/maven/FilterableDependency.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) A model for a dependency to include or exclude. * [FilterableDependency()](../org/springframework/boot/maven/FilterableDependency.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.maven.[FilterableDependency](../org/springframework/boot/maven/FilterableDependency.html "class in org.springframework.boot.maven")   * [filterDependencies(Set, ArtifactsFilter...)](../org/springframework/boot/maven/AbstractDependencyFilterMojo.html#filterDependencies\(java.util.Set,org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter...\)) - Method in class org.springframework.boot.maven.[AbstractDependencyFilterMojo](../org/springframework/boot/maven/AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven")   [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/class-use/CacheSpec.VolumeCacheSpec.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.bundling.CacheSpec.VolumeCacheSpec ======================================================================== Packages that use [CacheSpec.VolumeCacheSpec](../CacheSpec.VolumeCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Package Description [org.springframework.boot.gradle.tasks.bundling](#org.springframework.boot.gradle.tasks.bundling) Support for creating executable jars and wars. * ## Uses of [CacheSpec.VolumeCacheSpec](../CacheSpec.VolumeCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) Method parameters in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) with type arguments of type [CacheSpec.VolumeCacheSpec](../CacheSpec.VolumeCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Modifier and Type Method Description `void` CacheSpec.`volume(Action action)` Configures a volume cache using the given `action`. ---- url: https://docs.spring.io/spring-boot/reference/packaging/checkpoint-restore.html ---- # Checkpoint and Restore With the JVM [Coordinated Restore at Checkpoint](https://wiki.openjdk.org/display/crac/Main) (CRaC) is an OpenJDK project that defines a new Java API to allow you to checkpoint and restore an application on the HotSpot JVM. It is based on [CRIU](https://github.com/checkpoint-restore/criu), a project that implements checkpoint/restore functionality on Linux. The principle is the following: you start your application almost as usual but with a CRaC enabled version of the JDK like [BellSoft Liberica JDK with CRaC](https://bell-sw.com/pages/downloads/?package=jdk-crac) or [Azul Zulu JDK with CRaC](https://www.azul.com/downloads/?package=jdk-crac#zulu). Then at some point, potentially after some workloads that will warm up your JVM by executing all common code paths, you trigger a checkpoint using an API call, a `jcmd` command, an HTTP endpoint, or a different mechanism. A memory representation of the running JVM, including its warmness, is then serialized to disk, allowing a fast restoration at a later point, potentially on another machine with a similar operating system and CPU architecture. The restored process retains all the capabilities of the HotSpot JVM, including further JIT optimizations at runtime. Based on the foundations provided by Spring Framework, Spring Boot provides support for checkpointing and restoring your application, and manages out-of-the-box the lifecycle of resources such as socket, files and thread pools [on a limited scope](https://github.com/spring-projects/spring-lifecycle-smoke-tests/blob/ci/STATUS.adoc). Additional lifecycle management is expected for other dependencies and potentially for the application code dealing with such resources. You can find more details about the two modes supported ("on demand checkpoint/restore of a running application" and "automatic checkpoint/restore at startup"), how to enable checkpoint and restore support and some guidelines in [the Spring Framework JVM Checkpoint Restore support documentation](https://docs.spring.io/spring-framework/reference/7.0/integration/checkpoint-restore.html). * [Spring Boot](../../index.html) * [4.1.1](checkpoint-restore.html) * [4.0.8](../../4.0/reference/packaging/checkpoint-restore.html) * [3.5.16](../../3.5/reference/packaging/checkpoint-restore.html) * [3.4.13](../../3.4/reference/packaging/checkpoint-restore.html) * [3.3.13](../../3.3/reference/packaging/checkpoint-restore.html) - [4.2.0-M2](../../4.2/reference/packaging/checkpoint-restore.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/packaging/checkpoint-restore.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/packaging/checkpoint-restore.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/packaging/checkpoint-restore.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/actuator/monitoring.html ---- # Monitoring and Management Over HTTP If you are developing a web application, Spring Boot Actuator auto-configures all enabled endpoints to be exposed over HTTP. The default convention is to use the `id` of the endpoint with a prefix of `/actuator` as the URL path. For example, `health` is exposed as `/actuator/health`. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Actuator is supported natively with Spring MVC, Spring WebFlux, and Jersey. If both Jersey and Spring MVC are available, Spring MVC is used. | | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Jackson is a required dependency in order to get the correct JSON responses as documented in the [API documentation](../../api/rest/actuator/index.html). Jackson 3 should be used for Spring MVC and Spring WebFlux. Jersey does not yet have a Jackson 3 module, so you will need to use Jackson 2. | ## [](#actuator.monitoring.customizing-management-server-context-path)Customizing the Management Endpoint Paths Sometimes, it is useful to customize the prefix for the management endpoints. For example, your application might already use `/actuator` for another purpose. You can use the `management.endpoints.web.base-path` property to change the prefix for your management endpoint, as the following example shows: * Properties * YAML ```properties management.endpoints.web.base-path=/manage ``` ```yaml management: endpoints: web: base-path: "/manage" ``` The preceding `application.properties` example changes the endpoint from `/actuator/{id}` to `/manage/{id}` (for example, `/manage/info`). | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Unless the management port has been configured to [expose endpoints by using a different HTTP port](#actuator.monitoring.customizing-management-server-port), `management.endpoints.web.base-path` is relative to `server.servlet.context-path` (for servlet web applications) or `spring.webflux.base-path` (for reactive web applications). If `management.server.port` is configured, `management.endpoints.web.base-path` is relative to `management.server.base-path`. | If you want to map endpoints to a different path, you can use the `management.endpoints.web.path-mapping` property. The following example remaps `/actuator/health` to `/healthcheck`: * Properties * YAML ```properties management.endpoints.web.base-path=/ management.endpoints.web.path-mapping.health=healthcheck ``` ```yaml management: endpoints: web: base-path: "/" path-mapping: health: "healthcheck" ``` ## [](#actuator.monitoring.customizing-management-server-port)Customizing the Management Server Port Exposing management endpoints by using the default HTTP port is a sensible choice for cloud-based deployments. If, however, your application runs inside your own data center, you may prefer to expose endpoints by using a different HTTP port. You can set the `management.server.port` property to change the HTTP port, as the following example shows: * Properties * YAML ```properties management.server.port=8081 ``` ```yaml management: server: port: 8081 ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | On Cloud Foundry, by default, applications receive requests only on port 8080 for both HTTP and TCP routing. If you want to use a custom management port on Cloud Foundry, you need to explicitly set up the application’s routes to forward traffic to the custom port. | ## [](#actuator.monitoring.management-specific-ssl)Configuring Management-specific SSL When configured to use a custom port, you can also configure the management server with its own SSL by using the various `management.server.ssl.*` properties. For example, doing so lets a management server be available over HTTP while the main application uses HTTPS, as the following property settings show: * Properties * YAML ```properties server.port=8443 server.ssl.enabled=true server.ssl.key-store=classpath:store.jks server.ssl.key-password=secret management.server.port=8080 management.server.ssl.enabled=false ``` ```yaml server: port: 8443 ssl: enabled: true key-store: "classpath:store.jks" key-password: "secret" management: server: port: 8080 ssl: enabled: false ``` Alternatively, both the main server and the management server can use SSL but with different key stores, as follows: * Properties * YAML ```properties server.port=8443 server.ssl.enabled=true server.ssl.key-store=classpath:main.jks server.ssl.key-password=secret management.server.port=8080 management.server.ssl.enabled=true management.server.ssl.key-store=classpath:management.jks management.server.ssl.key-password=secret ``` ```yaml server: port: 8443 ssl: enabled: true key-store: "classpath:main.jks" key-password: "secret" management: server: port: 8080 ssl: enabled: true key-store: "classpath:management.jks" key-password: "secret" ``` ## [](#actuator.monitoring.customizing-management-server-address)Customizing the Management Server Address You can customize the address on which the management endpoints are available by setting the `management.server.address` property. Doing so can be useful if you want to listen only on an internal or ops-facing network or to listen only for connections from `localhost`. | | | | -- | ------------------------------------------------------------------------------------------- | | ** | You can listen on a different address only when the port differs from the main server port. | The following example `application.properties` does not allow remote management connections: * Properties * YAML ```properties management.server.port=8081 management.server.address=127.0.0.1 ``` ```yaml management: server: port: 8081 address: "127.0.0.1" ``` ## [](#actuator.monitoring.disabling-http-endpoints)Disabling HTTP Endpoints If you do not want to expose endpoints over HTTP, you can set the management port to `-1`, as the following example shows: * Properties * YAML ```properties management.server.port=-1 ``` ```yaml management: server: port: -1 ``` You can also achieve this by using the `management.endpoints.web.exposure.exclude` property, as the following example shows: * Properties * YAML ```properties management.endpoints.web.exposure.exclude=* ``` ```yaml management: endpoints: web: exposure: exclude: "*" ``` * [Spring Boot](../../index.html) * [4.1.1](monitoring.html) * [4.0.8](../../4.0/reference/actuator/monitoring.html) * [3.5.16](../../3.5/reference/actuator/monitoring.html) * [3.4.13](../../3.4/reference/actuator/monitoring.html) * [3.3.13](../../3.3/reference/actuator/monitoring.html) - [4.2.0-M2](../../4.2/reference/actuator/monitoring.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/actuator/monitoring.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/actuator/monitoring.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/actuator/monitoring.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesSpec.html ---- # Class LayeredSpec.DependenciesSpec [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") [org.springframework.boot.gradle.tasks.bundling.LayeredSpec.IntoLayersSpec](LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling")<[LayeredSpec.DependenciesIntoLayerSpec](LayeredSpec.DependenciesIntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling")> org.springframework.boot.gradle.tasks.bundling.LayeredSpec.DependenciesSpec * All Implemented Interfaces: `Serializable` - Enclosing class: `LayeredSpec` *** public static class LayeredSpec.DependenciesSpec extends [LayeredSpec.IntoLayersSpec](LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling")<[LayeredSpec.DependenciesIntoLayerSpec](LayeredSpec.DependenciesIntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling")> implements [Serializable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html "class or interface in java.io") An [`LayeredSpec.IntoLayersSpec`](LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which dependencies belong. * Since: 2.3.0 * Author: Madhura Bhave, Scott Frederick, Phillip Webb * See Also: * [Serialized Form](../../../../../../serialized-form.html#org.springframework.boot.gradle.tasks.bundling.LayeredSpec.DependenciesSpec) - ## Constructor Summary Constructors Constructor Description `DependenciesSpec()`   `DependenciesSpec(LayeredSpec.DependenciesIntoLayerSpec... contents)` Creates a new `DependenciesSpec` with the given `contents`. - ## Method Summary ### Methods inherited from class [LayeredSpec.IntoLayersSpec](LayeredSpec.IntoLayersSpec.html#method-summary "class in org.springframework.boot.gradle.tasks.bundling") `intoLayer, intoLayer` ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### DependenciesSpec @Inject public DependenciesSpec() * ### DependenciesSpec public DependenciesSpec​([LayeredSpec.DependenciesIntoLayerSpec](LayeredSpec.DependenciesIntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling")... contents) Creates a new `DependenciesSpec` with the given `contents`. * Parameters: `contents` - specs for the layers in which dependencies should be included ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/FilterableDependency.html ---- # Class FilterableDependency [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.maven.FilterableDependency * Direct Known Subclasses: `Exclude, Include` *** public abstract class FilterableDependency extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") A model for a dependency to include or exclude. * Since: 3.1.11 * Author: Stephane Nicoll, David Turanski - ## Constructor Summary Constructors Constructor Description `FilterableDependency()`   - ## Method Summary Modifier and Type Method Description `void` `set(String property)` Configures the include or exclude using a user-provided property in the form `groupId:artifactId` or `groupId:artifactId:classifier`. ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### FilterableDependency public FilterableDependency() * ## Method Details * ### set public void set​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") property) Configures the include or exclude using a user-provided property in the form `groupId:artifactId` or `groupId:artifactId:classifier`. * Parameters: `property` - the user-provided property ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-15.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## P * [ProcessAotMojo](../org/springframework/boot/maven/ProcessAotMojo.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Invoke the AOT engine on the application. * [ProcessAotMojo(ToolchainManager)](../org/springframework/boot/maven/ProcessAotMojo.html#%3Cinit%3E\(org.apache.maven.toolchain.ToolchainManager\)) - Constructor for class org.springframework.boot.maven.[ProcessAotMojo](../org/springframework/boot/maven/ProcessAotMojo.html "class in org.springframework.boot.maven")   * [processResource(String, InputStream, List)](../org/springframework/boot/maven/PropertiesMergingResourceTransformer.html#processResource\(java.lang.String,java.io.InputStream,java.util.List\)) - Method in class org.springframework.boot.maven.[PropertiesMergingResourceTransformer](../org/springframework/boot/maven/PropertiesMergingResourceTransformer.html "class in org.springframework.boot.maven") Deprecated. * [processResource(String, InputStream, List, long)](../org/springframework/boot/maven/PropertiesMergingResourceTransformer.html#processResource\(java.lang.String,java.io.InputStream,java.util.List,long\)) - Method in class org.springframework.boot.maven.[PropertiesMergingResourceTransformer](../org/springframework/boot/maven/PropertiesMergingResourceTransformer.html "class in org.springframework.boot.maven")   * [ProcessTestAotMojo](../org/springframework/boot/maven/ProcessTestAotMojo.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Invoke the AOT engine on tests. * [ProcessTestAotMojo(ToolchainManager, RepositorySystem)](../org/springframework/boot/maven/ProcessTestAotMojo.html#%3Cinit%3E\(org.apache.maven.toolchain.ToolchainManager,org.eclipse.aether.RepositorySystem\)) - Constructor for class org.springframework.boot.maven.[ProcessTestAotMojo](../org/springframework/boot/maven/ProcessTestAotMojo.html "class in org.springframework.boot.maven")   * [project](../org/springframework/boot/maven/AbstractDependencyFilterMojo.html#project) - Variable in class org.springframework.boot.maven.[AbstractDependencyFilterMojo](../org/springframework/boot/maven/AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") The Maven project. * [project](../org/springframework/boot/maven/AbstractPackagerMojo.html#project) - Variable in class org.springframework.boot.maven.[AbstractPackagerMojo](../org/springframework/boot/maven/AbstractPackagerMojo.html "class in org.springframework.boot.maven") The Maven project. * [projectHelper](../org/springframework/boot/maven/AbstractPackagerMojo.html#projectHelper) - Variable in class org.springframework.boot.maven.[AbstractPackagerMojo](../org/springframework/boot/maven/AbstractPackagerMojo.html "class in org.springframework.boot.maven") Maven project helper utils. * [PropertiesMergingResourceTransformer](../org/springframework/boot/maven/PropertiesMergingResourceTransformer.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Extension for the [Maven shade plugin](https://maven.apache.org/plugins/maven-shade-plugin/) to allow properties files (e.g. * [PropertiesMergingResourceTransformer()](../org/springframework/boot/maven/PropertiesMergingResourceTransformer.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.maven.[PropertiesMergingResourceTransformer](../org/springframework/boot/maven/PropertiesMergingResourceTransformer.html "class in org.springframework.boot.maven")   [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-14.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## O * [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) - package org.springframework.boot.maven Maven plugin for Spring Boot. [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/how-to/properties-and-configuration.html ---- # Properties and Configuration This section includes topics about setting and reading properties and configuration settings and their interaction with Spring Boot applications. ## [](#howto.properties-and-configuration.expand-properties)Automatically Expand Properties at Build Time Rather than hardcoding some properties that are also specified in your project’s build configuration, you can automatically expand them by instead using the existing build configuration. This is possible in both Maven and Gradle. ### [](#howto.properties-and-configuration.expand-properties.maven)Automatic Property Expansion Using Maven You can automatically expand properties in the Maven project by using resource filtering. If you use the `spring-boot-starter-parent`, you can then refer to your Maven ‘project properties’ with `@..@` placeholders, as shown in the following example: * Properties * YAML ```properties [email protected]@ [email protected]@ ``` ```yaml app: encoding: "@project.build.sourceEncoding@" java: version: "@java.version@" ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------- | | ** | Only production configuration is filtered that way (in other words, no filtering is applied on `src/test/resources`). | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you enable the `addResources` flag, the `spring-boot:run` goal can add `src/main/resources` directly to the classpath (for hot reloading purposes). Doing so circumvents the resource filtering and this feature. Instead, you can use the `exec:java` goal or customize the plugin’s configuration. See the [plugin usage page](../maven-plugin/using.html) for more details. | If you do not use the starter parent, you need to include the following element inside the `` element of your `pom.xml`: ```xml src/main/resources true ``` You also need to include the following element inside ``: ```xml org.apache.maven.plugins maven-resources-plugin 2.7 @ false ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The `useDefaultDelimiters` property is important if you use standard Spring placeholders (such as `${placeholder}`) in your configuration. If that property is not set to `false`, these may be expanded by the build. | ### [](#howto.properties-and-configuration.expand-properties.gradle)Automatic Property Expansion Using Gradle You can automatically expand properties from the Gradle project by configuring the Java plugin’s `processResources` task to do so, as shown in the following example: ```gradle tasks.named('processResources') { expand(project.properties) } ``` You can then refer to your Gradle project’s properties by using placeholders, as shown in the following example: * Properties * YAML ```properties app.name=${name} app.description=${description} ``` ```yaml app: name: "${name}" description: "${description}" ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Gradle’s `expand` method uses Groovy’s `SimpleTemplateEngine`, which transforms `${..}` tokens. The `${..}` style conflicts with Spring’s own property placeholder mechanism. To use Spring property placeholders together with automatic expansion, escape the Spring property placeholders as follows: `\${..}`. | ## [](#howto.properties-and-configuration.externalize-configuration)Externalize the Configuration of SpringApplication A [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) has bean property setters, so you can use its Java API as you create the application to modify its behavior. Alternatively, you can externalize the configuration by setting properties in `spring.main.*`. For example, in `application.properties`, you might have the following settings: * Properties * YAML ```properties spring.main.web-application-type=none spring.main.banner-mode=off ``` ```yaml spring: main: web-application-type: "none" banner-mode: "off" ``` Then the Spring Boot banner is not printed on startup, and the application is not starting an embedded web server. Properties defined in external configuration override and replace the values specified with the Java API, with the notable exception of the primary sources. Primary sources are those provided to the [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) constructor: * Java * Kotlin ```java import org.springframework.boot.Banner; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class MyApplication { public static void main(String[] args) { SpringApplication application = new SpringApplication(MyApplication.class); application.setBannerMode(Banner.Mode.OFF); application.run(args); } } ``` ```kotlin import org.springframework.boot.Banner import org.springframework.boot.SpringApplication import org.springframework.boot.autoconfigure.SpringBootApplication @SpringBootApplication object MyApplication { @JvmStatic fun main(args: Array) { val application = SpringApplication(MyApplication::class.java) application.setBannerMode(Banner.Mode.OFF) application.run(*args) } } ``` Or to `sources(…​)` method of a [`SpringApplicationBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/builder/SpringApplicationBuilder.html): * Java * Kotlin ```java import org.springframework.boot.Banner; import org.springframework.boot.builder.SpringApplicationBuilder; public class MyApplication { public static void main(String[] args) { new SpringApplicationBuilder() .bannerMode(Banner.Mode.OFF) .sources(MyApplication.class) .run(args); } } ``` ```kotlin import org.springframework.boot.Banner import org.springframework.boot.builder.SpringApplicationBuilder object MyApplication { @JvmStatic fun main(args: Array) { SpringApplicationBuilder() .bannerMode(Banner.Mode.OFF) .sources(MyApplication::class.java) .run(*args) } } ``` Given the examples above, if we have the following configuration: * Properties * YAML ```properties spring.main.sources=com.example.MyDatabaseConfig,com.example.MyJmsConfig spring.main.banner-mode=console ``` ```yaml spring: main: sources: "com.example.MyDatabaseConfig,com.example.MyJmsConfig" banner-mode: "console" ``` The actual application will show the banner (as overridden by configuration) and use three sources for the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html). The application sources are: 1. `MyApplication` (from the code) 2. `MyDatabaseConfig` (from the external config) 3. `MyJmsConfig`(from the external config) ## [](#howto.properties-and-configuration.external-properties-location)Change the Location of External Properties of an Application By default, properties from different sources are added to the Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) in a defined order (see [Externalized Configuration](../reference/features/external-config.html) in the “Spring Boot Features” section for the exact order). You can also provide the following System properties (or environment variables) to change the behavior: * `spring.config.name` (`SPRING_CONFIG_NAME`): Defaults to `application` as the root of the file name. * `spring.config.location` (`SPRING_CONFIG_LOCATION`): The file to load (such as a classpath resource or a URL). A separate [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) property source is set up for this document and it can be overridden by system properties, environment variables, or the command line. No matter what you set in the environment, Spring Boot always loads `application.properties` as described above. By default, if YAML is used, then files with the ‘.yaml’ and ‘.yml’ extensions are also added to the list. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you want detailed information about the files that are being loaded you can [set the logging level](../reference/features/logging.html#features.logging.log-levels) of `org.springframework.boot.context.config` to `trace`. | ## [](#howto.properties-and-configuration.short-command-line-arguments)Use ‘Short’ Command Line Arguments Some people like to use (for example) `--port=9000` instead of `--server.port=9000` to set configuration properties on the command line. You can enable this behavior by using placeholders in `application.properties`, as shown in the following example: * Properties * YAML ```properties server.port=${port:8080} ``` ```yaml server: port: "${port:8080}" ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you inherit from the `spring-boot-starter-parent` POM, the default filter token of the `maven-resources-plugins` has been changed from `${*}` to `@` (that is, `@maven.token@` instead of `${maven.token}`) to prevent conflicts with Spring-style placeholders. If you have enabled Maven filtering for the `application.properties` directly, you may want to also change the default filter token to use [other delimiters](https://maven.apache.org/plugins/maven-resources-plugin/resources-mojo.html#delimiters). | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | In this specific case, the port binding works in a PaaS environment such as Heroku or Cloud Foundry. On those two platforms, the `PORT` environment variable is set automatically and Spring can bind to capitalized synonyms for [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) properties. | ## [](#howto.properties-and-configuration.yaml)Use YAML for External Properties YAML is a superset of JSON and, as such, is a convenient syntax for storing external properties in a hierarchical format, as shown in the following example: ```yaml spring: application: name: "cruncher" datasource: driver-class-name: "com.mysql.jdbc.Driver" url: "jdbc:mysql://localhost/test" server: port: 9000 ``` Create a file called `application.yaml` and put it in the root of your classpath. Then add `snakeyaml` to your dependencies (Maven coordinates `org.yaml:snakeyaml`, already included if you use the `spring-boot-starter`). A YAML file is parsed to a Java `Map` (like a JSON object), and Spring Boot flattens the map so that it is one level deep and has period-separated keys, as many people are used to with [`Properties`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Properties.html) files in Java. The preceding example YAML corresponds to the following `application.properties` file: ```properties spring.application.name=cruncher spring.datasource.driver-class-name=com.mysql.jdbc.Driver spring.datasource.url=jdbc:mysql://localhost/test server.port=9000 ``` See [Working With YAML](../reference/features/external-config.html#features.external-config.yaml) in the “Spring Boot Features” section for more information about YAML. ## [](#howto.properties-and-configuration.set-active-spring-profiles)Set the Active Spring Profiles The Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) has an API for this, but you would normally set a System property (`spring.profiles.active`) or an OS environment variable (`SPRING_PROFILES_ACTIVE`). Also, you can launch your application with a `-D` argument (remember to put it before the main class or jar archive), as follows: ```shell $ java -jar -Dspring.profiles.active=production demo-0.0.1-SNAPSHOT.jar ``` In Spring Boot, you can also set the active profile in `application.properties`, as shown in the following example: * Properties * YAML ```properties spring.profiles.active=production ``` ```yaml spring: profiles: active: "production" ``` A value set this way is replaced by the System property or environment variable setting but not by the `SpringApplicationBuilder.profiles()` method. Thus, the latter Java API can be used to augment the profiles without changing the defaults. See [Profiles](../reference/features/profiles.html) in the “Spring Boot Features” section for more information. ## [](#howto.properties-and-configuration.set-default-spring-profile-name)Set the Default Profile Name The default profile is a profile that is enabled if no profile is active. By default, the name of the default profile is `default`, but it could be changed using a System property (`spring.profiles.default`) or an OS environment variable (`SPRING_PROFILES_DEFAULT`). In Spring Boot, you can also set the default profile name in `application.properties`, as shown in the following example: * Properties * YAML ```properties spring.profiles.default=dev ``` ```yaml spring: profiles: default: "dev" ``` See [Profiles](../reference/features/profiles.html) in the “Spring Boot Features” section for more information. ## [](#howto.properties-and-configuration.change-configuration-depending-on-the-environment)Change Configuration Depending on the Environment Spring Boot supports multi-document YAML and Properties files (see [Working With Multi-Document Files](../reference/features/external-config.html#features.external-config.files.multi-document) for details) which can be activated conditionally based on the active profiles. If a document contains a `spring.config.activate.on-profile` key, then the profiles value (a comma-separated list of profiles or a profile expression) is fed into the Spring `Environment.acceptsProfiles()` method. If the profile expression matches, then that document is included in the final merge (otherwise, it is not), as shown in the following example: * Properties * YAML ```properties server.port=9000 #--- spring.config.activate.on-profile=development server.port=9001 #--- spring.config.activate.on-profile=production server.port=0 ``` ```yaml server: port: 9000 --- spring: config: activate: on-profile: "development" server: port: 9001 --- spring: config: activate: on-profile: "production" server: port: 0 ``` In the preceding example, the default port is 9000. However, if the Spring profile called ‘development’ is active, then the port is 9001. If ‘production’ is active, then the port is 0. | | | | -- | ---------------------------------------------------------------------------------------------------------- | | ** | The documents are merged in the order in which they are encountered. Later values override earlier values. | ## [](#howto.properties-and-configuration.discover-build-in-options-for-external-properties)Discover Built-in Options for External Properties Spring Boot binds external properties from `application.properties` (or YAML files and other places) into an application at runtime. There is not (and technically cannot be) an exhaustive list of all supported properties in a single location, because contributions can come from additional jar files on your classpath. A running application with the Actuator features has a `configprops` endpoint that shows all the bound and bindable properties available through [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html). The appendix includes an [`application.properties`](../appendix/application-properties/index.html) example with a list of the most common properties supported by Spring Boot. The definitive list comes from searching the source code for [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) and [`@Value`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Value.html) annotations as well as the occasional use of [`Binder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/bind/Binder.html). For more about the exact ordering of loading properties, see [Externalized Configuration](../reference/features/external-config.html). * [Spring Boot](../index.html) * [4.1.1](properties-and-configuration.html) * [4.0.8](../4.0/how-to/properties-and-configuration.html) * [3.5.16](../3.5/how-to/properties-and-configuration.html) * [3.4.13](../3.4/how-to/properties-and-configuration.html) * [3.3.13](../3.3/how-to/properties-and-configuration.html) - [4.2.0-M2](../4.2/how-to/properties-and-configuration.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/properties-and-configuration.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/properties-and-configuration.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/properties-and-configuration.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/web/graceful-shutdown.html ---- # Graceful Shutdown Graceful shutdown is enabled by default with all three embedded web servers (Jetty, Reactor Netty, and Tomcat) and with both reactive and servlet-based web applications. It occurs as part of closing the application context and is performed in the earliest phase of stopping [`SmartLifecycle`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/SmartLifecycle.html) beans. This stop processing uses a timeout which provides a grace period during which existing requests will be allowed to complete but no new requests will be permitted. To configure the timeout period, configure the `spring.lifecycle.timeout-per-shutdown-phase` property, as shown in the following example: * Properties * YAML ```properties spring.lifecycle.timeout-per-shutdown-phase=20s ``` ```yaml spring: lifecycle: timeout-per-shutdown-phase: "20s" ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Shutdown in your IDE may be immediate rather than graceful if it does not send a proper `SIGTERM` signal. See the documentation of your IDE for more details. | ## [](#web.graceful-shutdown.rejecting-requests-during-the-grace-period)Rejecting Requests During the Grace Period The exact way in which new requests are not permitted varies depending on the web server that is being used. Implementations may stop accepting requests at the network layer, or they may return a response with a specific HTTP status code or HTTP header. The use of persistent connections can also change the way that requests stop being accepted. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | To learn more about the specific method used with your web server, see the `shutDownGracefully` API documentation for [`TomcatWebServer.shutDownGracefully(GracefulShutdownCallback)`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/tomcat/TomcatWebServer.html#shutDownGracefully\(org.springframework.boot.web.server.GracefulShutdownCallback\)), [`NettyWebServer.shutDownGracefully(GracefulShutdownCallback)`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/reactor/netty/NettyWebServer.html#shutDownGracefully\(org.springframework.boot.web.server.GracefulShutdownCallback\)), or [`JettyWebServer.shutDownGracefully(GracefulShutdownCallback)`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jetty/JettyWebServer.html#shutDownGracefully\(org.springframework.boot.web.server.GracefulShutdownCallback\)). | Jetty, Reactor Netty, and Tomcat will stop accepting new requests at the network layer. ## [](#web.graceful-shutdown.disabling-graceful-shutdown)Disabling Graceful Shutdown To disable graceful shutdown, configure the `server.shutdown` property, as shown in the following example: * Properties * YAML ```properties server.shutdown=immediate ``` ```yaml server: shutdown: "immediate" ``` * [Spring Boot](../../index.html) * [4.1.1](graceful-shutdown.html) * [4.0.8](../../4.0/reference/web/graceful-shutdown.html) * [3.5.16](../../3.5/reference/web/graceful-shutdown.html) * [3.4.13](../../3.4/reference/web/graceful-shutdown.html) * [3.3.13](../../3.3/reference/web/graceful-shutdown.html) - [4.2.0-M2](../../4.2/reference/web/graceful-shutdown.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/web/graceful-shutdown.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/web/graceful-shutdown.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/web/graceful-shutdown.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/packaging/aot-cache.html ---- # AOT Cache AOT cache is a [JVM feature](https://openjdk.org/jeps/483) that can help reduce the startup time and memory footprint of Java applications. If you are not yet using Java 25 or above, you should read the sections about CDS. CDS is the predecessor of AOT cache, but works similarly. | | | | -- | --------------------------------------------------------------------------------------------------------- | | ** | Spring Boot supports both CDS and AOT cache, however, we recommend using the AOT cache whenever possible. | ## [](#packaging.aot-cache.aot-cache)AOT Cache | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------- | | ** | Spring Boot supports the AOT cache for Java 25 and above. If you’re using an earlier version of Java, you have to use CDS instead. | To use the AOT cache feature, you should first perform a training run on your application in extracted form: ```shell $ java -Djarmode=tools -jar my-app.jar extract --destination application $ cd application $ java -XX:AOTCacheOutput=app.aot -Dspring.context.exit=onRefresh -jar my-app.jar ``` This creates an `app.aot` cache file that can be reused as long as the application is not updated and the same Java version is used. To use the cache file, you need to add an extra parameter when starting the application: ```shell $ java -XX:AOTCache=app.aot -jar my-app.jar ``` | | | | -- | ------------------------------------------------------------------------------------------------------ | | ** | You have to use the cache file with the extracted form of the application, otherwise it has no effect. | If you want to know how to leverage AOT Cache with Buildpacks, take a look at the [AOT Cache How-to guide](../../how-to/aot-cache.html). ## [](#packaging.aot-cache.cds)CDS | | | | -- | ---------------------------------------------------------------------- | | ** | If you’re using Java 25 or above, please use AOT cache instead of CDS. | To use CDS, you should first perform a training run on your application in extracted form: ```shell $ java -Djarmode=tools -jar my-app.jar extract --destination application $ cd application $ java -XX:ArchiveClassesAtExit=application.jsa -Dspring.context.exit=onRefresh -jar my-app.jar ``` This creates an `application.jsa` archive file that can be reused as long as the application is not updated. To use the archive file, you need to add an extra parameter when starting the application: ```shell $ java -XX:SharedArchiveFile=application.jsa -jar my-app.jar ``` | | | | -- | ------------------------------------------------------------------------------------------------------ | | ** | You have to use the cache file with the extracted form of the application, otherwise it has no effect. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | For more details about CDS, refer to the [Class Data Sharing documentation of the JDK](https://docs.oracle.com/en/java/javase/17/vm/class-data-sharing.html). | * [Spring Boot](../../index.html) * [4.1.1](aot-cache.html) * [4.0.8](../../4.0/reference/packaging/aot-cache.html) * [3.5.16](../../3.5/index.html) * [3.4.13](../../3.4/index.html) * [3.3.13](../../3.3/index.html) - [4.2.0-M2](../../4.2/reference/packaging/aot-cache.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/packaging/aot-cache.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/packaging/aot-cache.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/packaging/aot-cache.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/CacheSpec.BindCacheSpec.html ---- # Class CacheSpec.BindCacheSpec [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.gradle.tasks.bundling.CacheSpec.BindCacheSpec * Enclosing class: `CacheSpec` *** public abstract static class CacheSpec.BindCacheSpec extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") Configuration for an image building cache stored in a bind mount. `BindCacheSpec()`   - ## Method Summary Modifier and Type Method Description `abstract Property` `getSource()` Returns the source of the cache. ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### BindCacheSpec public BindCacheSpec() * ## Method Details * ### getSource [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getSource() Returns the source of the cache. * Returns: the cache source ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/CacheSpec.VolumeCacheSpec.html ---- # Class CacheSpec.VolumeCacheSpec [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.gradle.tasks.bundling.CacheSpec.VolumeCacheSpec * Enclosing class: `CacheSpec` *** public abstract static class CacheSpec.VolumeCacheSpec extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") Configuration for an image building cache stored in a Docker volume. `VolumeCacheSpec()`   - ## Method Summary Modifier and Type Method Description `abstract Property` `getName()` Returns the name of the cache. ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### VolumeCacheSpec public VolumeCacheSpec() * ## Method Details * ### getName [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getName() Returns the name of the cache. * Returns: the cache name ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/StopMojo.html ---- # Class StopMojo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.plugin.AbstractMojo org.springframework.boot.maven.StopMojo * All Implemented Interfaces: `org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo` *** @Mojo(name="stop", requiresProject=true, defaultPhase=POST\_INTEGRATION\_TEST) public class StopMojo extends org.apache.maven.plugin.AbstractMojo Stop an application that has been started by the "start" goal. Typically invoked once a test suite has completed. * Since: 1.3.0 * Author: Stephane Nicoll `StopMojo()` * ### StopMojo public StopMojo() * ## Method Details * ### execute public void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException * Throws: * `org.apache.maven.plugin.MojoExecutionException` * `org.apache.maven.plugin.MojoFailureException` ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/DependencyFilter.html ---- Uses of Class\ org.springframework.boot.maven.DependencyFilter =============================================== * ## Uses of [DependencyFilter](../DependencyFilter.html "class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Subclasses of [DependencyFilter](../DependencyFilter.html "class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Modifier and Type Class Description `class ` `ExcludeFilter` An {DependencyFilter} that filters out any artifact matching an [`Exclude`](../Exclude.html "class in org.springframework.boot.maven"). `class ` `IncludeFilter` An `ArtifactsFilter` that filters out any artifact not matching an [`Include`](../Include.html "class in org.springframework.boot.maven"). Methods in [org.springframework.boot.maven](../package-summary.html) that return [DependencyFilter](../DependencyFilter.html "class in org.springframework.boot.maven") Modifier and Type Method Description `static DependencyFilter` DependencyFilter.`exclude(Predicate filter)` Return a new [`DependencyFilter`](../DependencyFilter.html "class in org.springframework.boot.maven") the excludes artifacts based on the given predicate. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/IncludeFilter.html ---- Uses of Class\ org.springframework.boot.maven.IncludeFilter ============================================ No usage of org.springframework.boot.maven.IncludeFilter ---- url: https://docs.spring.io/spring-boot/how-to/actuator.html ---- # Actuator Spring Boot includes the Spring Boot Actuator. This section answers questions that often arise from its use. ## [](#howto.actuator.change-http-port-or-address)Change the HTTP Port or Address of the Actuator Endpoints In a standalone application, the Actuator HTTP port defaults to the same as the main HTTP port. To make the application listen on a different port, set the external property: `management.server.port`. To listen on a completely different network address (such as when you have an internal network for management and an external one for user applications), you can also set `management.server.address` to a valid IP address to which the server is able to bind. For more detail, see the [`ManagementServerProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/autoconfigure/web/server/ManagementServerProperties.html) source code and [Customizing the Management Server Port](../reference/actuator/monitoring.html#actuator.monitoring.customizing-management-server-port) in the “Production-Ready Features” section. ## [](#howto.actuator.customizing-sanitization)Customizing Sanitization To take control over the sanitization, define a [`SanitizingFunction`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/SanitizingFunction.html) bean. The [`SanitizableData`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/SanitizableData.html) with which the function is called provides access to the key and value as well as the [`PropertySource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/PropertySource.html) from which they came. This allows you to, for example, sanitize every value that comes from a particular property source. Each [`SanitizingFunction`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/SanitizingFunction.html) is called in order until a function changes the value of the sanitizable data. ## [](#howto.actuator.map-health-indicators-to-metrics)Map Health Indicators to Micrometer Metrics Spring Boot health indicators return a [`Status`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/Status.html) type to indicate the overall system health. If you want to monitor or alert on levels of health for a particular application, you can export these statuses as metrics with Micrometer. By default, the status codes “UP”, “DOWN”, “OUT\_OF\_SERVICE” and “UNKNOWN” are used by Spring Boot. To export these, you will need to convert these states to some set of numbers so that they can be used with a Micrometer [`Gauge`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/Gauge.html). The following example shows one way to write such an exporter: * Java * Kotlin ```java import io.micrometer.core.instrument.Gauge; import io.micrometer.core.instrument.MeterRegistry; import org.springframework.boot.health.actuate.endpoint.HealthEndpoint; import org.springframework.boot.health.contributor.Status; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyHealthMetricsExportConfiguration { public MyHealthMetricsExportConfiguration(MeterRegistry registry, HealthEndpoint healthEndpoint) { // This example presumes common tags (such as the app) are applied elsewhere Gauge.builder("health", healthEndpoint, this::getStatusCode).strongReference(true).register(registry); } private int getStatusCode(HealthEndpoint health) { Status status = health.health().getStatus(); if (Status.UP.equals(status)) { return 3; } if (Status.OUT_OF_SERVICE.equals(status)) { return 2; } if (Status.DOWN.equals(status)) { return 1; } return 0; } } ``` ```kotlin import io.micrometer.core.instrument.Gauge import io.micrometer.core.instrument.MeterRegistry import org.springframework.boot.health.actuate.endpoint.HealthEndpoint import org.springframework.boot.health.contributor.Status import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyHealthMetricsExportConfiguration(registry: MeterRegistry, healthEndpoint: HealthEndpoint) { init { // This example presumes common tags (such as the app) are applied elsewhere Gauge.builder("health", healthEndpoint) { health -> getStatusCode(health).toDouble() }.strongReference(true).register(registry) } private fun getStatusCode(health: HealthEndpoint) = when (health.health().status) { Status.UP -> 3 Status.OUT_OF_SERVICE -> 2 Status.DOWN -> 1 else -> 0 } } ``` * [Spring Boot](../index.html) * [4.1.1](actuator.html) * [4.0.8](../4.0/how-to/actuator.html) * [3.5.16](../3.5/how-to/actuator.html) * [3.4.13](../3.4/how-to/actuator.html) * [3.3.13](../3.3/how-to/actuator.html) - [4.2.0-M2](../4.2/how-to/actuator.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/actuator.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/actuator.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/actuator.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/messaging/amqp.html ---- # AMQP The Advanced Message Queuing Protocol (AMQP) is a platform-neutral, wire-level protocol for message-oriented middleware. The Spring AMQP project applies core Spring concepts to the development of AMQP-based messaging solutions. Spring Boot offers several conveniences for working with AMQP through RabbitMQ, including the `spring-boot-starter-amqp` starter. ## [](#messaging.amqp.rabbitmq)RabbitMQ Support [RabbitMQ](https://www.rabbitmq.com/) is a lightweight, reliable, scalable, and portable message broker based on the AMQP protocol. Spring uses RabbitMQ to communicate through the AMQP protocol. RabbitMQ configuration is controlled by external configuration properties in `spring.rabbitmq.*`. For example, you might declare the following section in `application.properties`: * Properties * YAML ```properties spring.rabbitmq.host=localhost spring.rabbitmq.port=5672 spring.rabbitmq.username=admin spring.rabbitmq.password=secret ``` ```yaml spring: rabbitmq: host: "localhost" port: 5672 username: "admin" password: "secret" ``` Alternatively, you could configure the same connection using the `addresses` attribute: * Properties * YAML ```properties spring.rabbitmq.addresses=amqp://admin:secret@localhost ``` ```yaml spring: rabbitmq: addresses: "amqp://admin:secret@localhost" ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | When specifying addresses that way, the `host` and `port` properties are ignored. If the address uses the `amqps` protocol, SSL support is enabled automatically. | See [`RabbitProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/amqp/autoconfigure/RabbitProperties.html) for more of the supported property-based configuration options. To configure lower-level details of the RabbitMQ [`ConnectionFactory`](https://rabbitmq.github.io/rabbitmq-java-client/api/current/com/rabbitmq/client/ConnectionFactory.html) that is used by Spring AMQP, define a [`ConnectionFactoryCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/amqp/autoconfigure/ConnectionFactoryCustomizer.html) bean. If a [`ConnectionNameStrategy`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/connection/ConnectionNameStrategy.html) bean exists in the context, it will be automatically used to name connections created by the auto-configured [`CachingConnectionFactory`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/connection/CachingConnectionFactory.html). To make an application-wide, additive customization to the [`RabbitTemplate`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/core/RabbitTemplate.html), use a [`RabbitTemplateCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/amqp/autoconfigure/RabbitTemplateCustomizer.html) bean. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | See [Understanding AMQP, the protocol used by RabbitMQ](https://spring.io/blog/2010/06/14/understanding-amqp-the-protocol-used-by-rabbitmq/) for more details. | ## [](#messaging.amqp.sending)Sending a Message Spring’s [`AmqpTemplate`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/core/AmqpTemplate.html) and [`AmqpAdmin`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/core/AmqpAdmin.html) are auto-configured, and you can autowire them directly into your own beans, as shown in the following example: * Java * Kotlin ```java import org.springframework.amqp.core.AmqpAdmin; import org.springframework.amqp.core.AmqpTemplate; import org.springframework.stereotype.Component; @Component public class MyBean { private final AmqpAdmin amqpAdmin; private final AmqpTemplate amqpTemplate; public MyBean(AmqpAdmin amqpAdmin, AmqpTemplate amqpTemplate) { this.amqpAdmin = amqpAdmin; this.amqpTemplate = amqpTemplate; } // ... public void someMethod() { this.amqpAdmin.getQueueInfo("someQueue"); } public void someOtherMethod() { this.amqpTemplate.convertAndSend("hello"); } } ``` ```kotlin import org.springframework.amqp.core.AmqpAdmin import org.springframework.amqp.core.AmqpTemplate import org.springframework.stereotype.Component @Component class MyBean(private val amqpAdmin: AmqpAdmin, private val amqpTemplate: AmqpTemplate) { // ... fun someMethod() { amqpAdmin.getQueueInfo("someQueue") } fun someOtherMethod() { amqpTemplate.convertAndSend("hello") } } ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | [`RabbitMessagingTemplate`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/core/RabbitMessagingTemplate.html) can be injected in a similar manner. If a [`MessageConverter`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/support/converter/MessageConverter.html) bean is defined, it is associated automatically to the auto-configured [`AmqpTemplate`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/core/AmqpTemplate.html). | If necessary, any [`Queue`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/core/Queue.html) that is defined as a bean is automatically used to declare a corresponding queue on the RabbitMQ instance. To retry operations, you can enable retries on the [`AmqpTemplate`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/core/AmqpTemplate.html) (for example, in the event that the broker connection is lost): * Properties * YAML ```properties spring.rabbitmq.template.retry.enabled=true spring.rabbitmq.template.retry.initial-interval=2s ``` ```yaml spring: rabbitmq: template: retry: enabled: true initial-interval: "2s" ``` Retries are disabled by default. You can also customize the [`RetryTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/retry/RetryTemplate.html) programmatically by declaring a [`RabbitTemplateRetrySettingsCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/amqp/autoconfigure/RabbitTemplateRetrySettingsCustomizer.html) bean. If you need to create more [`RabbitTemplate`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/core/RabbitTemplate.html) instances or if you want to override the default, Spring Boot provides a [`RabbitTemplateConfigurer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/amqp/autoconfigure/RabbitTemplateConfigurer.html) bean that you can use to initialize a [`RabbitTemplate`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/core/RabbitTemplate.html) with the same settings as the factories used by the auto-configuration. If there’s a bean of type [`RabbitTemplateObservationConvention`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/support/micrometer/RabbitTemplateObservationConvention.html) in the context, it will automatically be configured on the [`RabbitTemplate`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/core/RabbitTemplate.html). ## [](#messaging.amqp.sending-stream)Sending a Message To A Stream To send a message to a particular stream, specify the name of the stream, as shown in the following example: * Properties * YAML ```properties spring.rabbitmq.stream.name=my-stream ``` ```yaml spring: rabbitmq: stream: name: "my-stream" ``` If a [`MessageConverter`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/support/converter/MessageConverter.html), [`StreamMessageConverter`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/rabbit/stream/support/converter/StreamMessageConverter.html), [`ProducerCustomizer`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/rabbit/stream/producer/ProducerCustomizer.html) or [`RabbitStreamTemplateObservationConvention`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/rabbit/stream/micrometer/RabbitStreamTemplateObservationConvention.html) bean is defined, it is associated automatically to the auto-configured [`RabbitStreamTemplate`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/rabbit/stream/producer/RabbitStreamTemplate.html). If you need to create more [`RabbitStreamTemplate`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/rabbit/stream/producer/RabbitStreamTemplate.html) instances or if you want to override the default, Spring Boot provides a [`RabbitStreamTemplateConfigurer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/amqp/autoconfigure/RabbitStreamTemplateConfigurer.html) bean that you can use to initialize a [`RabbitStreamTemplate`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/rabbit/stream/producer/RabbitStreamTemplate.html) with the same settings as the factories used by the auto-configuration. ### [](#messaging.amqp.sending-stream.ssl)SSL To use SSL with RabbitMQ Streams, set `spring.rabbitmq.stream.ssl.enabled` to `true` or set `spring.rabbitmq.stream.ssl.bundle` to configure the [SSL bundle](../features/ssl.html#features.ssl.bundles) to use. ## [](#messaging.amqp.receiving)Receiving a Message When the Rabbit infrastructure is present, any bean can be annotated with [`@RabbitListener`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/annotation/RabbitListener.html) to create a listener endpoint. If no [`RabbitListenerContainerFactory`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/listener/RabbitListenerContainerFactory.html) has been defined, a default [`SimpleRabbitListenerContainerFactory`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/config/SimpleRabbitListenerContainerFactory.html) is automatically configured and you can switch to a direct container using the `spring.rabbitmq.listener.type` property. If a [`MessageConverter`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/support/converter/MessageConverter.html), a [`MessageRecoverer`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/retry/MessageRecoverer.html) or a [`RabbitListenerObservationConvention`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/support/micrometer/RabbitListenerObservationConvention.html) bean is defined, it is automatically associated with the default factory. The following sample component creates a listener endpoint on the `someQueue` queue: * Java * Kotlin ```java import org.springframework.amqp.rabbit.annotation.RabbitListener; import org.springframework.stereotype.Component; @Component public class MyBean { @RabbitListener(queues = "someQueue") public void processMessage(String content) { // ... } } ``` ```kotlin import org.springframework.amqp.rabbit.annotation.RabbitListener import org.springframework.stereotype.Component @Component class MyBean { @RabbitListener(queues = ["someQueue"]) fun processMessage(content: String?) { // ... } } ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | See [`@EnableRabbit`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/annotation/EnableRabbit.html) for more details. | If you need to create more [`RabbitListenerContainerFactory`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/listener/RabbitListenerContainerFactory.html) instances or if you want to override the default, Spring Boot provides a [`SimpleRabbitListenerContainerFactoryConfigurer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/amqp/autoconfigure/SimpleRabbitListenerContainerFactoryConfigurer.html) and a [`DirectRabbitListenerContainerFactoryConfigurer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/amqp/autoconfigure/DirectRabbitListenerContainerFactoryConfigurer.html) that you can use to initialize a [`SimpleRabbitListenerContainerFactory`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/config/SimpleRabbitListenerContainerFactory.html) and a [`DirectRabbitListenerContainerFactory`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/config/DirectRabbitListenerContainerFactory.html) with the same settings as the factories used by the auto-configuration. | | | | -- | --------------------------------------------------------------------------------------------------------- | | ** | It does not matter which container type you chose. Those two beans are exposed by the auto-configuration. | For instance, the following configuration class exposes another factory that uses a specific [`MessageConverter`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/support/converter/MessageConverter.html): * Java * Kotlin ```java import org.springframework.amqp.rabbit.config.SimpleRabbitListenerContainerFactory; import org.springframework.amqp.rabbit.connection.ConnectionFactory; import org.springframework.boot.amqp.autoconfigure.SimpleRabbitListenerContainerFactoryConfigurer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyRabbitConfiguration { @Bean public SimpleRabbitListenerContainerFactory myFactory(SimpleRabbitListenerContainerFactoryConfigurer configurer) { SimpleRabbitListenerContainerFactory factory = new SimpleRabbitListenerContainerFactory(); ConnectionFactory connectionFactory = getCustomConnectionFactory(); configurer.configure(factory, connectionFactory); factory.setMessageConverter(new MyMessageConverter()); return factory; } private ConnectionFactory getCustomConnectionFactory() { return ... } } ``` ```kotlin import org.springframework.amqp.rabbit.config.SimpleRabbitListenerContainerFactory import org.springframework.amqp.rabbit.connection.CachingConnectionFactory import org.springframework.amqp.rabbit.connection.ConnectionFactory import org.springframework.boot.amqp.autoconfigure.SimpleRabbitListenerContainerFactoryConfigurer import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyRabbitConfiguration { @Bean fun myFactory(configurer: SimpleRabbitListenerContainerFactoryConfigurer): SimpleRabbitListenerContainerFactory { val factory = SimpleRabbitListenerContainerFactory() val connectionFactory = getCustomConnectionFactory() configurer.configure(factory, connectionFactory) factory.setMessageConverter(MyMessageConverter()) return factory } fun getCustomConnectionFactory() : ConnectionFactory { return ... } } ``` Then you can use the factory in any [`@RabbitListener`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/annotation/RabbitListener.html)-annotated method, as follows: * Java * Kotlin ```java import org.springframework.amqp.rabbit.annotation.RabbitListener; import org.springframework.stereotype.Component; @Component public class MyBean { @RabbitListener(queues = "someQueue", containerFactory = "myFactory") public void processMessage(String content) { // ... } } ``` ```kotlin import org.springframework.amqp.rabbit.annotation.RabbitListener import org.springframework.stereotype.Component @Component class MyBean { @RabbitListener(queues = ["someQueue"], containerFactory = "myFactory") fun processMessage(content: String?) { // ... } } ``` You can enable retries to handle situations where your listener throws an exception. By default, [`RejectAndDontRequeueRecoverer`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/retry/RejectAndDontRequeueRecoverer.html) is used, but you can define a [`MessageRecoverer`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/rabbit/retry/MessageRecoverer.html) of your own. When retries are exhausted, the message is rejected and either dropped or routed to a dead-letter exchange if the broker is configured to do so. By default, retries are disabled. You can also customize the [`RetryPolicy`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/retry/RetryPolicy.html) programmatically by declaring a [`RabbitListenerRetrySettingsCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/amqp/autoconfigure/RabbitListenerRetrySettingsCustomizer.html) bean. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | By default, if retries are disabled and the listener throws an exception, the delivery is retried indefinitely. You can modify this behavior in two ways: Set the `defaultRequeueRejected` property to `false` so that zero re-deliveries are attempted or throw an [`AmqpRejectAndDontRequeueException`](https://docs.spring.io/spring-amqp/docs/4.1.x/api/org/springframework/amqp/AmqpRejectAndDontRequeueException.html) to signal the message should be rejected. The latter is the mechanism used when retries are enabled and the maximum number of delivery attempts is reached. | * [Spring Boot](../../index.html) * [4.1.1](amqp.html) * [4.0.8](../../4.0/reference/messaging/amqp.html) * [3.5.16](../../3.5/reference/messaging/amqp.html) * [3.4.13](../../3.4/reference/messaging/amqp.html) * [3.3.13](../../3.3/reference/messaging/amqp.html) - [4.2.0-M2](../../4.2/reference/messaging/amqp.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/messaging/amqp.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/messaging/amqp.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/messaging/amqp.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/testing/spring-boot-applications.html ---- # Testing Spring Boot Applications A Spring Boot application is a Spring [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html), so nothing very special has to be done to test it beyond what you would normally do with a vanilla Spring context. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | External properties, logging, and other features of Spring Boot are installed in the context by default only if you use [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) to create it. | Spring Boot provides a [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html) annotation, which can be used as an alternative to the standard `spring-test` [`@ContextConfiguration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/context/ContextConfiguration.html) annotation when you need Spring Boot features. The annotation works by [creating the ](#testing.spring-boot-applications.detecting-configuration)[`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) used in your tests through [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html). In addition to [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html) a number of other annotations are also provided for [testing more specific slices](#testing.spring-boot-applications.autoconfigured-tests) of an application. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you are using JUnit 4, do not forget to also add `@RunWith(SpringRunner.class)` to your test, otherwise the annotations will be ignored. If you are using JUnit 6, there is no need to add the equivalent `@ExtendWith(SpringExtension.class)` as [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html) and the other `@…​Test` annotations are already annotated with it. | By default, [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html) will not start a server. You can use the `webEnvironment` attribute of [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html) to further refine how your tests run: * `MOCK`(Default) : Loads a web [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) and provides a mock web environment. Embedded servers are not started when using this annotation. If a web environment is not available on your classpath, this mode transparently falls back to creating a regular non-web [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html). It can be used in conjunction with [`@AutoConfigureMockMvc`](#testing.spring-boot-applications.with-mock-environment), or [`@AutoConfigureWebTestClient`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webtestclient/autoconfigure/AutoConfigureWebTestClient.html)] for mock-based testing of your web application. * `RANDOM_PORT`: Loads a [`WebServerApplicationContext`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/context/WebServerApplicationContext.html) and provides a real web environment. Embedded servers are started and listen on a random port. * `DEFINED_PORT`: Loads a [`WebServerApplicationContext`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/context/WebServerApplicationContext.html) and provides a real web environment. Embedded servers are started and listen on a defined port (from your `application.properties`) or on the default port of `8080`. * `NONE`: Loads an [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) by using [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) but does not provide *any* web environment (mock or otherwise). | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | If your test is [`@Transactional`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/transaction/annotation/Transactional.html), it rolls back the transaction at the end of each test method by default. However, as using this arrangement with either `RANDOM_PORT` or `DEFINED_PORT` implicitly provides a real servlet environment, the HTTP client and server run in separate threads and, thus, in separate transactions. Any transaction initiated on the server does not roll back in this case. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html) with `webEnvironment = WebEnvironment.RANDOM_PORT` will also start the management server on a separate random port if your application uses a different port for the management server. | ## [](#testing.spring-boot-applications.detecting-web-app-type)Detecting Web Application Type If Spring MVC is available, a regular MVC-based application context is configured. If you have only Spring WebFlux, we will detect that and configure a WebFlux-based application context instead. If both are present, Spring MVC takes precedence. If you want to test a reactive web application in this scenario, you must set the `spring.main.web-application-type` property: * Java * Kotlin ```java import org.springframework.boot.test.context.SpringBootTest; @SpringBootTest(properties = "spring.main.web-application-type=reactive") class MyWebFluxTests { // ... } ``` ```kotlin import org.springframework.boot.test.context.SpringBootTest @SpringBootTest(properties = ["spring.main.web-application-type=reactive"]) class MyWebFluxTests { // ... } ``` ## [](#testing.spring-boot-applications.detecting-configuration)Detecting Test Configuration If you are familiar with the Spring Test Framework, you may be used to using `@ContextConfiguration(classes=…​)` in order to specify which Spring [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) to load. Alternatively, you might have often used nested [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) classes within your test. When testing Spring Boot applications, this is often not required. Spring Boot’s `@*Test` annotations search for your primary configuration automatically whenever you do not explicitly define one. The search algorithm works up from the package that contains the test until it finds a class annotated with [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html) or [`@SpringBootConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringBootConfiguration.html). As long as you [structured your code](../using/structuring-your-code.html) in a sensible way, your main configuration is usually found. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | If you use a [test annotation to test a more specific slice of your application](#testing.spring-boot-applications.autoconfigured-tests), you should avoid adding configuration settings that are specific to a particular area on the [main method’s application class](#testing.spring-boot-applications.user-configuration-and-slicing).The underlying component scan configuration of [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html) defines exclude filters that are used to make sure slicing works as expected. If you are using an explicit [`@ComponentScan`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/ComponentScan.html) directive on your [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html)-annotated class, be aware that those filters will be disabled. If you are using slicing, you should define them again. | If you want to customize the primary configuration, you can use a nested [`@TestConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/TestConfiguration.html) class. Unlike a nested [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class, which would be used instead of your application’s primary configuration, a nested [`@TestConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/TestConfiguration.html) class is used in addition to your application’s primary configuration. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Spring’s test framework caches application contexts between tests. Therefore, as long as your tests share the same configuration (no matter how it is discovered), the potentially time-consuming process of loading the context happens only once. | ## [](#testing.spring-boot-applications.using-main)Using the Test Configuration Main Method Typically the test configuration discovered by [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html) will be your main [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html). In most well structured applications, this configuration class will also include the `main` method used to launch the application. For example, the following is a very common code pattern for a typical Spring Boot application: * Java * Kotlin ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class MyApplication { public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } ``` ```kotlin import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.docs.using.structuringyourcode.locatingthemainclass.MyApplication import org.springframework.boot.runApplication @SpringBootApplication class MyApplication fun main(args: Array) { runApplication(*args) } ``` In the example above, the `main` method doesn’t do anything other than delegate to [`SpringApplication.run(Class, String...)`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html#run\(java.lang.Class,java.lang.String...\)). It is, however, possible to have a more complex `main` method that applies customizations before calling [`SpringApplication.run(Class, String...)`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html#run\(java.lang.Class,java.lang.String...\)). For example, here is an application that changes the banner mode and sets additional profiles: * Java * Kotlin ```java import org.springframework.boot.Banner; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class MyApplication { public static void main(String[] args) { SpringApplication application = new SpringApplication(MyApplication.class); application.setBannerMode(Banner.Mode.OFF); application.setAdditionalProfiles("myprofile"); application.run(args); } } ``` ```kotlin import org.springframework.boot.Banner import org.springframework.boot.runApplication import org.springframework.boot.autoconfigure.SpringBootApplication @SpringBootApplication class MyApplication fun main(args: Array) { runApplication(*args) { setBannerMode(Banner.Mode.OFF) setAdditionalProfiles("myprofile") } } ``` Since customizations in the `main` method can affect the resulting [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html), it’s possible that you might also want to use the `main` method to create the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) used in your tests. By default, [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html) will not call your `main` method, and instead the class itself is used directly to create the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) If you want to change this behavior, you can change the `useMainMethod` attribute of [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html) to [`SpringBootTest.UseMainMethod.ALWAYS`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.UseMainMethod.html#ALWAYS) or [`SpringBootTest.UseMainMethod.WHEN_AVAILABLE`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.UseMainMethod.html#WHEN_AVAILABLE). When set to `ALWAYS`, the test will fail if no `main` method can be found. When set to `WHEN_AVAILABLE` the `main` method will be used if it is available, otherwise the standard loading mechanism will be used. For example, the following test will invoke the `main` method of `MyApplication` in order to create the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html). If the main method sets additional profiles then those will be active when the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) starts. * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest.UseMainMethod; @SpringBootTest(useMainMethod = UseMainMethod.ALWAYS) class MyApplicationTests { @Test void exampleTest() { // ... } } ``` ```kotlin import org.junit.jupiter.api.Test import org.springframework.boot.test.context.SpringBootTest import org.springframework.boot.test.context.SpringBootTest.UseMainMethod @SpringBootTest(useMainMethod = UseMainMethod.ALWAYS) class MyApplicationTests { @Test fun exampleTest() { // ... } } ``` ## [](#testing.spring-boot-applications.excluding-configuration)Excluding Test Configuration If your application uses component scanning (for example, if you use [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html) or [`@ComponentScan`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/ComponentScan.html)), you may find top-level configuration classes that you created only for specific tests accidentally get picked up everywhere. As we [have seen earlier](#testing.spring-boot-applications.detecting-configuration), [`@TestConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/TestConfiguration.html) can be used on an inner class of a test to customize the primary configuration. [`@TestConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/TestConfiguration.html) can also be used on a top-level class. Doing so indicates that the class should not be picked up by scanning. You can then import the class explicitly where it is required, as shown in the following example: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.context.annotation.Import; @SpringBootTest @Import(MyTestsConfiguration.class) class MyTests { @Test void exampleTest() { // ... } } ``` ```kotlin import org.junit.jupiter.api.Test import org.springframework.boot.test.context.SpringBootTest import org.springframework.context.annotation.Import @SpringBootTest @Import(MyTestsConfiguration::class) class MyTests { @Test fun exampleTest() { // ... } } ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you directly use [`@ComponentScan`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/ComponentScan.html) (that is, not through [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html)) you need to register the [`TypeExcludeFilter`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/TypeExcludeFilter.html) with it. See the [`TypeExcludeFilter`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/TypeExcludeFilter.html) API documentation for details. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | An imported [`@TestConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/TestConfiguration.html) is processed earlier than an inner-class [`@TestConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/TestConfiguration.html) and an imported [`@TestConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/TestConfiguration.html) will be processed before any configuration found through component scanning. Generally speaking, this difference in ordering has no noticeable effect but it is something to be aware of if you’re relying on bean overriding. | ## [](#testing.spring-boot-applications.using-application-arguments)Using Application Arguments If your application expects [arguments](../features/spring-application.html#features.spring-application.application-arguments), you can have [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html) inject them using the `args` attribute. * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.ApplicationArguments; import org.springframework.boot.test.context.SpringBootTest; import static org.assertj.core.api.Assertions.assertThat; @SpringBootTest(args = "--app.test=one") class MyApplicationArgumentTests { @Test void applicationArgumentsPopulated(@Autowired ApplicationArguments args) { assertThat(args.getOptionNames()).containsOnly("app.test"); assertThat(args.getOptionValues("app.test")).containsOnly("one"); } } ``` ```kotlin import org.assertj.core.api.Assertions.assertThat import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.ApplicationArguments import org.springframework.boot.test.context.SpringBootTest @SpringBootTest(args = ["--app.test=one"]) class MyApplicationArgumentTests { @Test fun applicationArgumentsPopulated(@Autowired args: ApplicationArguments) { assertThat(args.optionNames).containsOnly("app.test") assertThat(args.getOptionValues("app.test")).containsOnly("one") } } ``` ## [](#testing.spring-boot-applications.with-mock-environment)Testing With a Mock Environment By default, [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html) does not start the server but instead sets up a mock environment for testing web endpoints. With Spring MVC, we can query our web endpoints using [`MockMvc`](https://docs.spring.io/spring-framework/reference/7.0/testing/mockmvc.html). The following integrations are available: * The regular [`MockMvc`](https://docs.spring.io/spring-framework/reference/7.0/testing/mockmvc/hamcrest.html) that uses Hamcrest. * [`MockMvcTester`](https://docs.spring.io/spring-framework/reference/7.0/testing/mockmvc/assertj.html) that wraps [`MockMvc`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/MockMvc.html) and uses AssertJ. * [`RestTestClient`](https://docs.spring.io/spring-framework/reference/7.0/testing/resttestclient.html) where [`MockMvc`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/MockMvc.html) is plugged in as the server to handle requests with. * [`WebTestClient`](https://docs.spring.io/spring-framework/reference/7.0/testing/webtestclient.html) where [`MockMvc`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/MockMvc.html) is plugged in as the server to handle requests with. The following example showcases the available integrations: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.resttestclient.autoconfigure.AutoConfigureRestTestClient; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.webmvc.test.autoconfigure.AutoConfigureMockMvc; import org.springframework.boot.webtestclient.autoconfigure.AutoConfigureWebTestClient; import org.springframework.test.web.reactive.server.WebTestClient; import org.springframework.test.web.servlet.MockMvc; import org.springframework.test.web.servlet.assertj.MockMvcTester; import org.springframework.test.web.servlet.client.RestTestClient; import org.springframework.test.web.servlet.client.RestTestClient.ResponseSpec; import org.springframework.test.web.servlet.client.assertj.RestTestClientResponse; import static org.assertj.core.api.Assertions.assertThat; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; @SpringBootTest @AutoConfigureMockMvc @AutoConfigureRestTestClient @AutoConfigureWebTestClient class MyMockMvcTests { @Test void testWithMockMvc(@Autowired MockMvc mvc) throws Exception { mvc.perform(get("/")) .andExpect(status().isOk()) .andExpect(content().string("Hello World")); } @Test // If AssertJ is on the classpath, you can use MockMvcTester void testWithMockMvcTester(@Autowired MockMvcTester mvc) { assertThat(mvc.get().uri("/")) .hasStatusOk() .hasBodyTextEqualTo("Hello World"); } @Test void testWithRestTestClient(@Autowired RestTestClient restClient) { restClient .get().uri("/") .exchange() .expectStatus().isOk() .expectBody(String.class).isEqualTo("Hello World"); } @Test // If you prefer AssertJ, dedicated assertions are available void testWithRestTestClientAssertJ(@Autowired RestTestClient restClient) { ResponseSpec spec = restClient.get().uri("/").exchange(); RestTestClientResponse response = RestTestClientResponse.from(spec); assertThat(response).hasStatusOk() .bodyText().isEqualTo("Hello World"); } @Test // If Spring WebFlux is on the classpath void testWithWebTestClient(@Autowired WebTestClient webClient) { webClient .get().uri("/") .exchange() .expectStatus().isOk() .expectBody(String.class).isEqualTo("Hello World"); } } ``` ```kotlin import org.assertj.core.api.Assertions.assertThat import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.resttestclient.autoconfigure.AutoConfigureRestTestClient import org.springframework.boot.test.context.SpringBootTest import org.springframework.boot.webmvc.test.autoconfigure.AutoConfigureMockMvc import org.springframework.boot.webtestclient.autoconfigure.AutoConfigureWebTestClient import org.springframework.test.web.reactive.server.WebTestClient import org.springframework.test.web.reactive.server.expectBody import org.springframework.test.web.servlet.MockMvc import org.springframework.test.web.servlet.assertj.MockMvcTester import org.springframework.test.web.servlet.client.RestTestClient import org.springframework.test.web.servlet.client.assertj.RestTestClientResponse import org.springframework.test.web.servlet.client.expectBody import org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get import org.springframework.test.web.servlet.result.MockMvcResultMatchers.content import org.springframework.test.web.servlet.result.MockMvcResultMatchers.status @SpringBootTest @AutoConfigureMockMvc @AutoConfigureRestTestClient @AutoConfigureWebTestClient class MyMockMvcTests { @Test fun testWithMockMvc(@Autowired mvc: MockMvc) { mvc.perform(get("/")) .andExpect(status().isOk()) .andExpect(content().string("Hello World")) } @Test // If AssertJ is on the classpath, you can use MockMvcTester fun testWithMockMvcTester(@Autowired mvc: MockMvcTester) { assertThat(mvc.get().uri("/")).hasStatusOk() .hasBodyTextEqualTo("Hello World") } @Test fun testWithRestTestClient(@Autowired webClient: RestTestClient) { webClient .get().uri("/") .exchange() .expectStatus().isOk .expectBody().isEqualTo("Hello World") } @Test // If you prefer AssertJ, dedicated assertions are available fun testWithRestTestClientAssertJ(@Autowired webClient: RestTestClient) { val spec = webClient.get().uri("/").exchange() val response = RestTestClientResponse.from(spec) assertThat(response).hasStatusOk().bodyText().isEqualTo("Hello World") } @Test // If Spring WebFlux is on the classpath fun testWithWebTestClient(@Autowired webClient: WebTestClient) { webClient .get().uri("/") .exchange() .expectStatus().isOk .expectBody().isEqualTo("Hello World") } } ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you want to focus only on the web layer and not start a complete [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html), consider [using ](#testing.spring-boot-applications.spring-mvc-tests)[`@WebMvcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/test/autoconfigure/WebMvcTest.html) instead. | With Spring WebFlux endpoints, you can use [`WebTestClient`](https://docs.spring.io/spring-framework/reference/7.0/testing/webtestclient.html) as shown in the following example: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.webtestclient.autoconfigure.AutoConfigureWebTestClient; import org.springframework.test.web.reactive.server.WebTestClient; @SpringBootTest @AutoConfigureWebTestClient class MyMockWebTestClientTests { @Test void exampleTest(@Autowired WebTestClient webClient) { webClient .get().uri("/") .exchange() .expectStatus().isOk() .expectBody(String.class).isEqualTo("Hello World"); } } ``` ```kotlin import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.test.context.SpringBootTest import org.springframework.boot.webtestclient.autoconfigure.AutoConfigureWebTestClient import org.springframework.test.web.reactive.server.WebTestClient import org.springframework.test.web.reactive.server.expectBody @SpringBootTest @AutoConfigureWebTestClient class MyMockWebTestClientTests { @Test fun exampleTest(@Autowired webClient: WebTestClient) { webClient .get().uri("/") .exchange() .expectStatus().isOk .expectBody().isEqualTo("Hello World") } } ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Testing within a mocked environment is usually faster than running with a full servlet container. However, since mocking occurs at the Spring MVC layer, code that relies on lower-level servlet container behavior cannot be directly tested with MockMvc.For example, Spring Boot’s error handling is based on the “error page” support provided by the servlet container. This means that, whilst you can test your MVC layer throws and handles exceptions as expected, you cannot directly test that a specific [custom error page](../web/servlet.html#web.servlet.spring-mvc.error-handling.error-pages) is rendered. If you need to test these lower-level concerns, you can start a fully running server as described in the next section. | ## [](#testing.spring-boot-applications.with-running-server)Testing With a Running Server If you need to start a full running server, we recommend that you use random ports. If you use `@SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT)`, an available port is picked at random each time your test runs. The [`@LocalServerPort`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/web/server/LocalServerPort.html) annotation can be used to [inject the actual port used](../../how-to/webserver.html#howto.webserver.discover-port) into your test. Tests that need to make REST calls to the started server can autowire a [`RestTestClient`](https://docs.spring.io/spring-framework/reference/7.0/testing/resttestclient.html) by annotating the test class with [`@AutoConfigureRestTestClient`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/resttestclient/autoconfigure/AutoConfigureRestTestClient.html). The configured client resolves relative links to the running server and comes with a dedicated API for verifying responses, as shown in the following example: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.resttestclient.autoconfigure.AutoConfigureRestTestClient; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest.WebEnvironment; import org.springframework.test.web.servlet.client.RestTestClient; @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) @AutoConfigureRestTestClient class MyRandomPortRestTestClientTests { @Test void exampleTest(@Autowired RestTestClient restClient) { restClient .get().uri("/") .exchange() .expectStatus().isOk() .expectBody(String.class).isEqualTo("Hello World"); } } ``` ```kotlin import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.resttestclient.autoconfigure.AutoConfigureRestTestClient import org.springframework.boot.test.context.SpringBootTest import org.springframework.boot.test.context.SpringBootTest.WebEnvironment import org.springframework.test.web.servlet.client.RestTestClient import org.springframework.test.web.servlet.client.expectBody @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) @AutoConfigureRestTestClient class MyRandomPortRestTestClientTests { @Test fun exampleTest(@Autowired webClient: RestTestClient) { webClient .get().uri("/") .exchange() .expectStatus().isOk .expectBody().isEqualTo("Hello World") } } ``` If you prefer to use AssertJ, dedicated assertions are available from [`RestTestClientResponse`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/client/assertj/RestTestClientResponse.html), as shown in the following example: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.resttestclient.autoconfigure.AutoConfigureRestTestClient; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest.WebEnvironment; import org.springframework.test.web.servlet.client.RestTestClient; import org.springframework.test.web.servlet.client.RestTestClient.ResponseSpec; import org.springframework.test.web.servlet.client.assertj.RestTestClientResponse; import static org.assertj.core.api.Assertions.assertThat; @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) @AutoConfigureRestTestClient class MyRandomPortRestTestClientAssertJTests { @Test void exampleTest(@Autowired RestTestClient restClient) { ResponseSpec spec = restClient.get().uri("/").exchange(); RestTestClientResponse response = RestTestClientResponse.from(spec); assertThat(response).hasStatusOk().bodyText().isEqualTo("Hello World"); } } ``` ```kotlin import org.assertj.core.api.Assertions.assertThat import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.resttestclient.autoconfigure.AutoConfigureRestTestClient import org.springframework.boot.test.context.SpringBootTest import org.springframework.boot.test.context.SpringBootTest.WebEnvironment import org.springframework.test.web.servlet.client.RestTestClient import org.springframework.test.web.servlet.client.assertj.RestTestClientResponse @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) @AutoConfigureRestTestClient class MyRandomPortRestTestClientAssertJTests { @Test fun exampleTest(@Autowired webClient: RestTestClient) { val exchange = webClient.get().uri("/").exchange() val response = RestTestClientResponse.from(exchange) assertThat(response).hasStatusOk() .bodyText().isEqualTo("Hello World") } } ``` If you have `spring-webflux` on the classpath, you can also autowire a [`WebTestClient`](https://docs.spring.io/spring-framework/reference/7.0/testing/webtestclient.html) by annotating the test class with [`@AutoConfigureWebTestClient`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webtestclient/autoconfigure/AutoConfigureWebTestClient.html). `WebTestClient` provides a similar API, as shown in the following example: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest.WebEnvironment; import org.springframework.boot.webtestclient.autoconfigure.AutoConfigureWebTestClient; import org.springframework.test.web.reactive.server.WebTestClient; @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) @AutoConfigureWebTestClient class MyRandomPortWebTestClientTests { @Test void exampleTest(@Autowired WebTestClient webClient) { webClient .get().uri("/") .exchange() .expectStatus().isOk() .expectBody(String.class).isEqualTo("Hello World"); } } ``` ```kotlin import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.test.context.SpringBootTest import org.springframework.boot.test.context.SpringBootTest.WebEnvironment import org.springframework.boot.webtestclient.autoconfigure.AutoConfigureWebTestClient import org.springframework.test.web.reactive.server.WebTestClient import org.springframework.test.web.reactive.server.expectBody @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) @AutoConfigureWebTestClient class MyRandomPortWebTestClientTests { @Test fun exampleTest(@Autowired webClient: WebTestClient) { webClient .get().uri("/") .exchange() .expectStatus().isOk .expectBody().isEqualTo("Hello World") } } ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | [`WebTestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/reactive/server/WebTestClient.html) can also be used with a [mock environment](#testing.spring-boot-applications.with-mock-environment), removing the need for a running server, by annotating your test class with [`@AutoConfigureWebTestClient`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webtestclient/autoconfigure/AutoConfigureWebTestClient.html) from `spring-boot-webflux-test`. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | For certain [sliced tests](#testing.spring-boot-applications.autoconfigured-tests) you may need to use the [`@AutoConfigureWebServer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/test/AutoConfigureWebServer.html) annotation to auto-configure an embedded web server. | The `spring-boot-resttestclient` module also provides a [`TestRestTemplate`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/resttestclient/TestRestTemplate.html) facility: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.resttestclient.TestRestTemplate; import org.springframework.boot.resttestclient.autoconfigure.AutoConfigureTestRestTemplate; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest.WebEnvironment; import static org.assertj.core.api.Assertions.assertThat; @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) @AutoConfigureTestRestTemplate class MyRandomPortTestRestTemplateTests { @Test void exampleTest(@Autowired TestRestTemplate restTemplate) { String body = restTemplate.getForObject("/", String.class); assertThat(body).isEqualTo("Hello World"); } } ``` ```kotlin import org.assertj.core.api.Assertions.assertThat import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.test.context.SpringBootTest import org.springframework.boot.test.context.SpringBootTest.WebEnvironment import org.springframework.boot.resttestclient.TestRestTemplate import org.springframework.boot.resttestclient.autoconfigure.AutoConfigureTestRestTemplate @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) @AutoConfigureTestRestTemplate class MyRandomPortTestRestTemplateTests { @Test fun exampleTest(@Autowired restTemplate: TestRestTemplate) { val body = restTemplate.getForObject("/", String::class.java) assertThat(body).isEqualTo("Hello World") } } ``` To use `TestRestTemplate` a dependency on `spring-boot-restclient` is also required. Take care when adding this dependency as it will enable auto-configuration for `RestClient.Builder`. If your main code uses `RestClient.Builder`, declare the `spring-boot-restclient` dependency so that it is on your application’s main classpath and not only on its test classpath. ## [](#testing.spring-boot-applications.customizing-rest-test-client)Customizing RestTestClient To customize the [`RestTestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/client/RestTestClient.html) bean, configure a [`RestTestClientBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/resttestclient/autoconfigure/RestTestClientBuilderCustomizer.html) bean. Any such beans are called with the [`RestTestClient.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/client/RestTestClient.Builder.html) that is used to create the [`RestTestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/client/RestTestClient.html). ## [](#testing.spring-boot-applications.customizing-web-test-client)Customizing WebTestClient To customize the [`WebTestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/reactive/server/WebTestClient.html) bean, configure a [`WebTestClientBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webtestclient/autoconfigure/WebTestClientBuilderCustomizer.html) bean. Any such beans are called with the [`WebTestClient.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/reactive/server/WebTestClient.Builder.html) that is used to create the [`WebTestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/reactive/server/WebTestClient.html). ## [](#testing.spring-boot-applications.jmx)Using JMX As the test context framework caches context, JMX is disabled by default to prevent identical components to register on the same domain. If such test needs access to an [`MBeanServer`](https://docs.oracle.com/en/java/javase/17/docs/api/java.management/javax/management/MBeanServer.html), consider marking it dirty as well: * Java * Kotlin ```java import javax.management.MBeanServer; import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.annotation.DirtiesContext; import static org.assertj.core.api.Assertions.assertThat; @SpringBootTest(properties = "spring.jmx.enabled=true") @DirtiesContext class MyJmxTests { @Autowired private MBeanServer mBeanServer; @Test void exampleTest() { assertThat(this.mBeanServer.getDomains()).contains("java.lang"); // ... } } ``` ```kotlin import javax.management.MBeanServer import org.assertj.core.api.Assertions.assertThat import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.test.context.SpringBootTest import org.springframework.test.annotation.DirtiesContext @SpringBootTest(properties = ["spring.jmx.enabled=true"]) @DirtiesContext class MyJmxTests(@Autowired val mBeanServer: MBeanServer) { @Test fun exampleTest() { assertThat(mBeanServer.domains).contains("java.lang") // ... } } ``` ## [](#testing.spring-boot-applications.observations)Using Observations If you annotate [a sliced test](#testing.spring-boot-applications.autoconfigured-tests) with [`@AutoConfigureTracing`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/tracing/test/autoconfigure/AutoConfigureTracing.html) from `spring-boot-micrometer-tracing-test` or with [`@AutoConfigureMetrics`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/metrics/test/autoconfigure/AutoConfigureMetrics.html) from `spring-boot-micrometer-metrics-test`, it auto-configures an [`ObservationRegistry`](https://javadoc.io/doc/io.micrometer/micrometer-observation/1.17.1/io/micrometer/observation/ObservationRegistry.html). ## [](#testing.spring-boot-applications.metrics)Using Metrics Regardless of your classpath, meter registries, except the in-memory backed, are not auto-configured when using [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html). If you need to export metrics to a different backend as part of an integration test, annotate it with [`@AutoConfigureMetrics`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/metrics/test/autoconfigure/AutoConfigureMetrics.html). If you annotate [a sliced test](#testing.spring-boot-applications.autoconfigured-tests) with [`@AutoConfigureMetrics`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/metrics/test/autoconfigure/AutoConfigureMetrics.html), it auto-configures an in-memory [`MeterRegistry`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/instrument/MeterRegistry.html). Data exporting in sliced tests is not supported with the [`@AutoConfigureMetrics`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/metrics/test/autoconfigure/AutoConfigureMetrics.html) annotation. ## [](#testing.spring-boot-applications.tracing)Using Tracing Regardless of your classpath, tracing components which are reporting data are not auto-configured when using [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html). If you need those components as part of an integration test, annotate the test with [`@AutoConfigureTracing`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/tracing/test/autoconfigure/AutoConfigureTracing.html). If you have created your own reporting components (e.g. a custom [`SpanExporter`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-trace/1.62.0/io/opentelemetry/sdk/trace/export/SpanExporter.html) or `brave.handler.SpanHandler`) and you don’t want them to be active in tests, you can use the [`@ConditionalOnEnabledTracingExport`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/tracing/autoconfigure/ConditionalOnEnabledTracingExport.html) annotation to disable them. If you annotate [a sliced test](#testing.spring-boot-applications.autoconfigured-tests) with [`@AutoConfigureTracing`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/tracing/test/autoconfigure/AutoConfigureTracing.html) , it auto-configures a no-op [`Tracer`](https://javadoc.io/doc/io.micrometer/micrometer-tracing/1.7.1/io/micrometer/tracing/Tracer.html). Data exporting in sliced tests is not supported with the [`@AutoConfigureTracing`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/tracing/test/autoconfigure/AutoConfigureTracing.html) annotation. ## [](#testing.spring-boot-applications.mocking-beans)Mocking and Spying Beans When running tests, it is sometimes necessary to mock certain components within your application context. For example, you may have a facade over some remote service that is unavailable during development. Mocking can also be useful when you want to simulate failures that might be hard to trigger in a real environment. Spring Framework includes a [`@MockitoBean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/context/bean/override/mockito/MockitoBean.html) annotation that can be used to define a Mockito mock for a bean inside your [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html). Additionally, [`@MockitoSpyBean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/context/bean/override/mockito/MockitoSpyBean.html) can be used to define a Mockito spy. Learn more about these features in the [Spring Framework documentation](https://docs.spring.io/spring-framework/reference/7.0/testing/annotations/integration-spring/annotation-mockitobean.html). ## [](#testing.spring-boot-applications.autoconfigured-tests)Auto-configured Tests Spring Boot’s auto-configuration system works well for applications but can sometimes be a little too much for tests. It often helps to load only the parts of the configuration that are required to test a “slice” of your application. For example, you might want to test that Spring MVC controllers are mapping URLs correctly, and you do not want to involve database calls in those tests, or you might want to test JPA entities, and you are not interested in the web layer when those tests run. When combined with `spring-boot-test-autoconfigure`, Spring Boot’s [test modules](test-modules.html) include a number of annotations that can be used to automatically configure such “slices”. Each of them works in a similar way, providing a `@…​Test` annotation that loads the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) and one or more `@AutoConfigure…​` annotations that can be used to customize auto-configuration settings. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Each slice restricts component scan to appropriate components and loads a very restricted set of auto-configuration classes. If you need to exclude one of them, most `@…​Test` annotations provide an `excludeAutoConfiguration` attribute. Alternatively, you can use `@ImportAutoConfiguration#exclude`. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Including multiple “slices” by using several `@…​Test` annotations in one test is not supported. If you need multiple “slices”, pick one of the `@…​Test` annotations and include the `@AutoConfigure…​` annotations of the other “slices” by hand. | | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | It is also possible to use the `@AutoConfigure…​` annotations with the standard [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html) annotation. You can use this combination if you are not interested in “slicing” your application but you want some of the auto-configured test beans. | ## [](#testing.spring-boot-applications.json-tests)Auto-configured JSON Tests To test that object JSON serialization and deserialization is working as expected, you can use the [`@JsonTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/autoconfigure/json/JsonTest.html) annotation from the `spring-boot-test-autoconfigure` module. [`@JsonTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/autoconfigure/json/JsonTest.html) auto-configures the available supported JSON mapper, which can be one of the following libraries: * Jackson [`JsonMapper`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.html), any [`@JacksonComponent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson/JacksonComponent.html) beans and any Jackson [`JacksonModule`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/JacksonModule.html) * Jackson 2 (deprecated) [`ObjectMapper`](https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-databind/2.21.5/com/fasterxml/jackson/databind/ObjectMapper.html), any [`@JsonComponent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson2/JsonComponent.html) beans and any Jackson [`Module`](https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-databind/2.21.5/com/fasterxml/jackson/databind/Module.html) * `Gson` * `Jsonb` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | A list of the auto-configurations that are enabled by [`@JsonTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/autoconfigure/json/JsonTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | If you need to configure elements of the auto-configuration, you can use the [`@AutoConfigureJsonTesters`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/autoconfigure/json/AutoConfigureJsonTesters.html) annotation. Spring Boot includes AssertJ-based helpers that work with the JSONAssert and JsonPath libraries to check that JSON appears as expected. The [`JacksonTester`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/json/JacksonTester.html), [`GsonTester`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/json/GsonTester.html), [`JsonbTester`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/json/JsonbTester.html), and [`BasicJsonTester`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/json/BasicJsonTester.html) classes can be used for Jackson, Gson, Jsonb, and Strings respectively. Any helper fields on the test class can be [`@Autowired`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Autowired.html) when using [`@JsonTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/autoconfigure/json/JsonTest.html). The following example shows a test class for Jackson: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.autoconfigure.json.JsonTest; import org.springframework.boot.test.json.JacksonTester; import static org.assertj.core.api.Assertions.assertThat; @JsonTest class MyJsonTests { @Autowired private JacksonTester json; @Test void serialize() throws Exception { VehicleDetails details = new VehicleDetails("Honda", "Civic"); // Assert against a `.json` file in the same package as the test assertThat(this.json.write(details)).isEqualToJson("expected.json"); // Or use JSON path based assertions assertThat(this.json.write(details)).hasJsonPathStringValue("@.make"); assertThat(this.json.write(details)).extractingJsonPathStringValue("@.make").isEqualTo("Honda"); } @Test void deserialize() throws Exception { String content = "{\"make\":\"Ford\",\"model\":\"Focus\"}"; assertThat(this.json.parse(content)).isEqualTo(new VehicleDetails("Ford", "Focus")); assertThat(this.json.parseObject(content).getMake()).isEqualTo("Ford"); } } ``` ```kotlin import org.assertj.core.api.Assertions.assertThat import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.test.autoconfigure.json.JsonTest import org.springframework.boot.test.json.JacksonTester @JsonTest class MyJsonTests(@Autowired val json: JacksonTester) { @Test fun serialize() { val details = VehicleDetails("Honda", "Civic") // Assert against a `.json` file in the same package as the test assertThat(json.write(details)).isEqualToJson("expected.json") // Or use JSON path based assertions assertThat(json.write(details)).hasJsonPathStringValue("@.make") assertThat(json.write(details)).extractingJsonPathStringValue("@.make").isEqualTo("Honda") } @Test fun deserialize() { val content = "{\"make\":\"Ford\",\"model\":\"Focus\"}" assertThat(json.parse(content)).isEqualTo(VehicleDetails("Ford", "Focus")) assertThat(json.parseObject(content).make).isEqualTo("Ford") } } ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | JSON helper classes can also be used directly in standard unit tests. To do so, call the `initFields` method of the helper in your [`@BeforeEach`](https://junit.org/junit5/docs/6.0.3/api/org.junit.jupiter.api/org/junit/jupiter/api/BeforeEach.html) method if you do not use [`@JsonTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/autoconfigure/json/JsonTest.html). | If you use Spring Boot’s AssertJ-based helpers to assert on a number value at a given JSON path, you might not be able to use `isEqualTo` depending on the type. Instead, you can use AssertJ’s `satisfies` to assert that the value matches the given condition. For instance, the following example asserts that the actual number is a float value close to `0.15` within an offset of `0.01`. * Java * Kotlin ```java @Test void someTest() throws Exception { SomeObject value = new SomeObject(0.152f); assertThat(this.json.write(value)).extractingJsonPathNumberValue("@.test.numberValue") .satisfies((number) -> assertThat(number.floatValue()).isCloseTo(0.15f, within(0.01f))); } ``` ```kotlin @Test fun someTest() { val value = SomeObject(0.152f) assertThat(json.write(value)).extractingJsonPathNumberValue("@.test.numberValue") .satisfies(ThrowingConsumer { number -> assertThat(number.toFloat()).isCloseTo(0.15f, within(0.01f)) }) } ``` ## [](#testing.spring-boot-applications.spring-mvc-tests)Auto-configured Spring MVC Tests To test whether Spring MVC controllers are working as expected, use the [`@WebMvcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/test/autoconfigure/WebMvcTest.html) annotation from the `spring-boot-webmvc-test` module. [`@WebMvcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/test/autoconfigure/WebMvcTest.html) auto-configures the Spring MVC infrastructure and limits scanned beans to [`@Controller`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Controller.html), [`@ControllerAdvice`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/ControllerAdvice.html), [`@JacksonComponent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson/JacksonComponent.html), [`@JsonComponent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson2/JsonComponent.html) (deprecated), [`Converter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/convert/converter/Converter.html), [`GenericConverter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/convert/converter/GenericConverter.html), [`Filter`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Filter.html), [`HandlerInterceptor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/HandlerInterceptor.html), [`WebMvcConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.html), [`WebMvcRegistrations`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/autoconfigure/WebMvcRegistrations.html), and [`HandlerMethodArgumentResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/method/support/HandlerMethodArgumentResolver.html). Regular [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) and [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans are not scanned when the [`@WebMvcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/test/autoconfigure/WebMvcTest.html) annotation is used. [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) can be used to include [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | A list of the auto-configuration settings that are enabled by [`@WebMvcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/test/autoconfigure/WebMvcTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you need to register extra components, such as a [`JacksonModule`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/JacksonModule.html), you can import additional configuration classes by using [`@Import`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Import.html) on your test. | Often, [`@WebMvcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/test/autoconfigure/WebMvcTest.html) is limited to a single controller and is used in combination with [`@MockitoBean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/context/bean/override/mockito/MockitoBean.html) to provide mock implementations for required collaborators. [`@WebMvcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/test/autoconfigure/WebMvcTest.html) also auto-configures [`MockMvc`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/MockMvc.html). Mock MVC offers a powerful way to quickly test MVC controllers without needing to start a full HTTP server. If AssertJ is available, the AssertJ support provided by [`MockMvcTester`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/assertj/MockMvcTester.html) is auto-configured as well. If you’d like to use [`RestTestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/client/RestTestClient.html) in your tests, annotate your test class with [`@AutoConfigureRestTestClient`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/resttestclient/autoconfigure/AutoConfigureRestTestClient.html). A `RestTestClient` that uses the Mock MVC infrastructure will then be auto-configured. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | You can also auto-configure [`MockMvc`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/MockMvc.html) and [`MockMvcTester`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/assertj/MockMvcTester.html) in a non-`@WebMvcTest` (such as [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html)) by annotating it with [`@AutoConfigureMockMvc`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/test/autoconfigure/AutoConfigureMockMvc.html). The following example uses [`MockMvcTester`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/assertj/MockMvcTester.html): | * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.webmvc.test.autoconfigure.WebMvcTest; import org.springframework.http.MediaType; import org.springframework.test.context.bean.override.mockito.MockitoBean; import org.springframework.test.web.servlet.assertj.MockMvcTester; import static org.assertj.core.api.Assertions.assertThat; import static org.mockito.BDDMockito.given; @WebMvcTest(UserVehicleController.class) class MyControllerTests { @Autowired private MockMvcTester mvc; @MockitoBean private UserVehicleService userVehicleService; @Test void testExample() { given(this.userVehicleService.getVehicleDetails("sboot")) .willReturn(new VehicleDetails("Honda", "Civic")); assertThat(this.mvc.get().uri("/sboot/vehicle").accept(MediaType.TEXT_PLAIN)) .hasStatusOk() .hasBodyTextEqualTo("Honda Civic"); } } ``` ```kotlin import org.assertj.core.api.Assertions.assertThat import org.junit.jupiter.api.Test import org.mockito.BDDMockito.given import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.webmvc.test.autoconfigure.WebMvcTest import org.springframework.http.MediaType import org.springframework.test.context.bean.override.mockito.MockitoBean import org.springframework.test.web.servlet.assertj.MockMvcTester @WebMvcTest(UserVehicleController::class) class MyControllerTests(@Autowired val mvc: MockMvcTester) { @MockitoBean lateinit var userVehicleService: UserVehicleService @Test fun testExample() { given(userVehicleService.getVehicleDetails("sboot")) .willReturn(VehicleDetails("Honda", "Civic")) assertThat(mvc.get().uri("/sboot/vehicle").accept(MediaType.TEXT_PLAIN)) .hasStatusOk().hasBodyTextEqualTo("Honda Civic") } } ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you need to configure elements of the auto-configuration (for example, when servlet filters should be applied) you can use attributes in the [`@AutoConfigureMockMvc`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/test/autoconfigure/AutoConfigureMockMvc.html) annotation. | If you use HtmlUnit and Selenium, auto-configuration also provides an HtmlUnit [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html) bean and/or a Selenium [`WebDriver`](https://www.selenium.dev/selenium/docs/api/java/org/openqa/selenium/WebDriver.html) bean. The following example uses HtmlUnit: * Java * Kotlin ```java import org.htmlunit.WebClient; import org.htmlunit.html.HtmlPage; import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.webmvc.test.autoconfigure.WebMvcTest; import org.springframework.test.context.bean.override.mockito.MockitoBean; import static org.assertj.core.api.Assertions.assertThat; import static org.mockito.BDDMockito.given; @WebMvcTest(UserVehicleController.class) class MyHtmlUnitTests { @Autowired private WebClient webClient; @MockitoBean private UserVehicleService userVehicleService; @Test void testExample() throws Exception { given(this.userVehicleService.getVehicleDetails("sboot")).willReturn(new VehicleDetails("Honda", "Civic")); HtmlPage page = this.webClient.getPage("/sboot/vehicle.html"); assertThat(page.getBody().getTextContent()).isEqualTo("Honda Civic"); } } ``` ```kotlin import org.assertj.core.api.Assertions.assertThat import org.htmlunit.WebClient import org.htmlunit.html.HtmlPage import org.junit.jupiter.api.Test import org.mockito.BDDMockito.given import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.webmvc.test.autoconfigure.WebMvcTest import org.springframework.test.context.bean.override.mockito.MockitoBean @WebMvcTest(UserVehicleController::class) class MyHtmlUnitTests(@Autowired val webClient: WebClient) { @MockitoBean lateinit var userVehicleService: UserVehicleService @Test fun testExample() { given(userVehicleService.getVehicleDetails("sboot")).willReturn(VehicleDetails("Honda", "Civic")) val page = webClient.getPage("/sboot/vehicle.html") assertThat(page.body.textContent).isEqualTo("Honda Civic") } } ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | By default, Spring Boot puts [`WebDriver`](https://www.selenium.dev/selenium/docs/api/java/org/openqa/selenium/WebDriver.html) beans in a special “scope” to ensure that the driver exits after each test and that a new instance is injected. If you do not want this behavior, you can add `@Scope(ConfigurableBeanFactory.SCOPE_SINGLETON)` to your [`WebDriver`](https://www.selenium.dev/selenium/docs/api/java/org/openqa/selenium/WebDriver.html) [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) definition. | | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The `webDriver` scope created by Spring Boot will replace any user defined scope of the same name. If you define your own `webDriver` scope you may find it stops working when you use [`@WebMvcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/test/autoconfigure/WebMvcTest.html). | If you have Spring Security on the classpath, [`@WebMvcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/test/autoconfigure/WebMvcTest.html) will also scan [`WebSecurityConfigurer`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/config/annotation/web/WebSecurityConfigurer.html) beans. Instead of disabling security completely for such tests, you can use Spring Security’s test support. More details on how to use Spring Security’s [`MockMvc`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/MockMvc.html) support can be found in this [Testing With Spring Security](../../how-to/testing.html#howto.testing.with-spring-security) “How-to Guides” section. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Sometimes writing Spring MVC tests is not enough; Spring Boot can help you run [full end-to-end tests with an actual server](#testing.spring-boot-applications.with-running-server). | ## [](#testing.spring-boot-applications.spring-webflux-tests)Auto-configured Spring WebFlux Tests To test that [Spring WebFlux](https://docs.spring.io/spring-framework/reference/7.0/web-reactive.html) controllers are working as expected, you can use the [`@WebFluxTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webflux/test/autoconfigure/WebFluxTest.html) annotation from the `spring-boot-webflux-test` module. [`@WebFluxTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webflux/test/autoconfigure/WebFluxTest.html) auto-configures the Spring WebFlux infrastructure and limits scanned beans to [`@Controller`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Controller.html), [`@ControllerAdvice`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/ControllerAdvice.html), [`@JacksonComponent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson/JacksonComponent.html), [`@JsonComponent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson2/JsonComponent.html) (deprecated), [`Converter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/convert/converter/Converter.html), [`GenericConverter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/convert/converter/GenericConverter.html) and [`WebFluxConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/config/WebFluxConfigurer.html). Regular [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) and [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans are not scanned when the [`@WebFluxTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webflux/test/autoconfigure/WebFluxTest.html) annotation is used. [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) can be used to include [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | A list of the auto-configurations that are enabled by [`@WebFluxTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webflux/test/autoconfigure/WebFluxTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you need to register extra components, such as a [`JacksonModule`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/JacksonModule.html), you can import additional configuration classes using [`@Import`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Import.html) on your test. | Often, [`@WebFluxTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webflux/test/autoconfigure/WebFluxTest.html) is limited to a single controller and used in combination with the [`@MockitoBean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/context/bean/override/mockito/MockitoBean.html) annotation to provide mock implementations for required collaborators. [`@WebFluxTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webflux/test/autoconfigure/WebFluxTest.html) also auto-configures [`WebTestClient`](https://docs.spring.io/spring-framework/reference/7.0/testing/webtestclient.html), which offers a powerful way to quickly test WebFlux controllers without needing to start a full HTTP server. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can also auto-configure [`WebTestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/reactive/server/WebTestClient.html) in a non-`@WebFluxTest` (such as [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html)) by annotating it with [`@AutoConfigureWebTestClient`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webtestclient/autoconfigure/AutoConfigureWebTestClient.html). | The following example shows a class that uses both [`@WebFluxTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webflux/test/autoconfigure/WebFluxTest.html) and a [`WebTestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/reactive/server/WebTestClient.html): * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.webflux.test.autoconfigure.WebFluxTest; import org.springframework.http.MediaType; import org.springframework.test.context.bean.override.mockito.MockitoBean; import org.springframework.test.web.reactive.server.WebTestClient; import static org.mockito.BDDMockito.given; @WebFluxTest(UserVehicleController.class) class MyControllerTests { @Autowired private WebTestClient webClient; @MockitoBean private UserVehicleService userVehicleService; @Test void testExample() { given(this.userVehicleService.getVehicleDetails("sboot")) .willReturn(new VehicleDetails("Honda", "Civic")); this.webClient.get().uri("/sboot/vehicle").accept(MediaType.TEXT_PLAIN).exchange() .expectStatus().isOk() .expectBody(String.class).isEqualTo("Honda Civic"); } } ``` ```kotlin import org.junit.jupiter.api.Test import org.mockito.BDDMockito.given import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.webflux.test.autoconfigure.WebFluxTest import org.springframework.http.MediaType import org.springframework.test.context.bean.override.mockito.MockitoBean import org.springframework.test.web.reactive.server.WebTestClient import org.springframework.test.web.reactive.server.expectBody @WebFluxTest(UserVehicleController::class) class MyControllerTests(@Autowired val webClient: WebTestClient) { @MockitoBean lateinit var userVehicleService: UserVehicleService @Test fun testExample() { given(userVehicleService.getVehicleDetails("sboot")) .willReturn(VehicleDetails("Honda", "Civic")) webClient.get().uri("/sboot/vehicle").accept(MediaType.TEXT_PLAIN).exchange() .expectStatus().isOk .expectBody().isEqualTo("Honda Civic") } } ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | This setup is only supported by WebFlux applications as using [`WebTestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/reactive/server/WebTestClient.html) in a mocked web application only works with WebFlux at the moment. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | [`@WebFluxTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webflux/test/autoconfigure/WebFluxTest.html) cannot detect routes registered through the functional web framework. For testing [`RouterFunction`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/server/RouterFunction.html) beans in the context, consider importing your [`RouterFunction`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/server/RouterFunction.html) yourself by using [`@Import`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Import.html) or by using [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html). | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | [`@WebFluxTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webflux/test/autoconfigure/WebFluxTest.html) cannot detect custom security configuration registered as a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) of type [`SecurityWebFilterChain`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/server/SecurityWebFilterChain.html). To include that in your test, you will need to import the configuration that registers the bean by using [`@Import`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Import.html) or by using [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html). | | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Sometimes writing Spring WebFlux tests is not enough; Spring Boot can help you run [full end-to-end tests with an actual server](#testing.spring-boot-applications.with-running-server). | ## [](#testing.spring-boot-applications.spring-graphql-tests)Auto-configured Spring GraphQL Tests Spring GraphQL offers a dedicated testing support module; you’ll need to add it to your project: Maven ```xml org.springframework.graphql spring-graphql-test test org.springframework.boot spring-boot-starter-webflux test ``` Gradle ```gradle dependencies { testImplementation("org.springframework.graphql:spring-graphql-test") // Unless already present in the implementation configuration testImplementation("org.springframework.boot:spring-boot-starter-webflux") } ``` This testing module ships the [GraphQlTester](https://docs.spring.io/spring-graphql/reference/2.0/testing.html#testing.graphqltester). The tester is heavily used in test, so be sure to become familiar with using it. There are [`GraphQlTester`](https://docs.spring.io/spring-graphql/docs/2.0.x/api/org/springframework/graphql/test/tester/GraphQlTester.html) variants and Spring Boot will auto-configure them depending on the type of tests: * the [`ExecutionGraphQlServiceTester`](https://docs.spring.io/spring-graphql/docs/2.0.x/api/org/springframework/graphql/test/tester/ExecutionGraphQlServiceTester.html) performs tests on the server side, without a client nor a transport * the [`HttpGraphQlTester`](https://docs.spring.io/spring-graphql/docs/2.0.x/api/org/springframework/graphql/test/tester/HttpGraphQlTester.html) performs tests with a client that connects to a server, with or without a live server Spring Boot helps you to test your [Spring GraphQL Controllers](https://docs.spring.io/spring-graphql/reference/2.0/controllers.html) with the [`@GraphQlTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/graphql/test/autoconfigure/GraphQlTest.html) annotation from the `spring-boot-graphql-test` module. [`@GraphQlTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/graphql/test/autoconfigure/GraphQlTest.html) auto-configures the Spring GraphQL infrastructure, without any transport nor server being involved. This limits scanned beans to [`@Controller`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Controller.html), [`@ControllerAdvice`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/ControllerAdvice.html), [`RuntimeWiringConfigurer`](https://docs.spring.io/spring-graphql/docs/2.0.x/api/org/springframework/graphql/execution/RuntimeWiringConfigurer.html), [`JacksonComponent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson/JacksonComponent.html), [`@JsonComponent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson2/JsonComponent.html) (deprecated), [`Converter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/convert/converter/Converter.html), [`GenericConverter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/convert/converter/GenericConverter.html), [`DataFetcherExceptionResolver`](https://docs.spring.io/spring-graphql/docs/2.0.x/api/org/springframework/graphql/execution/DataFetcherExceptionResolver.html), [`Instrumentation`](https://javadoc.io/doc/com.graphql-java/graphql-java/25.0/graphql/execution/instrumentation/Instrumentation.html) and [`GraphQlSourceBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/graphql/autoconfigure/GraphQlSourceBuilderCustomizer.html). Regular [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) and [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans are not scanned when the [`@GraphQlTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/graphql/test/autoconfigure/GraphQlTest.html) annotation is used. [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) can be used to include [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | A list of the auto-configurations that are enabled by [`@GraphQlTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/graphql/test/autoconfigure/GraphQlTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | Often, [`@GraphQlTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/graphql/test/autoconfigure/GraphQlTest.html) is limited to a set of controllers and used in combination with the [`@MockitoBean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/context/bean/override/mockito/MockitoBean.html) annotation to provide mock implementations for required collaborators. * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.docs.web.graphql.runtimewiring.GreetingController; import org.springframework.boot.graphql.test.autoconfigure.GraphQlTest; import org.springframework.graphql.test.tester.GraphQlTester; @GraphQlTest(GreetingController.class) class GreetingControllerTests { @Autowired private GraphQlTester graphQlTester; @Test void shouldGreetWithSpecificName() { this.graphQlTester.document("{ greeting(name: \"Alice\") } ") .execute() .path("greeting") .entity(String.class) .isEqualTo("Hello, Alice!"); } @Test void shouldGreetWithDefaultName() { this.graphQlTester.document("{ greeting } ") .execute() .path("greeting") .entity(String.class) .isEqualTo("Hello, Spring!"); } } ``` ```kotlin import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.docs.web.graphql.runtimewiring.GreetingController import org.springframework.boot.graphql.test.autoconfigure.GraphQlTest import org.springframework.graphql.test.tester.GraphQlTester @GraphQlTest(GreetingController::class) internal class GreetingControllerTests { @Autowired lateinit var graphQlTester: GraphQlTester @Test fun shouldGreetWithSpecificName() { graphQlTester.document("{ greeting(name: \"Alice\") } ").execute().path("greeting").entity(String::class.java) .isEqualTo("Hello, Alice!") } @Test fun shouldGreetWithDefaultName() { graphQlTester.document("{ greeting } ").execute().path("greeting").entity(String::class.java) .isEqualTo("Hello, Spring!") } } ``` [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html) tests are full integration tests and involve the entire application. A [`HttpGraphQlTester`](https://docs.spring.io/spring-graphql/docs/2.0.x/api/org/springframework/graphql/test/tester/HttpGraphQlTester.html) bean can be added by annotating your test class with [`@AutoConfigureHttpGraphQlTester`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/graphql/test/autoconfigure/tester/AutoConfigureHttpGraphQlTester.html) from the `spring-boot-graphql-test` module: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.graphql.test.autoconfigure.tester.AutoConfigureHttpGraphQlTester; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest.WebEnvironment; import org.springframework.graphql.test.tester.HttpGraphQlTester; @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) @AutoConfigureHttpGraphQlTester class GraphQlIntegrationTests { @Test void shouldGreetWithSpecificName(@Autowired HttpGraphQlTester graphQlTester) { HttpGraphQlTester authenticatedTester = graphQlTester.mutate() .webTestClient((client) -> client.defaultHeaders((headers) -> headers.setBasicAuth("admin", "ilovespring"))) .build(); authenticatedTester.document("{ greeting(name: \"Alice\") } ") .execute() .path("greeting") .entity(String.class) .isEqualTo("Hello, Alice!"); } } ``` ```kotlin import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.graphql.test.autoconfigure.tester.AutoConfigureHttpGraphQlTester import org.springframework.boot.test.context.SpringBootTest import org.springframework.boot.test.context.SpringBootTest.WebEnvironment import org.springframework.graphql.test.tester.HttpGraphQlTester import org.springframework.http.HttpHeaders import org.springframework.test.web.reactive.server.WebTestClient @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) @AutoConfigureHttpGraphQlTester class GraphQlIntegrationTests { @Test fun shouldGreetWithSpecificName(@Autowired graphQlTester: HttpGraphQlTester) { val authenticatedTester = graphQlTester.mutate() .webTestClient { client: WebTestClient.Builder -> client.defaultHeaders { headers: HttpHeaders -> headers.setBasicAuth("admin", "ilovespring") } }.build() authenticatedTester.document("{ greeting(name: \"Alice\") } ").execute() .path("greeting").entity(String::class.java).isEqualTo("Hello, Alice!") } } ``` The [`HttpGraphQlTester`](https://docs.spring.io/spring-graphql/docs/2.0.x/api/org/springframework/graphql/test/tester/HttpGraphQlTester.html) bean uses the relevant transport of the integration test. When using a random or defined port, the tester is configured against the live server. To bind the tester to `MockMvc`, make sure to annotate your test class with [`@AutoConfigureMockMvc`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/test/autoconfigure/AutoConfigureMockMvc.html). ## [](#testing.spring-boot-applications.autoconfigured-spring-data-cassandra)Auto-configured Data Cassandra Tests You can use [`@DataCassandraTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/cassandra/test/autoconfigure/DataCassandraTest.html) from the `spring-boot-data-cassandra-test` module to test Data Cassandra applications. By default, it configures a [`CassandraTemplate`](https://docs.spring.io/spring-data/cassandra/docs/5.1.x/api/org/springframework/data/cassandra/core/CassandraTemplate.html), scans for [`@Table`](https://docs.spring.io/spring-data/cassandra/docs/5.1.x/api/org/springframework/data/cassandra/core/mapping/Table.html) classes, and configures Spring Data Cassandra repositories. Regular [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) and [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans are not scanned when the [`@DataCassandraTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/cassandra/test/autoconfigure/DataCassandraTest.html) annotation is used. [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) can be used to include [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans. (For more about using Cassandra with Spring Boot, see [Cassandra](../data/nosql.html#data.nosql.cassandra).) | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | A list of the auto-configuration settings that are enabled by [`@DataCassandraTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/cassandra/test/autoconfigure/DataCassandraTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | The following example shows a typical setup for using Cassandra tests in Spring Boot: * Java * Kotlin ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.data.cassandra.test.autoconfigure.DataCassandraTest; @DataCassandraTest class MyDataCassandraTests { @Autowired private SomeRepository repository; } ``` ```kotlin import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.data.cassandra.test.autoconfigure.DataCassandraTest @DataCassandraTest class MyDataCassandraTests(@Autowired val repository: SomeRepository) ``` ## [](#testing.spring-boot-applications.autoconfigured-spring-data-couchbase)Auto-configured Data Couchbase Tests You can use [`@DataCouchbaseTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/couchbase/test/autoconfigure/DataCouchbaseTest.html) from the `spring-boot-data-couchbase-test` module to test Data Couchbase applications. By default, it configures a [`CouchbaseTemplate`](https://docs.spring.io/spring-data/couchbase/docs/6.1.x/api/org/springframework/data/couchbase/core/CouchbaseTemplate.html) or [`ReactiveCouchbaseTemplate`](https://docs.spring.io/spring-data/couchbase/docs/6.1.x/api/org/springframework/data/couchbase/core/ReactiveCouchbaseTemplate.html), scans for [`@Document`](https://docs.spring.io/spring-data/couchbase/docs/6.1.x/api/org/springframework/data/couchbase/core/mapping/Document.html) classes, and configures Spring Data Couchbase repositories. Regular [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) and [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans are not scanned when the [`@DataCouchbaseTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/couchbase/test/autoconfigure/DataCouchbaseTest.html) annotation is used. [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) can be used to include [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans. (For more about using Couchbase with Spring Boot, see [Couchbase](../data/nosql.html#data.nosql.couchbase), earlier in this chapter.) | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | A list of the auto-configuration settings that are enabled by [`@DataCouchbaseTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/couchbase/test/autoconfigure/DataCouchbaseTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | The following example shows a typical setup for using Couchbase tests in Spring Boot: * Java * Kotlin ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.data.couchbase.test.autoconfigure.DataCouchbaseTest; @DataCouchbaseTest class MyDataCouchbaseTests { @Autowired private SomeRepository repository; // ... } ``` ```kotlin import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.data.couchbase.test.autoconfigure.DataCouchbaseTest @DataCouchbaseTest class MyDataCouchbaseTests(@Autowired val repository: SomeRepository) { // ... } ``` ## [](#testing.spring-boot-applications.autoconfigured-spring-data-elasticsearch)Auto-configured Data Elasticsearch Tests You can use [`@DataElasticsearchTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/elasticsearch/test/autoconfigure/DataElasticsearchTest.html) from the `spring-boot-data-elasticsearch-test` module to test Data Elasticsearch applications. By default, it configures an [`ElasticsearchTemplate`](https://docs.spring.io/spring-data/elasticsearch/docs/6.1.x/api/org/springframework/data/elasticsearch/client/elc/ElasticsearchTemplate.html), scans for [`@Document`](https://docs.spring.io/spring-data/elasticsearch/docs/6.1.x/api/org/springframework/data/elasticsearch/annotations/Document.html) classes, and configures Spring Data Elasticsearch repositories. Regular [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) and [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans are not scanned when the [`@DataElasticsearchTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/elasticsearch/test/autoconfigure/DataElasticsearchTest.html) annotation is used. [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) can be used to include [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans. (For more about using Elasticsearch with Spring Boot, see [Elasticsearch](../data/nosql.html#data.nosql.elasticsearch), earlier in this chapter.) | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | A list of the auto-configuration settings that are enabled by [`@DataElasticsearchTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/elasticsearch/test/autoconfigure/DataElasticsearchTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | The following example shows a typical setup for using Elasticsearch tests in Spring Boot: * Java * Kotlin ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.data.elasticsearch.test.autoconfigure.DataElasticsearchTest; @DataElasticsearchTest class MyDataElasticsearchTests { @Autowired private SomeRepository repository; // ... } ``` ```kotlin import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.data.elasticsearch.test.autoconfigure.DataElasticsearchTest @DataElasticsearchTest class MyDataElasticsearchTests(@Autowired val repository: SomeRepository) { // ... } ``` ## [](#testing.spring-boot-applications.autoconfigured-spring-data-jpa)Auto-configured Data JPA Tests You can use the [`@DataJpaTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/jpa/test/autoconfigure/DataJpaTest.html) annotation from the `spring-boot-data-jpa-test` module to test Data JPA applications. By default, it scans for [`@Entity`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/Entity.html) classes and configures Spring Data JPA repositories. If an embedded database is available on the classpath, it configures one as well. SQL queries are logged by default by setting the `spring.jpa.show-sql` property to `true`. This can be disabled using the `showSql` attribute of the annotation. Regular [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) and [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans are not scanned when the [`@DataJpaTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/jpa/test/autoconfigure/DataJpaTest.html) annotation is used. [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) can be used to include [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | A list of the auto-configuration settings that are enabled by [`@DataJpaTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/jpa/test/autoconfigure/DataJpaTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | By default, data JPA tests are transactional and roll back at the end of each test. See the [relevant section](https://docs.spring.io/spring-framework/reference/7.0/testing/testcontext-framework/tx.html#testcontext-tx-enabling-transactions) in the Spring Framework Reference Documentation for more details. If that is not what you want, you can disable transaction management for a test or for the whole class as follows: * Java * Kotlin ```java import org.springframework.boot.data.jpa.test.autoconfigure.DataJpaTest; import org.springframework.transaction.annotation.Propagation; import org.springframework.transaction.annotation.Transactional; @DataJpaTest @Transactional(propagation = Propagation.NOT_SUPPORTED) class MyNonTransactionalTests { // ... } ``` ```kotlin import org.springframework.boot.data.jpa.test.autoconfigure.DataJpaTest import org.springframework.transaction.annotation.Propagation import org.springframework.transaction.annotation.Transactional @DataJpaTest @Transactional(propagation = Propagation.NOT_SUPPORTED) class MyNonTransactionalTests { // ... } ``` Data JPA tests may also inject a [`TestEntityManager`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jpa/test/autoconfigure/TestEntityManager.html) bean, which provides an alternative to the standard JPA [`EntityManager`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/EntityManager.html) that is specifically designed for tests. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | [`TestEntityManager`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jpa/test/autoconfigure/TestEntityManager.html) can also be auto-configured to any of your Spring-based test class by adding [`@AutoConfigureTestEntityManager`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jpa/test/autoconfigure/AutoConfigureTestEntityManager.html). When doing so, make sure that your test is running in a transaction, for instance by adding [`@Transactional`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/transaction/annotation/Transactional.html) on your test class or method. | A [`JdbcTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/core/JdbcTemplate.html) is also available if you need that. The following example shows the [`@DataJpaTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/jpa/test/autoconfigure/DataJpaTest.html) annotation in use: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.data.jpa.test.autoconfigure.DataJpaTest; import org.springframework.boot.jpa.test.autoconfigure.TestEntityManager; import static org.assertj.core.api.Assertions.assertThat; @DataJpaTest class MyRepositoryTests { @Autowired private TestEntityManager entityManager; @Autowired private UserRepository repository; @Test void testExample() { this.entityManager.persist(new User("sboot", "1234")); User user = this.repository.findByUsername("sboot"); assertThat(user.getUsername()).isEqualTo("sboot"); assertThat(user.getEmployeeNumber()).isEqualTo("1234"); } } ``` ```kotlin import org.assertj.core.api.Assertions.assertThat import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.data.jpa.test.autoconfigure.DataJpaTest import org.springframework.boot.jpa.test.autoconfigure.TestEntityManager @DataJpaTest class MyRepositoryTests(@Autowired val entityManager: TestEntityManager, @Autowired val repository: UserRepository) { @Test fun testExample() { entityManager.persist(User("sboot", "1234")) val user = repository.findByUsername("sboot") assertThat(user?.username).isEqualTo("sboot") assertThat(user?.employeeNumber).isEqualTo("1234") } } ``` In-memory embedded databases generally work well for tests, since they are fast and do not require any installation. If, however, you prefer to run tests against a real database you can use the [`@AutoConfigureTestDatabase`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/test/autoconfigure/AutoConfigureTestDatabase.html) annotation, as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.data.jpa.test.autoconfigure.DataJpaTest; import org.springframework.boot.jdbc.test.autoconfigure.AutoConfigureTestDatabase; import org.springframework.boot.jdbc.test.autoconfigure.AutoConfigureTestDatabase.Replace; @DataJpaTest @AutoConfigureTestDatabase(replace = Replace.NONE) class MyRepositoryTests { // ... } ``` ```kotlin import org.springframework.boot.jdbc.test.autoconfigure.AutoConfigureTestDatabase import org.springframework.boot.data.jpa.test.autoconfigure.DataJpaTest @DataJpaTest @AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE) class MyRepositoryTests { // ... } ``` ## [](#testing.spring-boot-applications.autoconfigured-jdbc)Auto-configured JDBC Tests [`@JdbcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/test/autoconfigure/JdbcTest.html) from the `spring-boot-jdbc-test` module is similar to [`@DataJdbcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/jdbc/test/autoconfigure/DataJdbcTest.html) but is for tests that only require a [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) and do not use Spring Data JDBC. By default, it configures an in-memory embedded database and a [`JdbcTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/core/JdbcTemplate.html). Regular [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) and [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans are not scanned when the [`@JdbcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/test/autoconfigure/JdbcTest.html) annotation is used. [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) can be used to include [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | A list of the auto-configurations that are enabled by [`@JdbcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/test/autoconfigure/JdbcTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | By default, JDBC tests are transactional and roll back at the end of each test. See the [relevant section](https://docs.spring.io/spring-framework/reference/7.0/testing/testcontext-framework/tx.html#testcontext-tx-enabling-transactions) in the Spring Framework Reference Documentation for more details. If that is not what you want, you can disable transaction management for a test or for the whole class, as follows: * Java * Kotlin ```java import org.springframework.boot.jdbc.test.autoconfigure.JdbcTest; import org.springframework.transaction.annotation.Propagation; import org.springframework.transaction.annotation.Transactional; @JdbcTest @Transactional(propagation = Propagation.NOT_SUPPORTED) class MyTransactionalTests { } ``` ```kotlin import org.springframework.boot.jdbc.test.autoconfigure.JdbcTest import org.springframework.transaction.annotation.Propagation import org.springframework.transaction.annotation.Transactional @JdbcTest @Transactional(propagation = Propagation.NOT_SUPPORTED) class MyTransactionalTests ``` If you prefer your test to run against a real database, you can use the [`@AutoConfigureTestDatabase`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/test/autoconfigure/AutoConfigureTestDatabase.html) annotation in the same way as for [`@DataJpaTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/jpa/test/autoconfigure/DataJpaTest.html). (See [Auto-configured Data JPA Tests](#testing.spring-boot-applications.autoconfigured-spring-data-jpa).) ## [](#testing.spring-boot-applications.autoconfigured-spring-data-jdbc)Auto-configured Data JDBC Tests [`@DataJdbcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/jdbc/test/autoconfigure/DataJdbcTest.html) from the `spring-boot-data-jdbc-test` module is similar to [`@JdbcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/test/autoconfigure/JdbcTest.html) but is for tests that use Spring Data JDBC repositories. By default, it configures an in-memory embedded database, a [`JdbcTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/core/JdbcTemplate.html), and Spring Data JDBC repositories. Only [`AbstractJdbcConfiguration`](https://docs.spring.io/spring-data/jdbc/docs/4.1.x/api/org/springframework/data/jdbc/repository/config/AbstractJdbcConfiguration.html) subclasses are scanned when the [`@DataJdbcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/jdbc/test/autoconfigure/DataJdbcTest.html) annotation is used, regular [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) and [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans are not scanned. [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) can be used to include [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | A list of the auto-configurations that are enabled by [`@DataJdbcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/jdbc/test/autoconfigure/DataJdbcTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | By default, Data JDBC tests are transactional and roll back at the end of each test. See the [relevant section](https://docs.spring.io/spring-framework/reference/7.0/testing/testcontext-framework/tx.html#testcontext-tx-enabling-transactions) in the Spring Framework Reference Documentation for more details. If that is not what you want, you can disable transaction management for a test or for the whole test class as [shown in the JDBC example](#testing.spring-boot-applications.autoconfigured-jdbc). If you prefer your test to run against a real database, you can use the [`@AutoConfigureTestDatabase`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/test/autoconfigure/AutoConfigureTestDatabase.html) annotation in the same way as for [`@DataJpaTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/jpa/test/autoconfigure/DataJpaTest.html). (See [Auto-configured Data JPA Tests](#testing.spring-boot-applications.autoconfigured-spring-data-jpa).) ## [](#testing.spring-boot-applications.autoconfigured-spring-data-r2dbc)Auto-configured Data R2DBC Tests [`@DataR2dbcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/r2dbc/test/autoconfigure/DataR2dbcTest.html) from the `spring-boot-data-r2dbc-test` module is similar to [`@DataJdbcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/jdbc/test/autoconfigure/DataJdbcTest.html) but is for tests that use Spring Data R2DBC repositories. By default, it configures an in-memory embedded database, an [`R2dbcEntityTemplate`](https://docs.spring.io/spring-data/r2dbc/docs/4.1.x/api/org/springframework/data/r2dbc/core/R2dbcEntityTemplate.html), and Spring Data R2DBC repositories. Regular [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) and [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans are not scanned when the [`@DataR2dbcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/r2dbc/test/autoconfigure/DataR2dbcTest.html) annotation is used. [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) can be used to include [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | A list of the auto-configurations that are enabled by [`@DataR2dbcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/r2dbc/test/autoconfigure/DataR2dbcTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | By default, Data R2DBC tests are not transactional. If you prefer your test to run against a real database, you can use the [`@AutoConfigureTestDatabase`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/test/autoconfigure/AutoConfigureTestDatabase.html) annotation in the same way as for [`@DataJpaTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/jpa/test/autoconfigure/DataJpaTest.html). (See [Auto-configured Data JPA Tests](#testing.spring-boot-applications.autoconfigured-spring-data-jpa).) ## [](#testing.spring-boot-applications.autoconfigured-jooq)Auto-configured jOOQ Tests You can use [`@JooqTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jooq/test/autoconfigure/JooqTest.html) from `spring-boot-jooq-test` in a similar fashion as [`@JdbcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/test/autoconfigure/JdbcTest.html) but for jOOQ-related tests. As jOOQ relies heavily on a Java-based schema that corresponds with the database schema, the existing [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) is used. If you want to replace it with an in-memory database, you can use [`@AutoConfigureTestDatabase`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/test/autoconfigure/AutoConfigureTestDatabase.html) to override those settings. (For more about using jOOQ with Spring Boot, see [Using jOOQ](../data/sql.html#data.sql.jooq).) Regular [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) and [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans are not scanned when the [`@JooqTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jooq/test/autoconfigure/JooqTest.html) annotation is used. [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) can be used to include [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | A list of the auto-configurations that are enabled by [`@JooqTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jooq/test/autoconfigure/JooqTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | [`@JooqTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jooq/test/autoconfigure/JooqTest.html) configures a [`DSLContext`](https://www.jooq.org/javadoc/3.21.7/org/jooq/DSLContext.html). The following example shows the [`@JooqTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jooq/test/autoconfigure/JooqTest.html) annotation in use: * Java * Kotlin ```java import org.jooq.DSLContext; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.jooq.test.autoconfigure.JooqTest; @JooqTest class MyJooqTests { @Autowired private DSLContext dslContext; // ... } ``` ```kotlin import org.jooq.DSLContext import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.jooq.test.autoconfigure.JooqTest @JooqTest class MyJooqTests(@Autowired val dslContext: DSLContext) { // ... } ``` JOOQ tests are transactional and roll back at the end of each test by default. If that is not what you want, you can disable transaction management for a test or for the whole test class as [shown in the JDBC example](#testing.spring-boot-applications.autoconfigured-jdbc). ## [](#testing.spring-boot-applications.autoconfigured-spring-data-mongodb)Auto-configured Data MongoDB Tests You can use [`@DataMongoTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/mongodb/test/autoconfigure/DataMongoTest.html) from the `spring-boot-data-mongodb-test` module to test MongoDB applications. By default, it configures a [`MongoTemplate`](https://docs.spring.io/spring-data/mongodb/docs/5.1.x/api/org/springframework/data/mongodb/core/MongoTemplate.html), scans for [`@Document`](https://docs.spring.io/spring-data/mongodb/docs/5.1.x/api/org/springframework/data/mongodb/core/mapping/Document.html) classes, and configures Spring Data MongoDB repositories. Regular [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) and [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans are not scanned when the [`@DataMongoTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/mongodb/test/autoconfigure/DataMongoTest.html) annotation is used. [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) can be used to include [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans. (For more about using MongoDB with Spring Boot, see [MongoDB](../data/nosql.html#data.nosql.mongodb).) | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | A list of the auto-configuration settings that are enabled by [`@DataMongoTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/mongodb/test/autoconfigure/DataMongoTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | The following class shows the [`@DataMongoTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/mongodb/test/autoconfigure/DataMongoTest.html) annotation in use: * Java * Kotlin ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.data.mongodb.test.autoconfigure.DataMongoTest; import org.springframework.data.mongodb.core.MongoTemplate; @DataMongoTest class MyDataMongoDbTests { @Autowired private MongoTemplate mongoTemplate; // ... } ``` ```kotlin import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.data.mongodb.test.autoconfigure.DataMongoTest import org.springframework.data.mongodb.core.MongoTemplate @DataMongoTest class MyDataMongoDbTests(@Autowired val mongoTemplate: MongoTemplate) { // ... } ``` ## [](#testing.spring-boot-applications.autoconfigured-spring-data-neo4j)Auto-configured Data Neo4j Tests You can use [`@DataNeo4jTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/neo4j/test/autoconfigure/DataNeo4jTest.html) from the `spring-boot-data-neo4j-test` module to test Neo4j applications. By default, it scans for [`@Node`](https://docs.spring.io/spring-data/neo4j/docs/8.1.x/api/org/springframework/data/neo4j/core/schema/Node.html) classes, and configures Spring Data Neo4j repositories. Regular [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) and [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans are not scanned when the [`@DataNeo4jTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/neo4j/test/autoconfigure/DataNeo4jTest.html) annotation is used. [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) can be used to include [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans. (For more about using Neo4J with Spring Boot, see [Neo4j](../data/nosql.html#data.nosql.neo4j).) | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | A list of the auto-configuration settings that are enabled by [`@DataNeo4jTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/neo4j/test/autoconfigure/DataNeo4jTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | The following example shows a typical setup for using Neo4J tests in Spring Boot: * Java * Kotlin ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.data.neo4j.test.autoconfigure.DataNeo4jTest; @DataNeo4jTest class MyDataNeo4jTests { @Autowired private SomeRepository repository; // ... } ``` ```kotlin import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.data.neo4j.test.autoconfigure.DataNeo4jTest @DataNeo4jTest class MyDataNeo4jTests(@Autowired val repository: SomeRepository) { // ... } ``` By default, Data Neo4j tests are transactional and roll back at the end of each test. See the [relevant section](https://docs.spring.io/spring-framework/reference/7.0/testing/testcontext-framework/tx.html#testcontext-tx-enabling-transactions) in the Spring Framework Reference Documentation for more details. If that is not what you want, you can disable transaction management for a test or for the whole class, as follows: * Java * Kotlin ```java import org.springframework.boot.data.neo4j.test.autoconfigure.DataNeo4jTest; import org.springframework.transaction.annotation.Propagation; import org.springframework.transaction.annotation.Transactional; @DataNeo4jTest @Transactional(propagation = Propagation.NOT_SUPPORTED) class MyDataNeo4jTests { } ``` ```kotlin import org.springframework.boot.data.neo4j.test.autoconfigure.DataNeo4jTest import org.springframework.transaction.annotation.Propagation import org.springframework.transaction.annotation.Transactional @DataNeo4jTest @Transactional(propagation = Propagation.NOT_SUPPORTED) class MyDataNeo4jTests ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Transactional tests are not supported with reactive access. If you are using this style, you must configure [`@DataNeo4jTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/neo4j/test/autoconfigure/DataNeo4jTest.html) tests as described above. | ## [](#testing.spring-boot-applications.autoconfigured-spring-data-redis)Auto-configured Data Redis Tests You can use [`@DataRedisTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/redis/test/autoconfigure/DataRedisTest.html) from the `spring-boot-data-redis-test` module to test Data Redis applications. By default, it scans for [`@RedisHash`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/core/RedisHash.html) classes and configures Spring Data Redis repositories. Regular [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) and [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans are not scanned when the [`@DataRedisTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/redis/test/autoconfigure/DataRedisTest.html) annotation is used. [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) can be used to include [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans. (For more about using Redis with Spring Boot, see [Redis](../data/nosql.html#data.nosql.redis).) | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | A list of the auto-configuration settings that are enabled by [`@DataRedisTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/redis/test/autoconfigure/DataRedisTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | The following example shows the [`@DataRedisTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/redis/test/autoconfigure/DataRedisTest.html) annotation in use: * Java * Kotlin ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.data.redis.test.autoconfigure.DataRedisTest; @DataRedisTest class MyDataRedisTests { @Autowired private SomeRepository repository; // ... } ``` ```kotlin import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.data.redis.test.autoconfigure.DataRedisTest @DataRedisTest class MyDataRedisTests(@Autowired val repository: SomeRepository) { // ... } ``` ## [](#testing.spring-boot-applications.autoconfigured-spring-data-ldap)Auto-configured Data LDAP Tests You can use [`@DataLdapTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/ldap/test/autoconfigure/DataLdapTest.html) to test Data LDAP applications. By default, it configures an in-memory embedded LDAP (if available), configures an [`LdapTemplate`](https://docs.spring.io/spring-ldap/docs/4.1.x/api/org/springframework/ldap/core/LdapTemplate.html), scans for [`@Entry`](https://docs.spring.io/spring-ldap/docs/4.1.x/api/org/springframework/ldap/odm/annotations/Entry.html) classes, and configures Spring Data LDAP repositories. Regular [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) and [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans are not scanned when the [`@DataLdapTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/ldap/test/autoconfigure/DataLdapTest.html) annotation is used. [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) can be used to include [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans. (For more about using LDAP with Spring Boot, see [LDAP](../data/nosql.html#data.nosql.ldap).) | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | A list of the auto-configuration settings that are enabled by [`@DataLdapTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/ldap/test/autoconfigure/DataLdapTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | The following example shows the [`@DataLdapTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/ldap/test/autoconfigure/DataLdapTest.html) annotation in use: * Java * Kotlin ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.data.ldap.test.autoconfigure.DataLdapTest; import org.springframework.ldap.core.LdapTemplate; @DataLdapTest class MyDataLdapTests { @Autowired private LdapTemplate ldapTemplate; // ... } ``` ```kotlin import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.data.ldap.test.autoconfigure.DataLdapTest import org.springframework.ldap.core.LdapTemplate @DataLdapTest class MyDataLdapTests(@Autowired val ldapTemplate: LdapTemplate) { // ... } ``` In-memory embedded LDAP generally works well for tests, since it is fast and does not require any developer installation. If, however, you prefer to run tests against a real LDAP server, you should exclude the embedded LDAP auto-configuration, as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.data.ldap.test.autoconfigure.DataLdapTest; import org.springframework.boot.ldap.autoconfigure.embedded.EmbeddedLdapAutoConfiguration; @DataLdapTest(excludeAutoConfiguration = EmbeddedLdapAutoConfiguration.class) class MyDataLdapTests { // ... } ``` ```kotlin import org.springframework.boot.ldap.autoconfigure.embedded.EmbeddedLdapAutoConfiguration import org.springframework.boot.data.ldap.test.autoconfigure.DataLdapTest @DataLdapTest(excludeAutoConfiguration = [EmbeddedLdapAutoConfiguration::class]) class MyDataLdapTests { // ... } ``` ## [](#testing.spring-boot-applications.autoconfigured-rest-client)Auto-configured REST Clients You can use the [`@RestClientTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/test/autoconfigure/RestClientTest.html) annotation from the `spring-boot-restclient-test` module to test REST clients. By default, it auto-configures Jackson, GSON, and Jsonb support, configures a [`RestTemplateBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateBuilder.html) and a [`RestClient.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.Builder.html), and adds support for [`MockRestServiceServer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/client/MockRestServiceServer.html). Regular [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) and [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans are not scanned when the [`@RestClientTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/test/autoconfigure/RestClientTest.html) annotation is used. [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) can be used to include [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | A list of the auto-configuration settings that are enabled by [`@RestClientTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/test/autoconfigure/RestClientTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | The specific beans that you want to test should be specified by using the `value` or `components` attribute of [`@RestClientTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/test/autoconfigure/RestClientTest.html). When using a [`RestTemplateBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateBuilder.html) in the beans under test and `RestTemplateBuilder.baseUri(String baseUri)` has been called when building the [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html), then the base URI should be omitted from the [`MockRestServiceServer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/client/MockRestServiceServer.html) expectations as shown in the following example: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.restclient.test.autoconfigure.RestClientTest; import org.springframework.http.MediaType; import org.springframework.test.web.client.MockRestServiceServer; import static org.assertj.core.api.Assertions.assertThat; import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo; import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess; @RestClientTest(org.springframework.boot.docs.testing.springbootapplications.autoconfiguredrestclient.RemoteVehicleDetailsService.class) class MyRestTemplateServiceTests { @Autowired private RemoteVehicleDetailsService service; @Autowired private MockRestServiceServer server; @Test void getVehicleDetailsWhenResultIsSuccessShouldReturnDetails() { this.server.expect(requestTo("/greet/details")).andRespond(withSuccess("hello", MediaType.TEXT_PLAIN)); String greeting = this.service.callRestService(); assertThat(greeting).isEqualTo("hello"); } } ``` ```kotlin import org.assertj.core.api.Assertions.assertThat import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.restclient.test.autoconfigure.RestClientTest import org.springframework.http.MediaType import org.springframework.test.web.client.MockRestServiceServer import org.springframework.test.web.client.match.MockRestRequestMatchers import org.springframework.test.web.client.response.MockRestResponseCreators @RestClientTest(RemoteVehicleDetailsService::class) class MyRestTemplateServiceTests( @Autowired val service: RemoteVehicleDetailsService, @Autowired val server: MockRestServiceServer) { @Test fun getVehicleDetailsWhenResultIsSuccessShouldReturnDetails() { server.expect(MockRestRequestMatchers.requestTo("/greet/details")) .andRespond(MockRestResponseCreators.withSuccess("hello", MediaType.TEXT_PLAIN)) val greeting = service.callRestService() assertThat(greeting).isEqualTo("hello") } } ``` When using a [`RestClient.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.Builder.html) in the beans under test, or when using a [`RestTemplateBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateBuilder.html) without calling `baseUri(String baseUri)`, the full URI must be used in the [`MockRestServiceServer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/client/MockRestServiceServer.html) expectations as shown in the following example: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.restclient.test.autoconfigure.RestClientTest; import org.springframework.http.MediaType; import org.springframework.test.web.client.MockRestServiceServer; import static org.assertj.core.api.Assertions.assertThat; import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo; import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess; @RestClientTest(RemoteVehicleDetailsService.class) class MyRestClientServiceTests { @Autowired private RemoteVehicleDetailsService service; @Autowired private MockRestServiceServer server; @Test void getVehicleDetailsWhenResultIsSuccessShouldReturnDetails() { this.server.expect(requestTo("https://example.com/greet/details")) .andRespond(withSuccess("hello", MediaType.TEXT_PLAIN)); String greeting = this.service.callRestService(); assertThat(greeting).isEqualTo("hello"); } } ``` ```kotlin import org.assertj.core.api.Assertions.assertThat import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.restclient.test.autoconfigure.RestClientTest import org.springframework.http.MediaType import org.springframework.test.web.client.MockRestServiceServer import org.springframework.test.web.client.match.MockRestRequestMatchers import org.springframework.test.web.client.response.MockRestResponseCreators @RestClientTest(RemoteVehicleDetailsService::class) class MyRestClientServiceTests( @Autowired val service: RemoteVehicleDetailsService, @Autowired val server: MockRestServiceServer) { @Test fun getVehicleDetailsWhenResultIsSuccessShouldReturnDetails() { server.expect(MockRestRequestMatchers.requestTo("https://example.com/greet/details")) .andRespond(MockRestResponseCreators.withSuccess("hello", MediaType.TEXT_PLAIN)) val greeting = service.callRestService() assertThat(greeting).isEqualTo("hello") } } ``` ## [](#testing.spring-boot-applications.autoconfigured-web-client)Auto-configured Web Clients You can use the [`@WebClientTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webclient/test/autoconfigure/WebClientTest.html) annotation from the `spring-boot-webclient-test` module to test code that uses `WebClient`. By default, it auto-configures Jackson, GSON, and Jsonb support, and configures a [`WebClient.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.Builder.html). Regular [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) and [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans are not scanned when the [`@WebClientTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webclient/test/autoconfigure/WebClientTest.html) annotation is used. [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) can be used to include [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | A list of the auto-configuration settings that are enabled by [`@WebClientTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webclient/test/autoconfigure/WebClientTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | The specific beans that you want to test should be specified by using the `value` or `components` attribute of [`@WebClientTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webclient/test/autoconfigure/WebClientTest.html). ## [](#testing.spring-boot-applications.autoconfigured-spring-restdocs)Auto-configured Spring REST Docs Tests You can use the [`@AutoConfigureRestDocs`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restdocs/test/autoconfigure/AutoConfigureRestDocs.html) annotation from the \`spring-boot-restdocs- module to use [Spring REST Docs](https://spring.io/projects/spring-restdocs) in your tests with Mock MVC or WebTestClient. It removes the need for the JUnit extension in Spring REST Docs. [`@AutoConfigureRestDocs`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restdocs/test/autoconfigure/AutoConfigureRestDocs.html) can be used to override the default output directory (`target/generated-snippets` if you are using Maven or `build/generated-snippets` if you are using Gradle). It can also be used to configure the host, scheme, and port that appears in any documented URIs. ### [](#testing.spring-boot-applications.autoconfigured-spring-restdocs.with-mock-mvc)Auto-configured Spring REST Docs Tests With Mock MVC [`@AutoConfigureRestDocs`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restdocs/test/autoconfigure/AutoConfigureRestDocs.html) customizes the [`MockMvc`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/MockMvc.html) bean to use Spring REST Docs when testing servlet-based web applications. You can inject it by using [`@Autowired`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Autowired.html) and use it in your tests as you normally would when using Mock MVC and Spring REST Docs, as shown in the following example: ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.restdocs.test.autoconfigure.AutoConfigureRestDocs; import org.springframework.boot.webmvc.test.autoconfigure.WebMvcTest; import org.springframework.http.MediaType; import org.springframework.test.web.servlet.assertj.MockMvcTester; import static org.assertj.core.api.Assertions.assertThat; import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document; @WebMvcTest(UserController.class) @AutoConfigureRestDocs class MyUserDocumentationTests { @Autowired private MockMvcTester mvc; @Test void listUsers() { assertThat(this.mvc.get().uri("/users").accept(MediaType.TEXT_PLAIN)).hasStatusOk() .apply(document("list-users")); } } ``` If you prefer to use the AssertJ integration, [`MockMvcTester`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/assertj/MockMvcTester.html) is available as well, as shown in the following example: ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.restdocs.test.autoconfigure.AutoConfigureRestDocs; import org.springframework.boot.webmvc.test.autoconfigure.WebMvcTest; import org.springframework.http.MediaType; import org.springframework.test.web.servlet.assertj.MockMvcTester; import static org.assertj.core.api.Assertions.assertThat; import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document; @WebMvcTest(UserController.class) @AutoConfigureRestDocs class MyUserDocumentationTests { @Autowired private MockMvcTester mvc; @Test void listUsers() { assertThat(this.mvc.get().uri("/users").accept(MediaType.TEXT_PLAIN)).hasStatusOk() .apply(document("list-users")); } } ``` Both reuses the same [`MockMvc`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/MockMvc.html) instance behind the scenes so any configuration to it applies to both. If you require more control over Spring REST Docs configuration than offered by the attributes of [`@AutoConfigureRestDocs`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restdocs/test/autoconfigure/AutoConfigureRestDocs.html), you can use a [`RestDocsMockMvcConfigurationCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restdocs/test/autoconfigure/RestDocsMockMvcConfigurationCustomizer.html) bean, as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.restdocs.test.autoconfigure.RestDocsMockMvcConfigurationCustomizer; import org.springframework.boot.test.context.TestConfiguration; import org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer; import org.springframework.restdocs.templates.TemplateFormats; @TestConfiguration(proxyBeanMethods = false) public class MyRestDocsConfiguration implements RestDocsMockMvcConfigurationCustomizer { @Override public void customize(MockMvcRestDocumentationConfigurer configurer) { configurer.snippets().withTemplateFormat(TemplateFormats.markdown()); } } ``` ```kotlin import org.springframework.boot.restdocs.test.autoconfigure.RestDocsMockMvcConfigurationCustomizer import org.springframework.boot.test.context.TestConfiguration import org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer import org.springframework.restdocs.templates.TemplateFormats @TestConfiguration(proxyBeanMethods = false) class MyRestDocsConfiguration : RestDocsMockMvcConfigurationCustomizer { override fun customize(configurer: MockMvcRestDocumentationConfigurer) { configurer.snippets().withTemplateFormat(TemplateFormats.markdown()) } } ``` If you want to make use of Spring REST Docs support for a parameterized output directory, you can create a [`RestDocumentationResultHandler`](https://docs.spring.io/spring-restdocs/docs/4.0.x/api/org/springframework/restdocs/mockmvc/RestDocumentationResultHandler.html) bean. The auto-configuration calls `alwaysDo` with this result handler, thereby causing each [`MockMvc`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/MockMvc.html) call to automatically generate the default snippets. The following example shows a [`RestDocumentationResultHandler`](https://docs.spring.io/spring-restdocs/docs/4.0.x/api/org/springframework/restdocs/mockmvc/RestDocumentationResultHandler.html) being defined: * Java * Kotlin ```java import org.springframework.boot.test.context.TestConfiguration; import org.springframework.context.annotation.Bean; import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation; import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler; @TestConfiguration(proxyBeanMethods = false) public class MyResultHandlerConfiguration { @Bean public RestDocumentationResultHandler restDocumentation() { return MockMvcRestDocumentation.document("{method-name}"); } } ``` ```kotlin import org.springframework.boot.test.context.TestConfiguration import org.springframework.context.annotation.Bean import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler @TestConfiguration(proxyBeanMethods = false) class MyResultHandlerConfiguration { @Bean fun restDocumentation(): RestDocumentationResultHandler { return MockMvcRestDocumentation.document("{method-name}") } } ``` ### [](#testing.spring-boot-applications.autoconfigured-spring-restdocs.with-web-test-client)Auto-configured Spring REST Docs Tests With WebTestClient [`@AutoConfigureRestDocs`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restdocs/test/autoconfigure/AutoConfigureRestDocs.html) can also be used with [`WebTestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/reactive/server/WebTestClient.html) when testing reactive web applications. You can inject it by using [`@Autowired`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Autowired.html) and use it in your tests as you normally would when using [`@WebFluxTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webflux/test/autoconfigure/WebFluxTest.html) and Spring REST Docs, as shown in the following example: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.restdocs.test.autoconfigure.AutoConfigureRestDocs; import org.springframework.boot.webflux.test.autoconfigure.WebFluxTest; import org.springframework.test.web.reactive.server.WebTestClient; import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document; @WebFluxTest @AutoConfigureRestDocs class MyUsersDocumentationTests { @Autowired private WebTestClient webTestClient; @Test void listUsers() { this.webTestClient .get().uri("/") .exchange() .expectStatus() .isOk() .expectBody() .consumeWith(document("list-users")); } } ``` ```kotlin import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.restdocs.test.autoconfigure.AutoConfigureRestDocs import org.springframework.boot.webflux.test.autoconfigure.WebFluxTest import org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation import org.springframework.test.web.reactive.server.WebTestClient @WebFluxTest @AutoConfigureRestDocs class MyUsersDocumentationTests(@Autowired val webTestClient: WebTestClient) { @Test fun listUsers() { webTestClient .get().uri("/") .exchange() .expectStatus() .isOk .expectBody() .consumeWith(WebTestClientRestDocumentation.document("list-users")) } } ``` If you require more control over Spring REST Docs configuration than offered by the attributes of [`@AutoConfigureRestDocs`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restdocs/test/autoconfigure/AutoConfigureRestDocs.html), you can use a [`RestDocsWebTestClientConfigurationCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restdocs/test/autoconfigure/RestDocsWebTestClientConfigurationCustomizer.html) bean, as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.restdocs.test.autoconfigure.RestDocsWebTestClientConfigurationCustomizer; import org.springframework.boot.test.context.TestConfiguration; import org.springframework.restdocs.webtestclient.WebTestClientRestDocumentationConfigurer; @TestConfiguration(proxyBeanMethods = false) public class MyRestDocsConfiguration implements RestDocsWebTestClientConfigurationCustomizer { @Override public void customize(WebTestClientRestDocumentationConfigurer configurer) { configurer.snippets().withEncoding("UTF-8"); } } ``` ```kotlin import org.springframework.boot.restdocs.test.autoconfigure.RestDocsWebTestClientConfigurationCustomizer import org.springframework.boot.test.context.TestConfiguration import org.springframework.restdocs.webtestclient.WebTestClientRestDocumentationConfigurer @TestConfiguration(proxyBeanMethods = false) class MyRestDocsConfiguration : RestDocsWebTestClientConfigurationCustomizer { override fun customize(configurer: WebTestClientRestDocumentationConfigurer) { configurer.snippets().withEncoding("UTF-8") } } ``` If you want to make use of Spring REST Docs support for a parameterized output directory, you can use a [`WebTestClientBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webtestclient/autoconfigure/WebTestClientBuilderCustomizer.html) to configure a consumer for every entity exchange result. The following example shows such a [`WebTestClientBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webtestclient/autoconfigure/WebTestClientBuilderCustomizer.html) being defined: * Java * Kotlin ```java import org.springframework.boot.test.context.TestConfiguration; import org.springframework.boot.webtestclient.autoconfigure.WebTestClientBuilderCustomizer; import org.springframework.context.annotation.Bean; import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document; @TestConfiguration(proxyBeanMethods = false) public class MyWebTestClientBuilderCustomizerConfiguration { @Bean public WebTestClientBuilderCustomizer restDocumentation() { return (builder) -> builder.entityExchangeResultConsumer(document("{method-name}")); } } ``` ```kotlin import org.springframework.boot.test.context.TestConfiguration import org.springframework.boot.webtestclient.autoconfigure.WebTestClientBuilderCustomizer import org.springframework.context.annotation.Bean import org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation import org.springframework.test.web.reactive.server.WebTestClient @TestConfiguration(proxyBeanMethods = false) class MyWebTestClientBuilderCustomizerConfiguration { @Bean fun restDocumentation(): WebTestClientBuilderCustomizer { return WebTestClientBuilderCustomizer { builder: WebTestClient.Builder -> builder.entityExchangeResultConsumer( WebTestClientRestDocumentation.document("{method-name}") ) } } } ``` ## [](#testing.spring-boot-applications.autoconfigured-webservices)Auto-configured Spring Web Services Tests ### [](#testing.spring-boot-applications.autoconfigured-webservices.client)Auto-configured Spring Web Services Client Tests You can use [`@WebServiceClientTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webservices/test/autoconfigure/client/WebServiceClientTest.html) from the `spring-boot-webservices-test` module to test applications that call web services using the Spring Web Services project. By default, it configures a [`MockWebServiceServer`](https://docs.spring.io/spring-ws/docs/5.0.x/api/org/springframework/ws/test/client/MockWebServiceServer.html) bean and automatically customizes your [`WebServiceTemplateBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webservices/client/WebServiceTemplateBuilder.html). (For more about using Web Services with Spring Boot, see [Web Services](../io/webservices.html).) | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | A list of the auto-configuration settings that are enabled by [`@WebServiceClientTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webservices/test/autoconfigure/client/WebServiceClientTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | The following example shows the [`@WebServiceClientTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webservices/test/autoconfigure/client/WebServiceClientTest.html) annotation in use: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.webservices.test.autoconfigure.client.WebServiceClientTest; import org.springframework.ws.test.client.MockWebServiceServer; import org.springframework.xml.transform.StringSource; import static org.assertj.core.api.Assertions.assertThat; import static org.springframework.ws.test.client.RequestMatchers.payload; import static org.springframework.ws.test.client.ResponseCreators.withPayload; @WebServiceClientTest(SomeWebService.class) class MyWebServiceClientTests { @Autowired private MockWebServiceServer server; @Autowired private SomeWebService someWebService; @Test void mockServerCall() { this.server .expect(payload(new StringSource(""))) .andRespond(withPayload(new StringSource("200"))); assertThat(this.someWebService.test()) .extracting(Response::getStatus) .isEqualTo(200); } } ``` ```kotlin import org.assertj.core.api.Assertions.assertThat import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.webservices.test.autoconfigure.client.WebServiceClientTest import org.springframework.ws.test.client.MockWebServiceServer import org.springframework.ws.test.client.RequestMatchers import org.springframework.ws.test.client.ResponseCreators import org.springframework.xml.transform.StringSource @WebServiceClientTest(SomeWebService::class) class MyWebServiceClientTests( @Autowired val server: MockWebServiceServer, @Autowired val someWebService: SomeWebService) { @Test fun mockServerCall() { server .expect(RequestMatchers.payload(StringSource(""))) .andRespond(ResponseCreators.withPayload(StringSource("200"))) assertThat(this.someWebService.test()).extracting(Response::status).isEqualTo(200) } } ``` ### [](#testing.spring-boot-applications.autoconfigured-webservices.server)Auto-configured Spring Web Services Server Tests You can use [`@WebServiceServerTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webservices/test/autoconfigure/server/WebServiceServerTest.html) from the `spring-boot-webservices-test` module to test applications that implement web services using the Spring Web Services project. By default, it configures a [`MockWebServiceClient`](https://docs.spring.io/spring-ws/docs/5.0.x/api/org/springframework/ws/test/server/MockWebServiceClient.html) bean that can be used to call your web service endpoints. (For more about using Web Services with Spring Boot, see [Web Services](../io/webservices.html).) | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | A list of the auto-configuration settings that are enabled by [`@WebServiceServerTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webservices/test/autoconfigure/server/WebServiceServerTest.html) can be [found in the appendix](../../appendix/test-auto-configuration/index.html). | The following example shows the [`@WebServiceServerTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webservices/test/autoconfigure/server/WebServiceServerTest.html) annotation in use: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.webservices.test.autoconfigure.server.WebServiceServerTest; import org.springframework.ws.test.server.MockWebServiceClient; import org.springframework.ws.test.server.RequestCreators; import org.springframework.ws.test.server.ResponseMatchers; import org.springframework.xml.transform.StringSource; @WebServiceServerTest(ExampleEndpoint.class) class MyWebServiceServerTests { @Autowired private MockWebServiceClient client; @Test void mockServerCall() { this.client .sendRequest(RequestCreators.withPayload(new StringSource(""))) .andExpect(ResponseMatchers.payload(new StringSource("42"))); } } ``` ```kotlin import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.webservices.test.autoconfigure.server.WebServiceServerTest import org.springframework.ws.test.server.MockWebServiceClient import org.springframework.ws.test.server.RequestCreators import org.springframework.ws.test.server.ResponseMatchers import org.springframework.xml.transform.StringSource @WebServiceServerTest(ExampleEndpoint::class) class MyWebServiceServerTests(@Autowired val client: MockWebServiceClient) { @Test fun mockServerCall() { client .sendRequest(RequestCreators.withPayload(StringSource(""))) .andExpect(ResponseMatchers.payload(StringSource("42"))) } } ``` ## [](#testing.spring-boot-applications.additional-autoconfiguration-and-slicing)Additional Auto-configuration and Slicing Each slice provides one or more `@AutoConfigure…​` annotations that namely defines the auto-configurations that should be included as part of a slice. Additional auto-configurations can be added on a test-by-test basis by creating a custom `@AutoConfigure…​` annotation or by adding [`@ImportAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/ImportAutoConfiguration.html) to the test as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.autoconfigure.ImportAutoConfiguration; import org.springframework.boot.integration.autoconfigure.IntegrationAutoConfiguration; import org.springframework.boot.jdbc.test.autoconfigure.JdbcTest; @JdbcTest @ImportAutoConfiguration(IntegrationAutoConfiguration.class) class MyJdbcTests { } ``` ```kotlin import org.springframework.boot.autoconfigure.ImportAutoConfiguration import org.springframework.boot.integration.autoconfigure.IntegrationAutoConfiguration import org.springframework.boot.jdbc.test.autoconfigure.JdbcTest @JdbcTest @ImportAutoConfiguration(IntegrationAutoConfiguration::class) class MyJdbcTests ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Make sure to not use the regular [`@Import`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Import.html) annotation to import auto-configurations as they are handled in a specific way by Spring Boot. | Alternatively, additional auto-configurations can be added for any use of a slice annotation by registering them in a file stored in `META-INF/spring` as shown in the following example: META-INF/spring/org.springframework.boot.jdbc.test.autoconfigure.JdbcTest.imports ```none com.example.IntegrationAutoConfiguration ``` In this example, the `com.example.IntegrationAutoConfiguration` is enabled on every test annotated with [`@JdbcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/test/autoconfigure/JdbcTest.html). | | | | -- | ------------------------------------------- | | ** | You can use comments with `#` in this file. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | A slice or `@AutoConfigure…​` annotation can be customized this way as long as it is meta-annotated with [`@ImportAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/ImportAutoConfiguration.html). | ## [](#testing.spring-boot-applications.user-configuration-and-slicing)User Configuration and Slicing If you [structure your code](../using/structuring-your-code.html) in a sensible way, your [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html) class is [used by default](#testing.spring-boot-applications.detecting-configuration) as the configuration of your tests. It then becomes important not to litter the application’s main class with configuration settings that are specific to a particular area of its functionality. Assume that you are using Spring Data MongoDB, you rely on the auto-configuration for it, and you have enabled auditing. You could define your [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html) as follows: * Java * Kotlin ```java import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.data.mongodb.config.EnableMongoAuditing; @SpringBootApplication @EnableMongoAuditing public class MyApplication { // ... } ``` ```kotlin import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.data.mongodb.config.EnableMongoAuditing @SpringBootApplication @EnableMongoAuditing class MyApplication { // ... } ``` Because this class is the source configuration for the test, any slice test actually tries to enable Mongo auditing, which is definitely not what you want to do. A recommended approach is to move that area-specific configuration to a separate [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class at the same level as your application, as shown in the following example: * Java * Kotlin ```java import org.springframework.context.annotation.Configuration; import org.springframework.data.mongodb.config.EnableMongoAuditing; @Configuration(proxyBeanMethods = false) @EnableMongoAuditing public class MyMongoConfiguration { // ... } ``` ```kotlin import org.springframework.context.annotation.Configuration import org.springframework.data.mongodb.config.EnableMongoAuditing @Configuration(proxyBeanMethods = false) @EnableMongoAuditing class MyMongoConfiguration { // ... } ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Depending on the complexity of your application, you may either have a single [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class for your customizations or one class per domain area. The latter approach lets you enable it in one of your tests, if necessary, with the [`@Import`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Import.html) annotation. See [this how-to section](../../how-to/testing.html#howto.testing.slice-tests) for more details on when you might want to enable specific [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) classes for slice tests. | Test slices exclude [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) classes from scanning. For example, for a [`@WebMvcTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/test/autoconfigure/WebMvcTest.html), the following configuration will not include the given [`WebMvcConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.html) bean in the application context loaded by the test slice: * Java * Kotlin ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; @Configuration(proxyBeanMethods = false) public class MyWebConfiguration { @Bean public WebMvcConfigurer testConfigurer() { return new WebMvcConfigurer() { // ... }; } } ``` ```kotlin import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.web.servlet.config.annotation.WebMvcConfigurer @Configuration(proxyBeanMethods = false) class MyWebConfiguration { @Bean fun testConfigurer(): WebMvcConfigurer { return object : WebMvcConfigurer { // ... } } } ``` The configuration below will, however, cause the custom [`WebMvcConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.html) to be loaded by the test slice. * Java * Kotlin ```java import org.springframework.stereotype.Component; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; @Component public class MyWebMvcConfigurer implements WebMvcConfigurer { // ... } ``` ```kotlin import org.springframework.stereotype.Component import org.springframework.web.servlet.config.annotation.WebMvcConfigurer @Component class MyWebMvcConfigurer : WebMvcConfigurer { // ... } ``` Another source of confusion is classpath scanning. Assume that, while you structured your code in a sensible way, you need to scan an additional package. Your application may resemble the following code: * Java * Kotlin ```java import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.annotation.ComponentScan; @SpringBootApplication @ComponentScan({ "com.example.app", "com.example.another" }) public class MyApplication { // ... } ``` ```kotlin import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.context.annotation.ComponentScan @SpringBootApplication @ComponentScan("com.example.app", "com.example.another") class MyApplication { // ... } ``` Doing so effectively overrides the default component scan directive with the side effect of scanning those two packages regardless of the slice that you chose. For instance, a [`@DataJpaTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/jpa/test/autoconfigure/DataJpaTest.html) seems to suddenly scan components and user configurations of your application. Again, moving the custom directive to a separate class is a good way to fix this issue. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If this is not an option for you, you can create a [`@SpringBootConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringBootConfiguration.html) somewhere in the hierarchy of your test so that it is used instead. Alternatively, you can specify a source for your test, which disables the behavior of finding a default one. | ## [](#testing.spring-boot-applications.spock)Using Spock to Test Spring Boot Applications Spock 2.4 or later can be used to test a Spring Boot application. To do so, add a dependency on a `-groovy-5.0` version of Spock’s `spock-spring` module to your application’s build. `spock-spring` integrates Spring’s test framework into Spock. See [the documentation for Spock’s Spring module](https://spockframework.org/spock/docs/2.4/modules.html#spring-module) for further details. * [Spring Boot](../../index.html) * [4.1.1](spring-boot-applications.html) * [4.0.8](../../4.0/reference/testing/spring-boot-applications.html) * [3.5.16](../../3.5/reference/testing/spring-boot-applications.html) * [3.4.13](../../3.4/reference/testing/spring-boot-applications.html) * [3.3.13](../../3.3/reference/testing/spring-boot-applications.html) - [4.2.0-M2](../../4.2/reference/testing/spring-boot-applications.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/testing/spring-boot-applications.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/testing/spring-boot-applications.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/testing/spring-boot-applications.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/index-files/index-4.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ## D * [DEFLATED](../org/springframework/boot/gradle/tasks/bundling/ZipCompression.html#DEFLATED) - Enum constant in enum class org.springframework.boot.gradle.tasks.bundling.[ZipCompression](../org/springframework/boot/gradle/tasks/bundling/ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") The entry should be [`ZipEntry.DEFLATED`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/zip/ZipEntry.html#DEFLATED "class or interface in java.util.zip") in the archive. * [dependencies(Action)](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html#dependencies\(org.gradle.api.Action\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Customizes the [`LayeredSpec.DependenciesSpec`](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") using the given `action`. * [DependenciesIntoLayerSpec(String)](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesIntoLayerSpec.html#%3Cinit%3E\(java.lang.String\)) - Constructor for class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.DependenciesIntoLayerSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesIntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Creates a new `IntoLayerSpec` that will control the content of the given layer. * [DependenciesSpec()](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesSpec.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.DependenciesSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling")   * [DependenciesSpec(LayeredSpec.DependenciesIntoLayerSpec...)](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesSpec.html#%3Cinit%3E\(org.springframework.boot.gradle.tasks.bundling.LayeredSpec.DependenciesIntoLayerSpec...\)) - Constructor for class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec.DependenciesSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Creates a new `DependenciesSpec` with the given `contents`. * [DEVELOPMENT\_ONLY\_CONFIGURATION\_NAME](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html#DEVELOPMENT_ONLY_CONFIGURATION_NAME) - Static variable in class org.springframework.boot.gradle.plugin.[SpringBootPlugin](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html "class in org.springframework.boot.gradle.plugin") The name of the `developmentOnly` configuration. * [docker(Action)](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#docker\(org.gradle.api.Action\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Configures the Docker connection using the given `action`. * [DockerRegistrySpec()](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.gradle.tasks.bundling.[DockerSpec.DockerRegistrySpec](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling")   * [DockerSpec](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") - Class in [org.springframework.boot.gradle.tasks.bundling](../org/springframework/boot/gradle/tasks/bundling/package-summary.html) Encapsulates Docker configuration options. * [DockerSpec(ObjectFactory)](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html#%3Cinit%3E\(org.gradle.api.model.ObjectFactory\)) - Constructor for class org.springframework.boot.gradle.tasks.bundling.[DockerSpec](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling")   * [DockerSpec.DockerRegistrySpec](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") - Class in [org.springframework.boot.gradle.tasks.bundling](../org/springframework/boot/gradle/tasks/bundling/package-summary.html) Encapsulates Docker registry authentication configuration options. [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/ZipCompression.html ---- # Enum Class ZipCompression [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") [java.lang.Enum](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html "class or interface in java.lang")<[ZipCompression](ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling")> org.springframework.boot.gradle.tasks.bundling.ZipCompression * All Implemented Interfaces: `Serializable, Comparable, Constable` *** public enum ZipCompression extends [Enum](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html "class or interface in java.lang")<[ZipCompression](ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling")> An enumeration of supported compression options for an entry in a ZIP archive. * Since: 2.0.0 * Author: Andy Wilkinson `DEFLATED` The entry should be [`ZipEntry.DEFLATED`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/zip/ZipEntry.html#DEFLATED "class or interface in java.util.zip") in the archive. `STORED` The entry should be [`ZipEntry.STORED`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/zip/ZipEntry.html#STORED "class or interface in java.util.zip") in the archive. - ## Method Summary Modifier and Type Method Description `static ZipCompression` `valueOf(String name)` Returns the enum constant of this class with the specified name. `static ZipCompression[]` * ### STORED public static final [ZipCompression](ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") STORED The entry should be [`ZipEntry.STORED`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/zip/ZipEntry.html#STORED "class or interface in java.util.zip") in the archive. * ### DEFLATED public static final [ZipCompression](ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") DEFLATED The entry should be [`ZipEntry.DEFLATED`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/zip/ZipEntry.html#DEFLATED "class or interface in java.util.zip") in the archive. * ## Method Details * ### values public static [ZipCompression](ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling")\[] values() Returns an array containing the constants of this enum class, in the order they are declared. * Returns: an array containing the constants of this enum class, in the order they are declared * ### valueOf public static [ZipCompression](ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") valueOf​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") name) Returns the enum constant of this class with the specified name. The string must match *exactly* an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.) * Parameters: `name` - the name of the enum constant to be returned. * Returns: the enum constant with the specified name * Throws: * `IllegalArgumentException` - if this enum class has no constant with the specified name * `NullPointerException` - if the argument is null ---- url: https://docs.spring.io/spring-boot/how-to/data-initialization.html ---- # Database Initialization An SQL database can be initialized in different ways depending on what your stack is. Of course, you can also do it manually, provided the database is a separate process. It is recommended to use a single mechanism for schema generation. ## [](#howto.data-initialization.using-hibernate)Initialize a Database Using Hibernate You can set `spring.jpa.hibernate.ddl-auto` to control Hibernate’s database initialization. Supported values are `none`, `validate`, `update`, `create`, and `create-drop`. Spring Boot chooses a default value for you based on whether you are using an embedded database. An embedded database is identified by looking at the [`Connection`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/java/sql/Connection.html) type and JDBC url. `hsqldb`, `h2`, or `derby` (deprecated) are embedded databases and others are not. If an embedded database is identified and no schema manager (Flyway or Liquibase) has been detected, `ddl-auto` defaults to `create-drop`. In all other cases, it defaults to `none`. Be careful when switching from in-memory to a ‘real’ database that you do not make assumptions about the existence of the tables and data in the new platform. You either have to set `ddl-auto` explicitly or use one of the other mechanisms to initialize the database. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can output the schema creation by enabling the `org.hibernate.SQL` logger. This is done for you automatically if you enable the [debug mode](../reference/features/logging.html#features.logging.console-output). | In addition, a file named `import.sql` in the root of the classpath is executed on startup if Hibernate creates the schema from scratch (that is, if the `ddl-auto` property is set to `create` or `create-drop`). This can be useful for demos and for testing if you are careful but is probably not something you want to be on the classpath in production. It is a Hibernate feature (and has nothing to do with Spring). ## [](#howto.data-initialization.using-basic-sql-scripts)Initialize a Database Using Basic SQL Scripts Spring Boot can automatically create the schema (DDL scripts) of your JDBC [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) or R2DBC [`ConnectionFactory`](https://r2dbc.io/spec/1.0.0.RELEASE/api/io/r2dbc/spi/ConnectionFactory.html) and initialize its data (DML scripts). By default, it loads schema scripts from `optional:classpath*:schema.sql` and data scripts from `optional:classpath*:data.sql`. The locations of these schema and data scripts can be customized using `spring.sql.init.schema-locations` and `spring.sql.init.data-locations` respectively. The `optional:` prefix means that the application will start even when the files do not exist. To have the application fail to start when the files are absent, remove the `optional:` prefix. In addition, Spring Boot processes the `optional:classpath*:schema-${platform}.sql` and `optional:classpath*:data-${platform}.sql` files (if present), where `${platform}` is the value of `spring.sql.init.platform`. This allows you to switch to database-specific scripts if necessary. For example, you might choose to set it to the vendor name of the database (`hsqldb`, `h2`, `oracle`, `mysql`, `postgresql`, and so on). By default, SQL database initialization is only performed when using an embedded in-memory database. To always initialize an SQL database, irrespective of its type, set `spring.sql.init.mode` to `always`. Similarly, to disable initialization, set `spring.sql.init.mode` to `never`. By default, Spring Boot enables the fail-fast feature of its script-based database initializer. This means that, if the scripts cause exceptions, the application fails to start. You can tune that behavior by setting `spring.sql.init.continue-on-error`. Script-based [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) initialization is performed, by default, before any JPA [`EntityManagerFactory`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/EntityManagerFactory.html) beans are created. `schema.sql` can be used to create the schema for JPA-managed entities and `data.sql` can be used to populate it. While we do not recommend using multiple data source initialization technologies, if you want script-based [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) initialization to be able to build upon the schema creation performed by Hibernate, set `spring.jpa.defer-datasource-initialization` to `true`. This will defer data source initialization until after any [`EntityManagerFactory`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/EntityManagerFactory.html) beans have been created and initialized. `schema.sql` can then be used to make additions to any schema creation performed by Hibernate and `data.sql` can be used to populate it. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------- | | ** | The initialization scripts support `--` for single line comments and `/* */` for block comments. Other comment formats are not supported. | If you are using a [higher-level database migration tool](#howto.data-initialization.migration-tool), like Flyway or Liquibase, you should use them alone to create and initialize the schema. Using the basic `schema.sql` and `data.sql` scripts alongside Flyway or Liquibase is not recommended and support will be removed in a future release. If you need to initialize test data using a higher-level database migration tool, please see the sections about [Flyway](#howto.data-initialization.migration-tool.flyway-tests) and [Liquibase](#howto.data-initialization.migration-tool.liquibase-tests). ## [](#howto.data-initialization.batch)Initialize a Spring Batch Database If you use Spring Batch, it comes pre-packaged with SQL initialization scripts for most popular database platforms. Spring Boot can detect your database type and execute those scripts on startup. If you use an embedded database, this happens by default. You can also enable it for any database type, as shown in the following example: * Properties * YAML ```properties spring.batch.jdbc.initialize-schema=always ``` ```yaml spring: batch: jdbc: initialize-schema: "always" ``` You can also switch off the initialization explicitly by setting `spring.batch.jdbc.initialize-schema` to `never`. ## [](#howto.data-initialization.migration-tool)Use a Higher-level Database Migration Tool Spring Boot supports two higher-level migration tools: [Flyway](https://flywaydb.org/) and [Liquibase](https://www.liquibase.org/). ### [](#howto.data-initialization.migration-tool.flyway)Execute Flyway Database Migrations on Startup To automatically run Flyway database migrations on startup, add the appropriate Flyway module to your classpath. In-memory and file-based databases are supported by the `spring-boot-starter-flyway` starter. Other cases require also a database-specific module. For example, use `org.flywaydb:flyway-database-postgresql` with PostgreSQL and `org.flywaydb:flyway-mysql` with MySQL. See [the Flyway Documentation](https://documentation.red-gate.com/fd/supported-databases-and-versions-143754067.html) for further details. Typically, migrations are scripts in the form `V__.sql` (with `` an underscore-separated version, such as ‘1’ or ‘2\_1’). By default, they are in a directory called `classpath:db/migration`, but you can modify that location by setting `spring.flyway.locations`. This is a comma-separated list of one or more `classpath:` or `filesystem:` locations. For example, the following configuration would search for scripts in both the default classpath location and the `/opt/migration` directory: * Properties * YAML ```properties spring.flyway.locations=classpath:db/migration,filesystem:/opt/migration ``` ```yaml spring: flyway: locations: "classpath:db/migration,filesystem:/opt/migration" ``` You can also add a special `{vendor}` placeholder to use vendor-specific scripts. Assume the following: * Properties * YAML ```properties spring.flyway.locations=classpath:db/migration/{vendor} ``` ```yaml spring: flyway: locations: "classpath:db/migration/{vendor}" ``` Rather than using `db/migration`, the preceding configuration sets the directory to use according to the type of the database (such as `db/migration/mysql` for MySQL). The list of supported databases is available in [`DatabaseDriver`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/DatabaseDriver.html). Migrations can also be written in Java. Flyway will be auto-configured with any beans that implement [`JavaMigration`](https://javadoc.io/doc/org.flywaydb/flyway-core/12.4.0/org/flywaydb/core/api/migration/JavaMigration.html). [`FlywayProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/flyway/autoconfigure/FlywayProperties.html) provides most of Flyway’s settings and a small set of additional properties that can be used to disable the migrations or switch off the location checking. If you need more control over the configuration, consider registering a [`FlywayConfigurationCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/flyway/autoconfigure/FlywayConfigurationCustomizer.html) bean. Spring Boot calls `Flyway.migrate()` to perform the database migration. If you would like more control, provide a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) that implements [`FlywayMigrationStrategy`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/flyway/autoconfigure/FlywayMigrationStrategy.html). Flyway supports SQL and Java [callbacks](https://documentation.red-gate.com/fd/callbacks-275218509.html). To use SQL-based callbacks, place the callback scripts in the `classpath:db/migration` directory. To use Java-based callbacks, create one or more beans that implement [`Callback`](https://javadoc.io/doc/org.flywaydb/flyway-core/12.4.0/org/flywaydb/core/api/callback/Callback.html). Any such beans are automatically registered with [`Flyway`](https://javadoc.io/doc/org.flywaydb/flyway-core/12.4.0/org/flywaydb/core/Flyway.html). They can be ordered by using [`@Order`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/annotation/Order.html) or by implementing [`Ordered`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/Ordered.html). By default, Flyway autowires the (`@Primary`) [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) in your context and uses that for migrations. If you like to use a different [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html), you can create one and mark its [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) as [`@FlywayDataSource`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/flyway/autoconfigure/FlywayDataSource.html). If you do so and want two data sources (for example by retaining the main auto-configured [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html)), remember to set the `defaultCandidate` attribute of the [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) annotation to `false`. Alternatively, you can use Flyway’s native [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) by setting `spring.flyway.[url,user,password]` in external properties. Setting either `spring.flyway.url` or `spring.flyway.user` is sufficient to cause Flyway to use its own [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html). If any of the three properties has not been set, the value of its equivalent `spring.datasource` property will be used. You can also use Flyway to provide data for specific scenarios. For example, you can place test-specific migrations in `src/test/resources` and they are run only when your application starts for testing. Also, you can use profile-specific configuration to customize `spring.flyway.locations` so that certain migrations run only when a particular profile is active. For example, in `application-dev.properties`, you might specify the following setting: * Properties * YAML ```properties spring.flyway.locations=classpath:/db/migration,classpath:/dev/db/migration ``` ```yaml spring: flyway: locations: "classpath:/db/migration,classpath:/dev/db/migration" ``` With that setup, migrations in `dev/db/migration` run only when the `dev` profile is active. ### [](#howto.data-initialization.migration-tool.liquibase)Execute Liquibase Database Migrations on Startup To automatically run Liquibase database migrations on startup, add the `spring-boot-starter-liquibase` starter to your classpath. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | When you add `spring-boot-starter-liquibase` to your classpath, database migrations run by default for both during application startup and before your tests run. This behavior can be customized by using the `spring.liquibase.enabled` property, setting different values in the `main` and `test` configurations. It is not possible to use two different ways to initialize the database (for example Liquibase for application startup, JPA for test runs). | By default, the master change log is read from `db/changelog/db.changelog-master.yaml`, but you can change the location by setting `spring.liquibase.change-log`. In addition to YAML, Liquibase also supports JSON, XML, and SQL change log formats. By default, Liquibase autowires the (`@Primary`) [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) in your context and uses that for migrations. If you need to use a different [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html), you can create one and mark its [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) as [`@LiquibaseDataSource`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/liquibase/autoconfigure/LiquibaseDataSource.html). If you do so and want two data sources (for example by retaining the main auto-configured [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html)), remember to set the `defaultCandidate` attribute of the [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) annotation to `false`. Alternatively, you can use Liquibase’s native [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) by setting `spring.liquibase.[driver-class-name,url,user,password]` in external properties. Setting either `spring.liquibase.url` or `spring.liquibase.user` is sufficient to cause Liquibase to use its own [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html). If any of the three properties has not been set, the value of its equivalent `spring.datasource` property will be used. See [`LiquibaseProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/liquibase/autoconfigure/LiquibaseProperties.html) for details about available settings such as contexts, the default schema, and others. You can also use a `Customizer` bean if you want to customize the [`Liquibase`](https://javadoc.io/doc/org.liquibase/liquibase-core/5.0.3/liquibase/Liquibase.html) instance before it is being used. ### [](#howto.data-initialization.migration-tool.flyway-tests)Use Flyway for Test-only Migrations If you want to create Flyway migrations which populate your test database, place them in `src/test/resources/db/migration`. A file named, for example, `src/test/resources/db/migration/V9999__test-data.sql` will be executed after your production migrations and only if you’re running the tests. You can use this file to create the needed test data. This file will not be packaged in your uber jar or your container. ### [](#howto.data-initialization.migration-tool.liquibase-tests)Use Liquibase for Test-only Migrations If you want to create Liquibase migrations which populate your test database, you can leverage [Liquibase contexts](https://docs.liquibase.com/reference-guide/changelog-attributes/what-are-contexts). See also the related [blog post](https://www.liquibase.com/blog/contexts-vs-labels). In practical terms, this translates into adding a `context:@test` attribute to changesets containing test data, for example: ```sql --liquibase formatted sql --changeset alice:1 context:@test insert into project (id, name) values (1, 'Spring Boot'); ``` And using `spring.liquibase.contexts=test` in environments where you would like changesets containing test data to be applied. ## [](#howto.data-initialization.dependencies)Depend Upon an Initialized Database Database initialization is performed while the application is starting up as part of application context refresh. To allow an initialized database to be accessed during startup, beans that act as database initializers and beans that require that database to have been initialized are detected automatically. Beans whose initialization depends upon the database having been initialized are configured to depend upon those that initialize it. If, during startup, your application tries to access the database and it has not been initialized, you can configure additional detection of beans that initialize the database and require the database to have been initialized. ### [](#howto.data-initialization.dependencies.initializer-detection)Detect a Database Initializer Spring Boot will automatically detect beans of the following types that initialize an SQL database: * [`DataSourceScriptDatabaseInitializer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/init/DataSourceScriptDatabaseInitializer.html) * [`EntityManagerFactory`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/EntityManagerFactory.html) * [`Flyway`](https://javadoc.io/doc/org.flywaydb/flyway-core/12.4.0/org/flywaydb/core/Flyway.html) * [`FlywayMigrationInitializer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/flyway/autoconfigure/FlywayMigrationInitializer.html) * [`R2dbcScriptDatabaseInitializer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/r2dbc/init/R2dbcScriptDatabaseInitializer.html) * [`SpringLiquibase`](https://javadoc.io/doc/org.liquibase/liquibase-core/5.0.3/liquibase/integration/spring/SpringLiquibase.html) If you are using a third-party starter for a database initialization library, it may provide a detector such that beans of other types are also detected automatically. To have other beans be detected, register an implementation of [`DatabaseInitializerDetector`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/sql/init/dependency/DatabaseInitializerDetector.html) in `META-INF/spring.factories`. ### [](#howto.data-initialization.dependencies.depends-on-initialization-detection)Detect a Bean That Depends On Database Initialization Spring Boot will automatically detect beans of the following types that depends upon database initialization: * [`AbstractEntityManagerFactoryBean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/orm/jpa/AbstractEntityManagerFactoryBean.html) (unless `spring.jpa.defer-datasource-initialization` is set to `true`) * [`DSLContext`](https://www.jooq.org/javadoc/3.21.7/org/jooq/DSLContext.html) (jOOQ) * [`EntityManagerFactory`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/EntityManagerFactory.html) (unless `spring.jpa.defer-datasource-initialization` is set to `true`) * [`JdbcClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/core/simple/JdbcClient.html) * [`JdbcOperations`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/core/JdbcOperations.html) * [`NamedParameterJdbcOperations`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/core/namedparam/NamedParameterJdbcOperations.html) If you are using a third-party starter data access library, it may provide a detector such that beans of other types are also detected automatically. To have other beans be detected, register an implementation of [`DependsOnDatabaseInitializationDetector`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/sql/init/dependency/DependsOnDatabaseInitializationDetector.html) in `META-INF/spring.factories`. Alternatively, annotate the bean’s class or its [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) method with [`@DependsOnDatabaseInitialization`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/sql/init/dependency/DependsOnDatabaseInitialization.html). * [Spring Boot](../index.html) * [4.1.1](data-initialization.html) * [4.0.8](../4.0/how-to/data-initialization.html) * [3.5.16](../3.5/how-to/data-initialization.html) * [3.4.13](../3.4/how-to/data-initialization.html) * [3.3.13](../3.3/how-to/data-initialization.html) - [4.2.0-M2](../4.2/how-to/data-initialization.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/data-initialization.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/data-initialization.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/data-initialization.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/security/oauth2.html ---- # OAuth2 [OAuth2](https://oauth.net/2/) is a widely used authorization framework. ## [](#security.oauth2.client)Client If you have `spring-security-oauth2-client` on your classpath, you can take advantage of some auto-configuration to set up OAuth2/Open ID Connect clients. This configuration makes use of the properties under [`OAuth2ClientProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/security/oauth2/client/autoconfigure/OAuth2ClientProperties.html). The same properties are applicable to both servlet and reactive web applications. Each registration must specify an OAuth 2 provider. When set, the value of the `spring.security.oauth2.client.registration..provider` property is used to specify the registration’s provider. If the `provider` property is not set, the registration’s ID is used instead. Both approaches are shown in the following example: * Properties * YAML ```properties spring.security.oauth2.client.registration.my-client.client-id=abcd spring.security.oauth2.client.registration.my-client.client-secret=password spring.security.oauth2.client.registration.my-client.provider=example spring.security.oauth2.client.registration.example.client-id=abcd spring.security.oauth2.client.registration.example.client-secret=password ``` ```yaml spring: security: oauth2: client: registration: my-client: client-id: "abcd" client-secret: "password" provider: "example" example: client-id: "abcd" client-secret: "password" ``` The registrations `my-client` and `example` will both use the provider with ID `example`. The former will do so due to the value of the `spring.security.oauth2.client.registration.my-client.provider` property. The latter will do so due to its ID being `example` and there being no `provider` property configured for the registration. The specified provider can either be a reference to a provider configured using `spring.security.oauth2.client.provider..*` properties or one of the [known common providers](#security.oauth2.client.common-providers). You can register multiple OAuth2 clients and providers under the `spring.security.oauth2.client` prefix, as shown in the following example: * Properties * YAML ```properties spring.security.oauth2.client.registration.my-login-client.client-id=abcd spring.security.oauth2.client.registration.my-login-client.client-secret=password spring.security.oauth2.client.registration.my-login-client.client-name=Client for OpenID Connect spring.security.oauth2.client.registration.my-login-client.provider=my-oauth-provider spring.security.oauth2.client.registration.my-login-client.scope=openid,profile,email,phone,address spring.security.oauth2.client.registration.my-login-client.redirect-uri={baseUrl}/login/oauth2/code/{registrationId} spring.security.oauth2.client.registration.my-login-client.client-authentication-method=client_secret_basic spring.security.oauth2.client.registration.my-login-client.authorization-grant-type=authorization_code spring.security.oauth2.client.registration.my-client-1.client-id=abcd spring.security.oauth2.client.registration.my-client-1.client-secret=password spring.security.oauth2.client.registration.my-client-1.client-name=Client for user scope spring.security.oauth2.client.registration.my-client-1.provider=my-oauth-provider spring.security.oauth2.client.registration.my-client-1.scope=user spring.security.oauth2.client.registration.my-client-1.redirect-uri={baseUrl}/authorized/user spring.security.oauth2.client.registration.my-client-1.client-authentication-method=client_secret_basic spring.security.oauth2.client.registration.my-client-1.authorization-grant-type=authorization_code spring.security.oauth2.client.registration.my-client-2.client-id=abcd spring.security.oauth2.client.registration.my-client-2.client-secret=password spring.security.oauth2.client.registration.my-client-2.client-name=Client for email scope spring.security.oauth2.client.registration.my-client-2.provider=my-oauth-provider spring.security.oauth2.client.registration.my-client-2.scope=email spring.security.oauth2.client.registration.my-client-2.redirect-uri={baseUrl}/authorized/email spring.security.oauth2.client.registration.my-client-2.client-authentication-method=client_secret_basic spring.security.oauth2.client.registration.my-client-2.authorization-grant-type=authorization_code spring.security.oauth2.client.provider.my-oauth-provider.authorization-uri=https://my-auth-server.com/oauth2/authorize spring.security.oauth2.client.provider.my-oauth-provider.token-uri=https://my-auth-server.com/oauth2/token spring.security.oauth2.client.provider.my-oauth-provider.user-info-uri=https://my-auth-server.com/userinfo spring.security.oauth2.client.provider.my-oauth-provider.user-info-authentication-method=header spring.security.oauth2.client.provider.my-oauth-provider.jwk-set-uri=https://my-auth-server.com/oauth2/jwks spring.security.oauth2.client.provider.my-oauth-provider.user-name-attribute=name ``` ```yaml spring: security: oauth2: client: registration: my-login-client: client-id: "abcd" client-secret: "password" client-name: "Client for OpenID Connect" provider: "my-oauth-provider" scope: "openid,profile,email,phone,address" redirect-uri: "{baseUrl}/login/oauth2/code/{registrationId}" client-authentication-method: "client_secret_basic" authorization-grant-type: "authorization_code" my-client-1: client-id: "abcd" client-secret: "password" client-name: "Client for user scope" provider: "my-oauth-provider" scope: "user" redirect-uri: "{baseUrl}/authorized/user" client-authentication-method: "client_secret_basic" authorization-grant-type: "authorization_code" my-client-2: client-id: "abcd" client-secret: "password" client-name: "Client for email scope" provider: "my-oauth-provider" scope: "email" redirect-uri: "{baseUrl}/authorized/email" client-authentication-method: "client_secret_basic" authorization-grant-type: "authorization_code" provider: my-oauth-provider: authorization-uri: "https://my-auth-server.com/oauth2/authorize" token-uri: "https://my-auth-server.com/oauth2/token" user-info-uri: "https://my-auth-server.com/userinfo" user-info-authentication-method: "header" jwk-set-uri: "https://my-auth-server.com/oauth2/jwks" user-name-attribute: "name" ``` In this example, there are three registrations. In order of declaration, their IDs are `my-login-client`, `my-client-1`, and `my-client-2`. There is also a single provider with ID `my-oauth-provider`. For OpenID Connect providers that support [OpenID Connect discovery](https://openid.net/specs/openid-connect-discovery-1_0.html), the configuration can be further simplified. The provider needs to be configured with an `issuer-uri` which is the URI that it asserts as its Issuer Identifier. For example, if the `issuer-uri` provided is `https://example.com`, then an “OpenID Provider Configuration Request” will be made to `https://example.com/.well-known/openid-configuration`. The result is expected to be an “OpenID Provider Configuration Response”. The following example shows how an OpenID Connect Provider can be configured with the `issuer-uri`: * Properties * YAML ```properties spring.security.oauth2.client.provider.oidc-provider.issuer-uri=https://dev-123456.oktapreview.com/oauth2/default/ ``` ```yaml spring: security: oauth2: client: provider: oidc-provider: issuer-uri: "https://dev-123456.oktapreview.com/oauth2/default/" ``` By default, Spring Security’s [`OAuth2LoginAuthenticationFilter`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/oauth2/client/web/OAuth2LoginAuthenticationFilter.html) only processes URLs matching `/login/oauth2/code/*`. If you want to customize the `redirect-uri` to use a different pattern, you need to provide configuration to process that custom pattern. For example, for servlet applications, you can add your own [`SecurityFilterChain`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/SecurityFilterChain.html) that resembles the following: * Java * Kotlin ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity; import org.springframework.security.web.SecurityFilterChain; @Configuration(proxyBeanMethods = false) @EnableWebSecurity public class MyOAuthClientConfiguration { @Bean public SecurityFilterChain securityFilterChain(HttpSecurity http) { http.authorizeHttpRequests((requests) -> requests.anyRequest().authenticated() ); http.oauth2Login((login) -> login.redirectionEndpoint((endpoint) -> endpoint.baseUri("/login/oauth2/callback/*") ) ); return http.build(); } } ``` ```kotlin import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.security.config.annotation.web.builders.HttpSecurity import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity import org.springframework.security.config.annotation.web.invoke import org.springframework.security.web.SecurityFilterChain @Configuration(proxyBeanMethods = false) @EnableWebSecurity open class MyOAuthClientConfiguration { @Bean open fun securityFilterChain(http: HttpSecurity): SecurityFilterChain { http { authorizeHttpRequests { authorize(anyRequest, authenticated) } oauth2Login { redirectionEndpoint { baseUri = "/login/oauth2/callback/*" } } } return http.build() } } ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Spring Boot auto-configures an [`InMemoryOAuth2AuthorizedClientService`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/oauth2/client/InMemoryOAuth2AuthorizedClientService.html) which is used by Spring Security for the management of client registrations. The [`InMemoryOAuth2AuthorizedClientService`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/oauth2/client/InMemoryOAuth2AuthorizedClientService.html) has limited capabilities and we recommend using it only for development environments. For production environments, consider using a [`JdbcOAuth2AuthorizedClientService`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/oauth2/client/JdbcOAuth2AuthorizedClientService.html) or creating your own implementation of [`OAuth2AuthorizedClientService`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/oauth2/client/OAuth2AuthorizedClientService.html). | ### [](#security.oauth2.client.common-providers)OAuth2 Client Registration for Common Providers For common OAuth2 and OpenID providers (Google, Github, Facebook, X, and Okta), we provide a set of provider defaults. The IDs of these common providers are `google`, `github`, `facebook`, `x`, and `okta`, respectively. If you do not need to customize these providers, set the registration’s `provider` property to the ID of one of the common providers. Alternatively, you can [use a registration ID that matches the ID of the provider](#security.oauth2.client). The two configurations in the following example use the common `google` provider: * Properties * YAML ```properties spring.security.oauth2.client.registration.my-client.client-id=abcd spring.security.oauth2.client.registration.my-client.client-secret=password spring.security.oauth2.client.registration.my-client.provider=google spring.security.oauth2.client.registration.google.client-id=abcd spring.security.oauth2.client.registration.google.client-secret=password ``` ```yaml spring: security: oauth2: client: registration: my-client: client-id: "abcd" client-secret: "password" provider: "google" google: client-id: "abcd" client-secret: "password" ``` ## [](#security.oauth2.server)Resource Server If you have `spring-security-oauth2-resource-server` on your classpath, Spring Boot can set up an OAuth2 Resource Server. For JWT configuration, a JWK Set URI or OIDC Issuer URI needs to be specified, as shown in the following examples: * Properties * YAML ```properties spring.security.oauth2.resourceserver.jwt.jwk-set-uri=https://example.com/oauth2/default/v1/keys ``` ```yaml spring: security: oauth2: resourceserver: jwt: jwk-set-uri: "https://example.com/oauth2/default/v1/keys" ``` * Properties * YAML ```properties spring.security.oauth2.resourceserver.jwt.issuer-uri=https://dev-123456.oktapreview.com/oauth2/default/ ``` ```yaml spring: security: oauth2: resourceserver: jwt: issuer-uri: "https://dev-123456.oktapreview.com/oauth2/default/" ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If the authorization server does not support a JWK Set URI, you can configure the resource server with the Public Key used for verifying the signature of the JWT. This can be done using the `spring.security.oauth2.resourceserver.jwt.public-key-location` property, where the value needs to point to a file containing the public key in the PEM-encoded x509 format. | The `spring.security.oauth2.resourceserver.jwt.audiences` property can be used to specify the expected values of the aud claim in JWTs. For example, to require JWTs to contain an aud claim with the value `my-audience`: * Properties * YAML ```properties spring.security.oauth2.resourceserver.jwt.audiences[0]=my-audience ``` ```yaml spring: security: oauth2: resourceserver: jwt: audiences: - "my-audience" ``` The same properties are applicable for both servlet and reactive applications. Alternatively, you can define your own [`JwtDecoder`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/oauth2/jwt/JwtDecoder.html) bean for servlet applications or a [`ReactiveJwtDecoder`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/oauth2/jwt/ReactiveJwtDecoder.html) for reactive applications. In cases where opaque tokens are used instead of JWTs, you can configure the following properties to validate tokens through introspection: * Properties * YAML ```properties spring.security.oauth2.resourceserver.opaquetoken.introspection-uri=https://example.com/check-token spring.security.oauth2.resourceserver.opaquetoken.client-id=my-client-id spring.security.oauth2.resourceserver.opaquetoken.client-secret=my-client-secret ``` ```yaml spring: security: oauth2: resourceserver: opaquetoken: introspection-uri: "https://example.com/check-token" client-id: "my-client-id" client-secret: "my-client-secret" ``` Again, the same properties are applicable for both servlet and reactive applications. The result is an auto-configured introspector. Either a [`SpringOpaqueTokenIntrospector`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/oauth2/server/resource/introspection/SpringOpaqueTokenIntrospector.html) or, in a reactive application, a [`SpringReactiveOpaqueTokenIntrospector`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/oauth2/server/resource/introspection/SpringReactiveOpaqueTokenIntrospector.html). These auto-configured introspectors can be customized using [`SpringOpaqueTokenIntrospectorBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/security/oauth2/server/resource/autoconfigure/SpringOpaqueTokenIntrospectorBuilderCustomizer.html) and [`SpringReactiveOpaqueTokenIntrospectorBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/security/oauth2/server/resource/autoconfigure/reactive/SpringReactiveOpaqueTokenIntrospectorBuilderCustomizer.html) beans respectively. To take complete control of the introspection, define your own [`OpaqueTokenIntrospector`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/oauth2/server/resource/introspection/OpaqueTokenIntrospector.html) or [`ReactiveOpaqueTokenIntrospector`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/oauth2/server/resource/introspection/ReactiveOpaqueTokenIntrospector.html) bean. ## [](#security.oauth2.authorization-server)Authorization Server If you have `spring-security-oauth2-authorization-server` on your classpath, you can take advantage of some auto-configuration to set up a Servlet-based OAuth2 Authorization Server. You can register multiple OAuth2 clients under the `spring.security.oauth2.authorizationserver.client` prefix, as shown in the following example: * Properties * YAML ```properties spring.security.oauth2.authorizationserver.client.my-client-1.registration.client-id=abcd spring.security.oauth2.authorizationserver.client.my-client-1.registration.client-secret={noop}secret1 spring.security.oauth2.authorizationserver.client.my-client-1.registration.client-authentication-methods[0]=client_secret_basic spring.security.oauth2.authorizationserver.client.my-client-1.registration.authorization-grant-types[0]=authorization_code spring.security.oauth2.authorizationserver.client.my-client-1.registration.authorization-grant-types[1]=refresh_token spring.security.oauth2.authorizationserver.client.my-client-1.registration.redirect-uris[0]=https://my-client-1.com/login/oauth2/code/abcd spring.security.oauth2.authorizationserver.client.my-client-1.registration.redirect-uris[1]=https://my-client-1.com/authorized spring.security.oauth2.authorizationserver.client.my-client-1.registration.scopes[0]=openid spring.security.oauth2.authorizationserver.client.my-client-1.registration.scopes[1]=profile spring.security.oauth2.authorizationserver.client.my-client-1.registration.scopes[2]=email spring.security.oauth2.authorizationserver.client.my-client-1.registration.scopes[3]=phone spring.security.oauth2.authorizationserver.client.my-client-1.registration.scopes[4]=address spring.security.oauth2.authorizationserver.client.my-client-1.require-authorization-consent=true spring.security.oauth2.authorizationserver.client.my-client-1.token.authorization-code-time-to-live=5m spring.security.oauth2.authorizationserver.client.my-client-1.token.access-token-time-to-live=10m spring.security.oauth2.authorizationserver.client.my-client-1.token.access-token-format=reference spring.security.oauth2.authorizationserver.client.my-client-1.token.reuse-refresh-tokens=false spring.security.oauth2.authorizationserver.client.my-client-1.token.refresh-token-time-to-live=30m spring.security.oauth2.authorizationserver.client.my-client-2.registration.client-id=efgh spring.security.oauth2.authorizationserver.client.my-client-2.registration.client-secret={noop}secret2 spring.security.oauth2.authorizationserver.client.my-client-2.registration.client-authentication-methods[0]=client_secret_jwt spring.security.oauth2.authorizationserver.client.my-client-2.registration.authorization-grant-types[0]=client_credentials spring.security.oauth2.authorizationserver.client.my-client-2.registration.scopes[0]=user.read spring.security.oauth2.authorizationserver.client.my-client-2.registration.scopes[1]=user.write spring.security.oauth2.authorizationserver.client.my-client-2.jwk-set-uri=https://my-client-2.com/jwks spring.security.oauth2.authorizationserver.client.my-client-2.token-endpoint-authentication-signing-algorithm=RS256 ``` ```yaml spring: security: oauth2: authorizationserver: client: my-client-1: registration: client-id: "abcd" client-secret: "{noop}secret1" client-authentication-methods: - "client_secret_basic" authorization-grant-types: - "authorization_code" - "refresh_token" redirect-uris: - "https://my-client-1.com/login/oauth2/code/abcd" - "https://my-client-1.com/authorized" scopes: - "openid" - "profile" - "email" - "phone" - "address" require-authorization-consent: true token: authorization-code-time-to-live: 5m access-token-time-to-live: 10m access-token-format: "reference" reuse-refresh-tokens: false refresh-token-time-to-live: 30m my-client-2: registration: client-id: "efgh" client-secret: "{noop}secret2" client-authentication-methods: - "client_secret_jwt" authorization-grant-types: - "client_credentials" scopes: - "user.read" - "user.write" jwk-set-uri: "https://my-client-2.com/jwks" token-endpoint-authentication-signing-algorithm: "RS256" ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | The `client-secret` property must be in a format that can be matched by the configured [`PasswordEncoder`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/crypto/password/PasswordEncoder.html). The default instance of [`PasswordEncoder`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/crypto/password/PasswordEncoder.html) is created via `PasswordEncoderFactories.createDelegatingPasswordEncoder()`. | The auto-configuration Spring Boot provides for Spring Authorization Server is designed for getting started quickly. Most applications will require customization and will want to define several beans to override auto-configuration. The following components can be defined as beans to override auto-configuration specific to Spring Authorization Server: * [`RegisteredClientRepository`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/oauth2/server/authorization/client/RegisteredClientRepository.html) * [`AuthorizationServerSettings`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/oauth2/server/authorization/settings/AuthorizationServerSettings.html) * [`SecurityFilterChain`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/SecurityFilterChain.html) * `com.nimbusds.jose.jwk.source.JWKSource` * [`JwtDecoder`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/oauth2/jwt/JwtDecoder.html) | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Spring Boot auto-configures an [`InMemoryRegisteredClientRepository`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/oauth2/server/authorization/client/InMemoryRegisteredClientRepository.html) which is used by Spring Authorization Server for the management of registered clients. The [`InMemoryRegisteredClientRepository`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/oauth2/server/authorization/client/InMemoryRegisteredClientRepository.html) has limited capabilities and we recommend using it only for development environments. For production environments, consider using a [`JdbcRegisteredClientRepository`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/oauth2/server/authorization/client/JdbcRegisteredClientRepository.html) or creating your own implementation of [`RegisteredClientRepository`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/oauth2/server/authorization/client/RegisteredClientRepository.html). | Additional information can be found in the [Getting Started](https://docs.spring.io/spring-security/reference/7.1/servlet/oauth2/authorization-server/getting-started.html) chapter of Spring Security Reference Documentation. * [Spring Boot](../../index.html) * [4.1.1](oauth2.html) * [4.0.8](../../4.0/index.html) * [3.5.16](../../3.5/index.html) * [3.4.13](../../3.4/index.html) * [3.3.13](../../3.3/index.html) - [4.2.0-M2](../../4.2/reference/security/oauth2.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/security/oauth2.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/security/oauth2.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/tutorial/first-application/index.html ---- # Developing Your First Spring Boot Application This section describes how to develop a small “Hello World!” web application that highlights some of Spring Boot’s key features. You can choose between Maven or Gradle as the build system. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The [spring.io](https://spring.io) website contains many “Getting Started” [guides](https://spring.io/guides) that use Spring Boot. If you need to solve a specific problem, check there first.You can shortcut the steps below by going to [start.spring.io](https://start.spring.io) and choosing the "Web" starter from the dependencies searcher. Doing so generates a new project structure so that you can [start coding right away](#getting-started.first-application.code). Check the [start.spring.io user guide](https://github.com/spring-io/start.spring.io/blob/main/USING.adoc) for more details. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | This tutorial provides steps that you can follow to build your first Spring Boot application. You don’t need to know Java, however, if you’re the kind of person that prefers learning the fundamentals first, you might want to check out [dev.java/learn/](https://dev.java/learn/) before you begin. | ## [](#getting-started.first-application.prerequisites)Prerequisites Before we begin, open a terminal and run the following commands to ensure that you have a valid version of Java installed: ```shell $ java -version openjdk version "17.0.18" 2026-01-20 LTS OpenJDK Runtime Environment (build 17.0.18+10-LTS) OpenJDK 64-Bit Server VM (build 17.0.18+10-LTS, mixed mode, sharing) ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | This sample needs to be created in its own directory. Subsequent instructions assume that you have created a suitable directory and that it is your current directory. | ### [](#getting-started.first-application.prerequisites.maven)Maven If you want to use Maven, ensure that you have Maven installed: ```shell $ mvn -v Apache Maven 3.9.12 (848fbb4bf2d427b72bdb2471c22fced7ebd9a7a1) Maven home: /Users/developer/.sdkman/candidates/maven/current Java version: 17.0.18, vendor: BellSoft, runtime: /Users/developer/.sdkman/candidates/java/17.0.18-librca ``` ### [](#getting-started.first-application.prerequisites.gradle)Gradle If you want to use Gradle, ensure that you have Gradle installed: ```shell $ gradle --version ------------------------------------------------------------ Gradle 8.14.4 ------------------------------------------------------------ Build time: 2026-01-23 16:30:23 UTC Revision: ad5ff774b4b0e9a8a0cf1a14ca70d7230003c3ad Kotlin: 2.0.21 Groovy: 3.0.25 Ant: Apache Ant(TM) version 1.10.15 compiled on August 25 2024 Launcher JVM: 17.0.18 (BellSoft 17.0.18+10-LTS) Daemon JVM: /Users/developer/.sdkman/candidates/java/17.0.18-librca (no JDK specified, using current Java home) OS: Mac OS X 26.3 aarch64 ``` ## [](#getting-started.first-application.pom)Setting Up the Project With Maven We need to start by creating a Maven `pom.xml` file. The `pom.xml` is the recipe that is used to build your project. Open your favorite text editor and add the following: ```xml 4.0.0 org.springframework.boot spring-boot-starter-parent 4.1.1 com.example myproject 0.0.1-SNAPSHOT ``` The preceding listing should give you a working build. You can test it by running `mvn package` (for now, you can ignore the “jar will be empty - no content was marked for inclusion!” warning). | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | At this point, you could import the project into an IDE (most modern Java IDEs include built-in support for Maven). For simplicity, we continue to use a plain text editor for this example. | ## [](#getting-started.first-application.gradle)Setting Up the Project With Gradle We need to start by creating a Gradle `build.gradle` file. The `build.gradle` is the build script that is used to build your project. Open your favorite text editor and add the following: ```gradle plugins { id 'java' id 'org.springframework.boot' version '4.1.1' id 'io.spring.dependency-management' version '1.1.7' } group = 'com.example' version = '0.0.1-SNAPSHOT' java { toolchain { languageVersion = JavaLanguageVersion.of(17) } } repositories { mavenCentral() } dependencies { } ``` The preceding listing should give you a working build. You can test it by running `gradle classes`. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | At this point, you could import the project into an IDE (most modern Java IDEs include built-in support for Gradle). For simplicity, we continue to use a plain text editor for this example. | ## [](#getting-started.first-application.dependencies)Adding Classpath Dependencies Spring Boot provides a number of starters that let you add jars to your classpath. Starters provide dependencies that you are likely to need when developing a specific type of application. ### [](#getting-started.first-application.dependencies.maven)Maven Most Spring Boot applications use the `spring-boot-starter-parent` in the `parent` section of the POM. The `spring-boot-starter-parent` is a special starter that provides useful Maven defaults. It also provides a [`dependency-management`](../../reference/using/build-systems.html#using.build-systems.dependency-management) section so that you can omit `version` tags for “blessed” dependencies. Since we are developing a web application, we add a `spring-boot-starter-webmvc` dependency. Before that, we can look at what we currently have by running the following command: ```shell $ mvn dependency:tree [INFO] com.example:myproject:jar:0.0.1-SNAPSHOT ``` The `mvn dependency:tree` command prints a tree representation of your project dependencies. You can see that `spring-boot-starter-parent` provides no dependencies by itself. To add the necessary dependencies, edit your `pom.xml` and add the `spring-boot-starter-webmvc` dependency immediately below the `parent` section: ```xml org.springframework.boot spring-boot-starter-webmvc ``` If you run `mvn dependency:tree` again, you see that there are now a number of additional dependencies, including the Tomcat web server and Spring Boot itself. ### [](#getting-started.first-application.dependencies.gradle)Gradle Most Spring Boot applications use the `org.springframework.boot` Gradle plugin. This plugin provides useful defaults and Gradle tasks. The `io.spring.dependency-management` Gradle plugin provides [dependency management](../../reference/using/build-systems.html#using.build-systems.dependency-management) so that you can omit `version` tags for “blessed” dependencies. Since we are developing a web application, we add a `spring-boot-starter-webmvc` dependency. Before that, we can look at what we currently have by running the following command: ```shell $ gradle dependencies > Task :dependencies ------------------------------------------------------------ Root project 'myproject' ------------------------------------------------------------ ``` The `gradle dependencies` command prints a tree representation of your project dependencies. Right now, the project has no dependencies. To add the necessary dependencies, edit your `build.gradle` and add the `spring-boot-starter-webmvc` dependency in the `dependencies` section: ```gradle dependencies { implementation 'org.springframework.boot:spring-boot-starter-webmvc' } ``` If you run `gradle dependencies` again, you see that there are now a number of additional dependencies, including the Tomcat web server and Spring Boot itself. ## [](#getting-started.first-application.code)Writing the Code To finish our application, we need to create a single Java file. By default, Maven and Gradle compile sources from `src/main/java`, so you need to create that directory structure and then add a file named `src/main/java/com/example/MyApplication.java` to contain the following code: * Java * Kotlin ```java package com.example; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController @SpringBootApplication public class MyApplication { @RequestMapping("/") String home() { return "Hello World!"; } public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } ``` ```kotlin package com.example import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.runApplication import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController @RestController @SpringBootApplication class MyApplication { @RequestMapping("/") fun home() = "Hello World!" } fun main(args: Array) { runApplication(*args) } ``` Although there is not much code here, quite a lot is going on. We step through the important parts in the next few sections. ### [](#getting-started.first-application.code.mvc-annotations)The @RestController and @RequestMapping Annotations The first annotation on our `MyApplication` class is [`@RestController`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/RestController.html). This is known as a *stereotype* annotation. It provides hints for people reading the code and for Spring that the class plays a specific role. In this case, our class is a web [`@Controller`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Controller.html), so Spring considers it when handling incoming web requests. The [`@RequestMapping`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/RequestMapping.html) annotation provides “routing” information. It tells Spring that any HTTP request with the `/` path should be mapped to the `home` method. The [`@RestController`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/RestController.html) annotation tells Spring to render the resulting string directly back to the caller. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The [`@RestController`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/RestController.html) and [`@RequestMapping`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/RequestMapping.html) annotations are Spring MVC annotations (they are not specific to Spring Boot). See the [MVC section](https://docs.spring.io/spring-framework/reference/7.0/web/webmvc.html) in the Spring Reference Documentation for more details. | ### [](#getting-started.first-application.code.spring-boot-application)The @SpringBootApplication Annotation The second class-level annotation is [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html). This annotation is known as a *meta-annotation*, it combines [`@SpringBootConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringBootConfiguration.html), [`@EnableAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/EnableAutoConfiguration.html) and [`@ComponentScan`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/ComponentScan.html). Of those, the annotation we’re most interested in here is [`@EnableAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/EnableAutoConfiguration.html). [`@EnableAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/EnableAutoConfiguration.html) tells Spring Boot to “guess” how you want to configure Spring, based on the jar dependencies that you have added. Since `spring-boot-starter-webmvc` added Tomcat and Spring MVC, the auto-configuration assumes that you are developing a web application and sets up Spring accordingly. Starters and Auto-configuration Auto-configuration is designed to work well with starters, but the two concepts are not directly tied. You are free to pick and choose jar dependencies outside of the starters. Spring Boot still does its best to auto-configure your application. ### [](#getting-started.first-application.code.main-method)The “main” Method The final part of our application is the `main` method. This is a standard method that follows the Java convention for an application entry point. Our main method delegates to Spring Boot’s [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) class by calling `run`. [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) bootstraps our application, starting Spring, which, in turn, starts the auto-configured Tomcat web server. We need to pass `MyApplication.class` as an argument to the `run` method to tell [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) which is the primary Spring component. The `args` array is also passed through to expose any command-line arguments. ## [](#getting-started.first-application.run)Running the Example ### [](#getting-started.first-application.run.maven)Maven At this point, your application should work. Since you used the `spring-boot-starter-parent` POM, you have a useful `run` goal that you can use to start the application. Type `mvn spring-boot:run` from the root project directory to start the application. You should see output similar to the following: ```shell $ mvn spring-boot:run . ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ \\/ ___)| |_)| | | | | || (_| | ) ) ) ) ' |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot :: (v4.1.1) ....... . . . ....... . . . (log output here) ....... . . . ........ Started MyApplication in 0.906 seconds (process running for 6.514) ``` If you open a web browser to `localhost:8080`, you should see the following output: ```none Hello World! ``` To gracefully exit the application, press `ctrl-c`. ### [](#getting-started.first-application.run.gradle)Gradle At this point, your application should work. Since you used the `org.springframework.boot` Gradle plugin, you have a useful `bootRun` goal that you can use to start the application. Type `gradle bootRun` from the root project directory to start the application. You should see output similar to the following: ```shell $ gradle bootRun . ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ \\/ ___)| |_)| | | | | || (_| | ) ) ) ) ' |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot :: (v4.1.1) ....... . . . ....... . . . (log output here) ....... . . . ........ Started MyApplication in 0.906 seconds (process running for 6.514) ``` If you open a web browser to `localhost:8080`, you should see the following output: ```none Hello World! ``` To gracefully exit the application, press `ctrl-c`. ## [](#getting-started.first-application.executable-jar)Creating an Executable Jar We finish our example by creating a completely self-contained executable jar file that we could run in production. Executable jars (sometimes called “uber jars” or “fat jars”) are archives containing your compiled classes along with all of the jar dependencies that your code needs to run. Executable jars and Java Java does not provide a standard way to load nested jar files (jar files that are themselves contained within a jar). This can be problematic if you are looking to distribute a self-contained application. To solve this problem, many developers use “uber” jars. An uber jar packages all the classes from all the application’s dependencies into a single archive. The problem with this approach is that it becomes hard to see which libraries are in your application. It can also be problematic if the same filename is used (but with different content) in multiple jars. Spring Boot takes a [different approach](../../specification/executable-jar/index.html) and lets you actually nest jars directly. ### [](#getting-started.first-application.executable-jar.maven)Maven To create an executable jar, we need to add the `spring-boot-maven-plugin` to our `pom.xml`. To do so, insert the following lines just below the `dependencies` section: ```xml org.springframework.boot spring-boot-maven-plugin ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The `spring-boot-starter-parent` POM includes `` configuration to bind the `repackage` goal. If you do not use the parent POM, you need to declare this configuration yourself. See the [plugin documentation](../../maven-plugin/getting-started.html) for details. | Save your `pom.xml` and run `mvn package` from the command line, as follows: ```shell $ mvn package [INFO] Scanning for projects... [INFO] [INFO] ------------------------------------------------------------------------ [INFO] Building myproject 0.0.1-SNAPSHOT [INFO] ------------------------------------------------------------------------ [INFO] .... .. [INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ myproject --- [INFO] Building jar: /Users/developer/example/spring-boot-example/target/myproject-0.0.1-SNAPSHOT.jar [INFO] [INFO] --- spring-boot-maven-plugin:4.1.1:repackage (default) @ myproject --- [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ ``` If you look in the `target` directory, you should see `myproject-0.0.1-SNAPSHOT.jar`. The file should be around 18 MB in size. If you want to peek inside, you can use `jar tvf`, as follows: ```shell $ jar tvf target/myproject-0.0.1-SNAPSHOT.jar ``` You should also see a much smaller file named `myproject-0.0.1-SNAPSHOT.jar.original` in the `target` directory. This is the original jar file that Maven created before it was repackaged by Spring Boot. To run that application, use the `java -jar` command, as follows: ```shell $ java -jar target/myproject-0.0.1-SNAPSHOT.jar . ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ \\/ ___)| |_)| | | | | || (_| | ) ) ) ) ' |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot :: (v4.1.1) ....... . . . ....... . . . (log output here) ....... . . . ........ Started MyApplication in 0.497 seconds (process running for 0.651) ``` As before, to exit the application, press `ctrl-c`. ### [](#getting-started.first-application.executable-jar.gradle)Gradle To create an executable jar, we need to run `gradle bootJar` from the command line, as follows: ```shell $ gradle bootJar BUILD SUCCESSFUL in 639ms 3 actionable tasks: 3 executed ``` If you look in the `build/libs` directory, you should see `myproject-0.0.1-SNAPSHOT.jar`. The file should be around 18 MB in size. If you want to peek inside, you can use `jar tvf`, as follows: ```shell $ jar tvf build/libs/myproject-0.0.1-SNAPSHOT.jar ``` To run that application, use the `java -jar` command, as follows: ```shell $ java -jar build/libs/myproject-0.0.1-SNAPSHOT.jar . ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ \\/ ___)| |_)| | | | | || (_| | ) ) ) ) ' |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot :: (v{version-spring-boot}) ....... . . . ....... . . . (log output here) ....... . . . ........ Started MyApplication in 0.484 seconds (process running for 0.642) ``` As before, to exit the application, press `ctrl-c`. * [Spring Boot](../../index.html) * [4.1.1](index.html) * [4.0.8](../../4.0/tutorial/first-application/index.html) * [3.5.16](../../3.5/tutorial/first-application/index.html) * [3.4.13](../../3.4/tutorial/first-application/index.html) * [3.3.13](../../3.3/tutorial/first-application/index.html) - [4.2.0-M2](../../4.2/tutorial/first-application/index.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/tutorial/first-application/index.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/tutorial/first-application/index.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/tutorial/first-application/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/how-to/native-image/developing-your-first-application.html ---- # Developing Your First GraalVM Native Application There are two main ways to build a Spring Boot native image application: * Using Spring Boot [support for Cloud Native Buildpacks](../../reference/packaging/container-images/cloud-native-buildpacks.html) with the [Paketo Java Native Image buildpack](https://paketo.io/docs/reference/java-native-image-reference/) to generate a lightweight container containing a native executable. * Using GraalVM Native Build Tools to generate a native executable. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The easiest way to start a new native Spring Boot project is to go to [start.spring.io](https://start.spring.io), add the `GraalVM Native Support` dependency and generate the project. The included `HELP.md` file will provide getting started hints. | ## [](#howto.native-image.developing-your-first-application.sample-application)Sample Application We need an example application that we can use to create our native image. For our purposes, the simple "Hello World!" web application that’s covered in the [Developing Your First Spring Boot Application](../../tutorial/first-application/index.html) section will suffice. To recap, our main application code looks like this: ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController @SpringBootApplication public class MyApplication { @RequestMapping("/") String home() { return "Hello World!"; } public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } ``` This application uses Spring MVC and embedded Tomcat, both of which have been tested and verified to work with GraalVM native images. ## [](#howto.native-image.developing-your-first-application.buildpacks)Building a Native Image Using Buildpacks Spring Boot supports building Docker images containing native executables, using Cloud Native Buildpacks (CNB) integration with both Maven and Gradle and the [Paketo Java Native Image buildpack](https://paketo.io/docs/reference/java-native-image-reference/). This means you can just type a single command and quickly get a sensible image into your locally running Docker daemon. The resulting image doesn’t contain a JVM, instead the native image is compiled statically. This leads to smaller images. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | The CNB builder used for the images is `paketobuildpacks/builder-noble-java-tiny:latest`. It has a small footprint and reduced attack surface. It does not include a shell and contains a reduced set of system libraries. If you need more tools in the resulting image, you can use `paketobuildpacks/ubuntu-noble-run:latest` as the **run** image. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You have to build your application with at least JDK 25, because Buildpacks use the same GraalVM native-image version as the Java version used for compilation. | ### [](#howto.native-image.developing-your-first-application.buildpacks.system-requirements)System Requirements Docker should be installed. See [Get Docker](https://docs.docker.com/installation/#installation) for more details. [Configure it to allow non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) if you are on Linux. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can run `docker run hello-world` (without `sudo`) to check the Docker daemon is reachable as expected. Check the [Maven](../../maven-plugin/build-image.html#build-image.docker-daemon) or [Gradle](../../gradle-plugin/packaging-oci-image.html#build-image.docker-daemon) Spring Boot plugin documentation for more details. | | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | On macOS, it is recommended to increase the memory allocated to Docker to at least `8GB`, and potentially add more CPUs as well. See this [Stack Overflow answer](https://stackoverflow.com/questions/44533319/how-to-assign-more-memory-to-docker-container/44533437#44533437) for more details. On Microsoft Windows, make sure to enable the [Docker WSL 2 backend](https://docs.docker.com/docker-for-windows/wsl/) for better performance. | ### [](#howto.native-image.developing-your-first-application.buildpacks.maven)Using Maven To build a native image container using Maven you should ensure that your `pom.xml` file uses the `spring-boot-starter-parent` and the `org.graalvm.buildtools:native-maven-plugin`. You should have a `` section that looks like this: ```xml org.springframework.boot spring-boot-starter-parent 4.1.1 ``` You additionally should have this in the ` ` section: ```xml org.graalvm.buildtools native-maven-plugin ``` The `spring-boot-starter-parent` declares a `native` profile that configures the executions that need to run in order to create a native image. You can activate profiles using the `-P` flag on the command line. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you don’t want to use `spring-boot-starter-parent` you’ll need to configure executions for the `process-aot` goal from Spring Boot’s plugin and the `add-reachability-metadata` goal from the Native Build Tools plugin. | To build the image, you can run the `spring-boot:build-image` goal with the `native` profile active: ```shell $ mvn -Pnative spring-boot:build-image ``` ### [](#howto.native-image.developing-your-first-application.buildpacks.gradle)Using Gradle The Spring Boot Gradle plugin automatically configures AOT tasks when the GraalVM Native Image plugin is applied. You should check that your Gradle build contains a `plugins` block that includes `org.graalvm.buildtools.native`. As long as the `org.graalvm.buildtools.native` plugin is applied, the `bootBuildImage` task will generate a native image rather than a JVM one. You can run the task using: ```shell $ gradle bootBuildImage ``` ### [](#howto.native-image.developing-your-first-application.buildpacks.running)Running the example Once you have run the appropriate build command, a Docker image should be available. You can start your application using `docker run`: ```shell $ docker run --rm -p 8080:8080 docker.io/library/myproject:0.0.1-SNAPSHOT ``` You should see output similar to the following: ```shell . ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ \\/ ___)| |_)| | | | | || (_| | ) ) ) ) ' |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot :: (v{version-spring-boot}) ....... . . . ....... . . . (log output here) ....... . . . ........ Started MyApplication in 0.08 seconds (process running for 0.095) ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------- | | ** | The startup time differs from machine to machine, but it should be much faster than a Spring Boot application running on a JVM. | If you open a web browser to `localhost:8080`, you should see the following output: ```none Hello World! ``` To gracefully exit the application, press `ctrl-c`. ## [](#howto.native-image.developing-your-first-application.native-build-tools)Building a Native Image using Native Build Tools If you want to generate a native executable directly without using Docker, you can use GraalVM Native Build Tools. Native Build Tools are plugins shipped by GraalVM for both Maven and Gradle. You can use them to perform a variety of GraalVM tasks, including generating a native image. ### [](#howto.native-image.developing-your-first-application.native-build-tools.prerequisites)Prerequisites To build a native image using the Native Build Tools, you’ll need a GraalVM distribution on your machine. You can either download it manually on the [Liberica Native Image Kit page](https://bell-sw.com/pages/downloads/native-image-kit/#/nik-22-17), or you can use a download manager like SDKMAN!. #### [](#howto.native-image.developing-your-first-application.native-build-tools.prerequisites.linux-macos)Linux and macOS To install the native image compiler on macOS or Linux, we recommend using SDKMAN!. Get SDKMAN! from [sdkman.io](https://sdkman.io) and install the Liberica GraalVM distribution by using the following commands: ```shell $ sdk install java 25.r25-nik $ sdk use java 25.r25-nik ``` Verify that the correct version has been configured by checking the output of `java -version`: ```shell $ java -version openjdk version "25" 2025-09-16 LTS OpenJDK Runtime Environment Liberica-NIK-25.0.0-1 (build 25+37-LTS) OpenJDK 64-Bit Server VM Liberica-NIK-25.0.0-1 (build 25+37-LTS, mixed mode, sharing) ``` #### [](#howto.native-image.developing-your-first-application.native-build-tools.prerequisites.windows)Windows On Windows, follow [these instructions](https://medium.com/graalvm/using-graalvm-and-native-image-on-windows-10-9954dc071311) to install either [GraalVM](https://www.graalvm.org/downloads/) or [Liberica Native Image Kit](https://bell-sw.com/pages/downloads/native-image-kit/#/nik-22-17) in version 25, the Visual Studio Build Tools and the Windows SDK. Due to the [Windows related command-line maximum length](https://docs.microsoft.com/en-US/troubleshoot/windows-client/shell-experience/command-line-string-limitation), make sure to use x64 Native Tools Command Prompt instead of the regular Windows command line to run Maven or Gradle plugins. ### [](#howto.native-image.developing-your-first-application.native-build-tools.maven)Using Maven As with the [buildpacks support](#howto.native-image.developing-your-first-application.buildpacks.maven), you need to make sure that you’re using `spring-boot-starter-parent` in order to inherit the `native` profile and that the `org.graalvm.buildtools:native-maven-plugin` plugin is used. With the `native` profile active, you can invoke the `native:compile` goal to trigger `native-image` compilation: ```shell $ mvn -Pnative native:compile ``` The native image executable can be found in the `target` directory. ### [](#howto.native-image.developing-your-first-application.native-build-tools.gradle)Using Gradle When the Native Build Tools Gradle plugin is applied to your project, the Spring Boot Gradle plugin will automatically trigger the Spring AOT engine. Task dependencies are automatically configured, so you can just run the standard `nativeCompile` task to generate a native image: ```shell $ gradle nativeCompile ``` The native image executable can be found in the `build/native/nativeCompile` directory. ### [](#howto.native-image.developing-your-first-application.native-build-tools.running)Running the Example At this point, your application should work. You can now start the application by running it directly: * Maven * Gradle ```shell $ target/myproject ``` ```shell $ build/native/nativeCompile/myproject ``` You should see output similar to the following: ```shell . ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ \\/ ___)| |_)| | | | | || (_| | ) ) ) ) ' |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot :: (v4.1.1) ....... . . . ....... . . . (log output here) ....... . . . ........ Started MyApplication in 0.08 seconds (process running for 0.095) ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------- | | ** | The startup time differs from machine to machine, but it should be much faster than a Spring Boot application running on a JVM. | If you open a web browser to `localhost:8080`, you should see the following output: ```none Hello World! ``` To gracefully exit the application, press `ctrl-c`. * [Spring Boot](../../index.html) * [4.1.1](developing-your-first-application.html) * [4.0.8](../../4.0/how-to/native-image/developing-your-first-application.html) * [3.5.16](../../3.5/how-to/native-image/developing-your-first-application.html) * [3.4.13](../../3.4/how-to/native-image/developing-your-first-application.html) * [3.3.13](../../3.3/how-to/native-image/developing-your-first-application.html) - [4.2.0-M2](../../4.2/how-to/native-image/developing-your-first-application.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/how-to/native-image/developing-your-first-application.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/how-to/native-image/developing-your-first-application.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/how-to/native-image/developing-your-first-application.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/AbstractPackagerMojo.html ---- # Class AbstractPackagerMojo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.plugin.AbstractMojo [org.springframework.boot.maven.AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") org.springframework.boot.maven.AbstractPackagerMojo * All Implemented Interfaces: `org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo` - Direct Known Subclasses: `BuildImageMojo, RepackageMojo` *** public abstract class AbstractPackagerMojo extends [AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") Abstract base class for classes that work with an `Packager`. * Since: 2.3.0 * Author: Phillip Webb, Scott Frederick, Moritz Halbritter - ## Nested Class Summary Nested Classes Modifier and Type Class Description `static enum ` `AbstractPackagerMojo.LayoutType` Archive layout types. ### Nested classes/interfaces inherited from class [AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html#nested-class-summary "class in org.springframework.boot.maven") `AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter` - ## Field Summary Fields Modifier and Type Field Description `boolean` `includeOptional` Include optional dependencies. `boolean` `includeSystemScope` Include system scoped dependencies. `boolean` `includeTools` Include JAR tools. `protected org.apache.maven.project.MavenProject` `project` The Maven project. `protected final org.apache.maven.project.MavenProjectHelper` `projectHelper` Maven project helper utils. `protected org.apache.maven.execution.MavenSession` `session` The Maven session. `AbstractPackagerMojo(org.apache.maven.project.MavenProjectHelper projectHelper)`   - ## Method Summary Modifier and Type Method Description `protected

P` `getConfiguredPackager(Supplier

 supplier)` Return a `Packager` configured for this MOJO. `protected @Nullable AbstractPackagerMojo.LayoutType` `getLayout()` Return the type of archive that should be packaged by this MOJO. `protected @Nullable org.springframework.boot.loader.tools.LayoutFactory` `getLayoutFactory()` Return the layout factory that will be used to determine the [`AbstractPackagerMojo.LayoutType`](AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") if no explicit layout is set. `protected final org.springframework.boot.loader.tools.Libraries` `getLibraries(@Nullable Collection unpacks)` Return `Libraries` that the packager can use. `protected org.apache.maven.artifact.Artifact` `getSourceArtifact(@Nullable String classifier)` Return the source `Artifact` to repackage. `protected File` `getTargetFile(String finalName, @Nullable String classifier, File targetDirectory)`   ### Methods inherited from class [AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html#method-summary "class in org.springframework.boot.maven") `filterDependencies, getDependencyURLs, setExcludeGroupIds, setExcludes, setIncludes, toURL` @Parameter(defaultValue="${project}", readonly=true, required=true) protected org.apache.maven.project.MavenProject project The Maven project. * Since: 1.0.0 * ### session @Parameter(defaultValue="${session}", readonly=true, required=true) protected org.apache.maven.execution.MavenSession session The Maven session. * Since: 2.4.0 * ### projectHelper protected final org.apache.maven.project.MavenProjectHelper projectHelper Maven project helper utils. * Since: 1.0.0 * ### includeSystemScope @Parameter(defaultValue="false") public boolean includeSystemScope Include system scoped dependencies. * Since: 1.4.0 * ### includeOptional @Parameter(defaultValue="false") public boolean includeOptional Include optional dependencies. * Since: 3.5.7 * ### includeTools @Parameter(defaultValue="true") public boolean includeTools Include JAR tools. * Since: 3.3.0 * ## Constructor Details * ### AbstractPackagerMojo protected AbstractPackagerMojo​(org.apache.maven.project.MavenProjectHelper projectHelper) * ## Method Details * ### getLayout protected @Nullable [AbstractPackagerMojo.LayoutType](AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") getLayout() Return the type of archive that should be packaged by this MOJO. * Returns: `null`, indicating a layout type will be chosen based on the original archive type * ### getLayoutFactory protected @Nullable org.springframework.boot.loader.tools.LayoutFactory getLayoutFactory() Return the layout factory that will be used to determine the [`AbstractPackagerMojo.LayoutType`](AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") if no explicit layout is set. * Returns: `null`, indicating a default layout factory will be chosen * ### getConfiguredPackager protected \

P getConfiguredPackager​([Supplier](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html "class or interface in java.util.function")\

 supplier) Return a `Packager` configured for this MOJO. * Type Parameters: `P` - the packager type * Parameters: `supplier` - a packager supplier * Returns: a configured packager * ### getLibraries protected final org.springframework.boot.loader.tools.Libraries getLibraries​(@Nullable [Collection](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html "class or interface in java.util")\ unpacks) throws org.apache.maven.plugin.MojoExecutionException Return `Libraries` that the packager can use. * Parameters: `unpacks` - any libraries that require unpack * Returns: the libraries to use * Throws: `org.apache.maven.plugin.MojoExecutionException` - on execution error * ### getSourceArtifact protected org.apache.maven.artifact.Artifact getSourceArtifact​(@Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") classifier) Return the source `Artifact` to repackage. If a classifier is specified and an artifact with that classifier exists, it is used. Otherwise, the main artifact is used. * Parameters: `classifier` - the artifact classifier * Returns: the source artifact to repackage * ### getTargetFile protected [File](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html "class or interface in java.io") getTargetFile​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") finalName, @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") classifier, [File](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html "class or interface in java.io") targetDirectory) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/index-files/index-12.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ## R * [requiresUnpack(String...)](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html#requiresUnpack\(java.lang.String...\)) - Method in interface org.springframework.boot.gradle.tasks.bundling.[BootArchive](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") Adds Ant-style patterns that identify files that must be unpacked from the archive when it is launched. * [requiresUnpack(String...)](../org/springframework/boot/gradle/tasks/bundling/BootJar.html#requiresUnpack\(java.lang.String...\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootJar](../org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling")   * [requiresUnpack(String...)](../org/springframework/boot/gradle/tasks/bundling/BootWar.html#requiresUnpack\(java.lang.String...\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootWar](../org/springframework/boot/gradle/tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling")   * [requiresUnpack(Spec)](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html#requiresUnpack\(org.gradle.api.specs.Spec\)) - Method in interface org.springframework.boot.gradle.tasks.bundling.[BootArchive](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") Adds a spec that identifies files that must be unpacked from the archive when it is launched. * [requiresUnpack(Spec)](../org/springframework/boot/gradle/tasks/bundling/BootJar.html#requiresUnpack\(org.gradle.api.specs.Spec\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootJar](../org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling")   * [requiresUnpack(Spec)](../org/springframework/boot/gradle/tasks/bundling/BootWar.html#requiresUnpack\(org.gradle.api.specs.Spec\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootWar](../org/springframework/boot/gradle/tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling")   * [RESOLVE\_MAIN\_CLASS\_NAME\_TASK\_NAME](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html#RESOLVE_MAIN_CLASS_NAME_TASK_NAME) - Static variable in class org.springframework.boot.gradle.plugin.[SpringBootPlugin](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html "class in org.springframework.boot.gradle.plugin") The name of the [`ResolveMainClassName`](../org/springframework/boot/gradle/plugin/ResolveMainClassName.html "class in org.springframework.boot.gradle.plugin") task used to resolve a main class from the output of the `main` source set. * [RESOLVE\_TEST\_MAIN\_CLASS\_NAME\_TASK\_NAME](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html#RESOLVE_TEST_MAIN_CLASS_NAME_TASK_NAME) - Static variable in class org.springframework.boot.gradle.plugin.[SpringBootPlugin](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html "class in org.springframework.boot.gradle.plugin") The name of the [`ResolveMainClassName`](../org/springframework/boot/gradle/plugin/ResolveMainClassName.html "class in org.springframework.boot.gradle.plugin") task used to resolve a main class from the output of the `test` source set then, if needed, the output of the `main` source set. * [resolvedArtifacts(Provider)](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html#resolvedArtifacts\(org.gradle.api.provider.Provider\)) - Method in interface org.springframework.boot.gradle.tasks.bundling.[BootArchive](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") Registers the given lazily provided `resolvedArtifacts`. * [resolvedArtifacts(Provider)](../org/springframework/boot/gradle/tasks/bundling/BootJar.html#resolvedArtifacts\(org.gradle.api.provider.Provider\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootJar](../org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling")   * [resolvedArtifacts(Provider)](../org/springframework/boot/gradle/tasks/bundling/BootWar.html#resolvedArtifacts\(org.gradle.api.provider.Provider\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootWar](../org/springframework/boot/gradle/tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling")   * [ResolveMainClassName](../org/springframework/boot/gradle/plugin/ResolveMainClassName.html "class in org.springframework.boot.gradle.plugin") - Class in [org.springframework.boot.gradle.plugin](../org/springframework/boot/gradle/plugin/package-summary.html) [`Task`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") for resolving the name of the application's main class. * [ResolveMainClassName()](../org/springframework/boot/gradle/plugin/ResolveMainClassName.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.gradle.plugin.[ResolveMainClassName](../org/springframework/boot/gradle/plugin/ResolveMainClassName.html "class in org.springframework.boot.gradle.plugin") Creates a new instance of the `ResolveMainClassName` task. * [resolveZipCompression(FileCopyDetails)](../org/springframework/boot/gradle/tasks/bundling/BootJar.html#resolveZipCompression\(org.gradle.api.file.FileCopyDetails\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootJar](../org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling") Return the [`ZipCompression`](../org/springframework/boot/gradle/tasks/bundling/ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") that should be used when adding the file represented by the given `details` to the jar. * [resolveZipCompression(FileCopyDetails)](../org/springframework/boot/gradle/tasks/bundling/BootWar.html#resolveZipCompression\(org.gradle.api.file.FileCopyDetails\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootWar](../org/springframework/boot/gradle/tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling") Return the [`ZipCompression`](../org/springframework/boot/gradle/tasks/bundling/ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") that should be used when adding the file represented by the given `details` to the jar. [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ---- url: https://docs.spring.io/spring-boot/index.html ---- # Spring Boot Spring Boot helps you to create stand-alone, production-grade Spring-based applications that you can run. We take an opinionated view of the Spring platform and third-party libraries, so that you can get started with minimum fuss. Most Spring Boot applications need very little Spring configuration. You can use Spring Boot to create Java applications that can be started by using `java -jar` or more traditional war deployments. Our primary goals are: * Provide a radically faster and widely accessible getting-started experience for all Spring development. * Be opinionated out of the box but get out of the way quickly as requirements start to diverge from the defaults. * Provide a range of non-functional features that are common to large classes of projects (such as embedded servers, security, metrics, health checks, and externalized configuration). * Absolutely no code generation (when not targeting native image) and no requirement for XML configuration. - [Spring Boot](index.html) * [4.1.1](index.html) * [4.0.8](4.0/index.html) * [3.5.16](3.5/index.html) * [3.4.13](3.4/index.html) * [3.3.13](3.3/index.html) - [4.2.0-M2](4.2/index.html) * [4.2.0-SNAPSHOT](4.2-SNAPSHOT/index.html) * [4.1.3-SNAPSHOT](4.1-SNAPSHOT/index.html) * [4.0.10-SNAPSHOT](4.0-SNAPSHOT/index.html) * Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/reacting.html ---- # Reacting to Other Plugins When another plugin is applied the Spring Boot plugin reacts by making various changes to the project’s configuration. This section describes those changes. ## [](#reacting-to-other-plugins.java)Reacting to the Java Plugin When Gradle’s [`java` plugin](https://docs.gradle.org/current/userguide/java_plugin.html) is applied to a project, the Spring Boot plugin: 1. Creates a [`BootJar`](api/java/org/springframework/boot/gradle/tasks/bundling/BootJar.html) task named `bootJar` that will create an executable, uber jar for the project. The jar will contain everything on the runtime classpath of the main source set; classes are packaged in `BOOT-INF/classes` and jars are packaged in `BOOT-INF/lib` 2. Configures the `assemble` task to depend on the `bootJar` task. 3. Configures the `jar` task to use `plain` as the convention for its archive classifier. 4. Creates a [`BootBuildImage`](api/java/org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html) task named `bootBuildImage` that will create a OCI image using a [buildpack](https://buildpacks.io). 5. Creates a [`BootRun`](api/java/org/springframework/boot/gradle/tasks/run/BootRun.html) task named `bootRun` that can be used to run your application using the `main` source set to find its main method and provide its runtime classpath. 6. Creates a [`BootRun`](api/java/org/springframework/boot/gradle/tasks/run/BootRun.html) task named `bootTestRun` that can be used to run your application using the `test` source set to find its main method and provide its runtime classpath. 7. Creates a configuration named `bootArchives` that contains the artifact produced by the `bootJar` task. 8. Creates a configuration named `developmentOnly` for dependencies that are only required at development time, such as Spring Boot’s Devtools, and should not be packaged in executable jars and wars. 9. Creates a configuration named `testAndDevelopmentOnly` for dependencies that are only required at development time and when writing and running tests and that should not be packaged in executable jars and wars. 10. Creates a configuration named `productionRuntimeClasspath`. It is equivalent to `runtimeClasspath` minus any dependencies that only appear in the `developmentOnly` or `testDevelopmentOnly` configurations. 11. Configures any `JavaCompile` tasks with no configured encoding to use `UTF-8`. 12. Configures any `JavaCompile` tasks to use the `-parameters` compiler argument. ## [](#reacting-to-other-plugins.kotlin)Reacting to the Kotlin Plugin When [Kotlin’s Gradle plugin](https://kotlinlang.org/docs/reference/using-gradle.html) is applied to a project, the Spring Boot plugin: 1. Aligns the Kotlin version used in Spring Boot’s dependency management with the version of the plugin. This is achieved by setting the `kotlin.version` property with a value that matches the version of the Kotlin plugin. 2. Configures any `KotlinCompile` tasks to use the `-java-parameters` compiler argument. ## [](#reacting-to-other-plugins.war)Reacting to the War Plugin When Gradle’s [`war` plugin](https://docs.gradle.org/current/userguide/war_plugin.html) is applied to a project, the Spring Boot plugin: 1. Creates a [`BootWar`](api/java/org/springframework/boot/gradle/tasks/bundling/BootWar.html) task named `bootWar` that will create an executable, fat war for the project. In addition to the standard packaging, everything in the `providedRuntime` configuration will be packaged in `WEB-INF/lib-provided`. 2. Configures the `assemble` task to depend on the `bootWar` task. 3. Configures the `war` task to use `plain` as the convention for its archive classifier. 4. Configures the `bootArchives` configuration to contain the artifact produced by the `bootWar` task. ## [](#reacting-to-other-plugins.dependency-management)Reacting to the Dependency Management Plugin When the [`io.spring.dependency-management` plugin](https://github.com/spring-gradle-plugins/dependency-management-plugin) is applied to a project, the Spring Boot plugin will automatically import the `spring-boot-dependencies` bom. ## [](#reacting-to-other-plugins.application)Reacting to the Application Plugin When Gradle’s [`application` plugin](https://docs.gradle.org/current/userguide/application_plugin.html) is applied to a project, the Spring Boot plugin: 1. Creates a `CreateStartScripts` task named `bootStartScripts` that will create scripts that launch the artifact in the `bootArchives` configuration using `java -jar`. The task is configured to use the `applicationDefaultJvmArgs` property as a convention for its `defaultJvmOpts` property. 2. Creates a new distribution named `boot` and configures it to contain the artifact in the `bootArchives` configuration in its `lib` directory and the start scripts in its `bin` directory. 3. Configures the `bootRun` task to use the `mainClassName` property as a convention for its `main` property. 4. Configures the `bootRun` and `bootTestRun` tasks to use the `applicationDefaultJvmArgs` property as a convention for their `jvmArgs` property. 5. Configures the `bootJar` task to use the `mainClassName` property as a convention for the `Start-Class` entry in its manifest. 6. Configures the `bootWar` task to use the `mainClassName` property as a convention for the `Start-Class` entry in its manifest. ## [](#reacting-to-other-plugins.nbt)Reacting to the GraalVM Native Image Plugin When the [GraalVM Native Image plugin](https://graalvm.github.io/native-build-tools/1.1.8/gradle-plugin.html) is applied to a project, the Spring Boot plugin: 1. Applies the `org.springframework.boot.aot` plugin that: 1. Registers `aot` and `aotTest` source sets. 2. Registers a `ProcessAot` task named `processAot` that will generate AOT-optimized source for the application in the `aot` source set. 3. Configures the Java compilation and process resources tasks for the `aot` source set to depend upon `processAot`. 4. Registers a `ProcessTestAot` task named `processTestAot` that will generated AOT-optimized source for the application’s tests in the `aotTest` source set. 5. Configures the Java compilation and process resources tasks for the `aotTest` source set to depend upon `processTestAot`. 2. Adds the output of the `aot` source set to the classpath of the `main` GraalVM native binary. 3. Adds the output of the `aotTest` source set to the classpath of the `test` GraalVM native binary. 4. Configures the GraalVM extension to disable Toolchain detection. 5. Configures the `bootJar` task to include the reachability metadata produced by the `collectReachabilityMetadata` task in its jar. 6. Configures the `bootJar` task to add the `Spring-Boot-Native-Processed: true` manifest entry. ## [](#reacting-to-other-plugins.cyclonedx)Reacting to the CycloneDX Plugin When the [CycloneDX plugin](https://github.com/CycloneDX/cyclonedx-gradle-plugin) is applied to a project, the Spring Boot plugin: 1. Configures the `cyclonedxBom` task to: 1. Use the `application` project type. 2. Output a JSON-format SBOM to the `application.cdx.json` file. 3. Disable the XML-format SBOM. 4. Disable full license texts. 2. Adds the SBOM under `META-INF/sbom` in the generated jar or war file. 3. Adds the `Sbom-Format` and `Sbom-Location` to the manifest of the jar or war file. ## [](#reacting-to-other-plugins.protobuf)Reacting to the Protobuf Plugin When the [Protobuf plugin](https://github.com/google/protobuf-gradle-plugin) is applied to a project, the Spring Boot plugin: 1. Configures `protoc` to use the artifact `com.google.protobuf:protoc`, aligning its version with that of Protobuf dependencies on the runtime classpath. Additionally, when the Protobuf `grpc` plugin is configured, the Spring Boot plugin: 1. Configures it to use the artifact `io.grpc:protoc-gen-grpc-java`, aligning its version with that of gRPC dependencies on the runtime classpath. 2. Configures the `grpc` plugin of all generate proto tasks with the option `@generated=omit`. * [Spring Boot](../index.html) * [4.1.1](reacting.html) * [4.0.8](../4.0/gradle-plugin/reacting.html) * [3.5.16](../3.5/gradle-plugin/reacting.html) * [3.4.13](../3.4/gradle-plugin/reacting.html) * [3.3.13](../3.3/gradle-plugin/reacting.html) - [4.2.0-M2](../4.2/gradle-plugin/reacting.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/gradle-plugin/reacting.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/gradle-plugin/reacting.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/gradle-plugin/reacting.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/packaging/container-images/dockerfiles.html ---- # Dockerfiles While it is possible to convert a Spring Boot uber jar into a Docker image with just a few lines in the `Dockerfile`, using the [layering feature](efficient-images.html#packaging.container-images.efficient-images.layering) will result in an optimized image. When you create a jar containing the layers index file, the `spring-boot-jarmode-tools` jar will be added as a dependency to your jar. With this jar on the classpath, you can launch your application in a special mode which allows the bootstrap code to run something entirely different from your application, for example, something that extracts the layers. Here’s how you can launch your jar with a `tools` jar mode: ```shell $ java -Djarmode=tools -jar my-app.jar ``` This will provide the following output: ``` Usage: java -Djarmode=tools -jar my-app.jar Available commands: extract Extract the contents from the jar list-layers List layers from the jar that can be extracted help Help about any command ``` The `extract` command can be used to easily split the application into layers to be added to the `Dockerfile`. Here is an example of a `Dockerfile` using `jarmode`. ```dockerfile # Perform the extraction in a separate builder container FROM bellsoft/liberica-openjre-debian:25-cds AS builder WORKDIR /builder # This points to the built jar file in the target folder # Adjust this to 'build/libs/*.jar' if you're using Gradle ARG JAR_FILE=target/*.jar # Copy the jar file to the working directory and rename it to application.jar COPY ${JAR_FILE} application.jar # Extract the jar file using an efficient layout RUN java -Djarmode=tools -jar application.jar extract --layers --destination extracted # This is the runtime container FROM bellsoft/liberica-openjre-debian:25-cds WORKDIR /application # Copy the extracted jar contents from the builder container into the working directory in the runtime container # Every copy step creates a new docker layer # This allows docker to only pull the changes it really needs COPY --from=builder /builder/extracted/dependencies/ ./ COPY --from=builder /builder/extracted/spring-boot-loader/ ./ COPY --from=builder /builder/extracted/snapshot-dependencies/ ./ COPY --from=builder /builder/extracted/application/ ./ # Start the application jar - this is not the uber jar used by the builder # This jar only contains application code and references to the extracted jar files # This layout is efficient to start up and AOT cache (and CDS) friendly ENTRYPOINT ["java", "-jar", "application.jar"] ``` Assuming the above `Dockerfile` is in the current directory, your Docker image can be built with `docker build .`, or optionally specifying the path to your application jar, as shown in the following example: ```shell $ docker build --build-arg JAR_FILE=path/to/myapp.jar . ``` This is a multi-stage `Dockerfile`. The builder stage extracts the directories that are needed later. Each of the `COPY` commands relates to the layers extracted by the jarmode. Of course, a `Dockerfile` can be written without using the `jarmode`. You can use some combination of `unzip` and `mv` to move things to the right layer but `jarmode` simplifies that. Additionally, the layout created by the `jarmode` is AOT cache (and CDS) friendly out of the box. ## [](#packaging.container-images.dockerfiles.aot-cache)AOT cache If you are using Java 25 or above, and want to additionally enable the [AOT cache](../aot-cache.html#packaging.aot-cache.aot-cache), you can use this `Dockerfile`: ```dockerfile # Perform the extraction in a separate builder container FROM bellsoft/liberica-openjre-debian:25-cds AS builder WORKDIR /builder # This points to the built jar file in the target folder # Adjust this to 'build/libs/*.jar' if you're using Gradle ARG JAR_FILE=target/*.jar # Copy the jar file to the working directory and rename it to application.jar COPY ${JAR_FILE} application.jar # Extract the jar file using an efficient layout RUN java -Djarmode=tools -jar application.jar extract --layers --destination extracted # This is the runtime container FROM bellsoft/liberica-openjre-debian:25-cds WORKDIR /application # Copy the extracted jar contents from the builder container into the working directory in the runtime container # Every copy step creates a new docker layer # This allows docker to only pull the changes it really needs COPY --from=builder /builder/extracted/dependencies/ ./ COPY --from=builder /builder/extracted/spring-boot-loader/ ./ COPY --from=builder /builder/extracted/snapshot-dependencies/ ./ COPY --from=builder /builder/extracted/application/ ./ # Execute the AOT cache training run RUN java -XX:AOTCacheOutput=app.aot -Dspring.context.exit=onRefresh -jar application.jar # Start the application jar with AOT cache enabled - this is not the uber jar used by the builder # This jar only contains application code and references to the extracted jar files # This layout is efficient to start up and AOT cache friendly ENTRYPOINT ["java", "-XX:AOTCache=app.aot", "-jar", "application.jar"] ``` This is mostly the same as the above `Dockerfile`. As the last steps, it creates the AOT cache file by doing a training run and passes the AOT cache parameter to `java -jar`. ## [](#packaging.container-images.dockerfiles.cds)CDS | | | | -- | ---------------------------------------------------------------------- | | ** | If you’re using Java 24 or later, please use AOT cache instead of CDS. | If you want to additionally enable [CDS](../aot-cache.html#packaging.aot-cache.cds), you can use this `Dockerfile`: ```dockerfile # Perform the extraction in a separate builder container FROM bellsoft/liberica-openjre-debian:25-cds AS builder WORKDIR /builder # This points to the built jar file in the target folder # Adjust this to 'build/libs/*.jar' if you're using Gradle ARG JAR_FILE=target/*.jar # Copy the jar file to the working directory and rename it to application.jar COPY ${JAR_FILE} application.jar # Extract the jar file using an efficient layout RUN java -Djarmode=tools -jar application.jar extract --layers --destination extracted # This is the runtime container FROM bellsoft/liberica-openjre-debian:25-cds WORKDIR /application # Copy the extracted jar contents from the builder container into the working directory in the runtime container # Every copy step creates a new docker layer # This allows docker to only pull the changes it really needs COPY --from=builder /builder/extracted/dependencies/ ./ COPY --from=builder /builder/extracted/spring-boot-loader/ ./ COPY --from=builder /builder/extracted/snapshot-dependencies/ ./ COPY --from=builder /builder/extracted/application/ ./ # Execute the CDS training run RUN java -XX:ArchiveClassesAtExit=application.jsa -Dspring.context.exit=onRefresh -jar application.jar # Start the application jar with CDS enabled - this is not the uber jar used by the builder # This jar only contains application code and references to the extracted jar files # This layout is efficient to start up and CDS friendly ENTRYPOINT ["java", "-XX:SharedArchiveFile=application.jsa", "-jar", "application.jar"] ``` This is mostly the same as the above `Dockerfile`. As the last steps, it creates the CDS archive by doing a training run and passes the CDS parameter to `java -jar`. | | | | -- | ---------------------------------------------------------------------------------- | | ** | If you are using Java 25 or above, we recommend using an AOT cache instead of CDS. | * [Spring Boot](../../../index.html) * [4.1.1](dockerfiles.html) * [4.0.8](../../../4.0/reference/packaging/container-images/dockerfiles.html) * [3.5.16](../../../3.5/reference/packaging/container-images/dockerfiles.html) * [3.4.13](../../../3.4/reference/packaging/container-images/dockerfiles.html) * [3.3.13](../../../3.3/reference/packaging/container-images/dockerfiles.html) - [4.2.0-M2](../../../4.2/reference/packaging/container-images/dockerfiles.html) * [4.2.0-SNAPSHOT](../../../4.2-SNAPSHOT/reference/packaging/container-images/dockerfiles.html) * [4.1.3-SNAPSHOT](../../../4.1-SNAPSHOT/reference/packaging/container-images/dockerfiles.html) * [4.0.10-SNAPSHOT](../../../4.0-SNAPSHOT/reference/packaging/container-images/dockerfiles.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/BootArchive.html ---- # Interface BootArchive * All Superinterfaces: `Comparable, ExtensionAware, Named, Task` - All Known Implementing Classes: `BootJar, BootWar` *** public interface BootArchive extends [Task](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") A Spring Boot "fat" archive task. * Since: 2.0.0 * Author: Andy Wilkinson, Moritz Halbritter - ## Nested Class Summary ### Nested classes/interfaces inherited from interface [Named](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Named.html#nested-class-summary "class or interface in org.gradle.api") `Named.Namer` - ## Field Summary ### Fields inherited from interface [Task](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html#field-summary "class or interface in org.gradle.api") `TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE` - ## Method Summary Modifier and Type Method Description `void` `classpath(Object... classpath)` Adds files to the classpath to include in the archive. `@Nullable FileCollection` `getClasspath()` Returns the classpath that will be included in the archive. `Property` `getIncludeTools()` Returns whether the JAR tools should be included as a dependency in the layered archive. `Property` `getMainClass()` Returns the fully-qualified name of the application's main class. `Property` `getTargetJavaVersion()` Returns the target Java version of the project (e.g. `void` `requiresUnpack(String... patterns)` Adds Ant-style patterns that identify files that must be unpacked from the archive when it is launched. `void` `requiresUnpack(Spec spec)` Adds a spec that identifies files that must be unpacked from the archive when it is launched. `void` `resolvedArtifacts(Provider> resolvedArtifacts)` Registers the given lazily provided `resolvedArtifacts`. `void` `setClasspath(Object classpath)` Sets the classpath to include in the archive. `void` `setClasspath(FileCollection classpath)` Sets the classpath to include in the archive. ### Methods inherited from interface [Comparable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html#method-summary "class or interface in java.lang") `compareTo` ### Methods inherited from interface [ExtensionAware](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/plugins/ExtensionAware.html#method-summary "class or interface in org.gradle.api.plugins") `getExtensions` ### Methods inherited from interface [Task](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html#method-summary "class or interface in org.gradle.api") `configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, doNotTrackState, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, notCompatibleWithConfigurationCache, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService` * ## Method Details * ### getMainClass [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getMainClass() Returns the fully-qualified name of the application's main class. * Returns: the fully-qualified name of the application's main class * Since: 2.4.0 * ### requiresUnpack void requiresUnpack​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")... patterns) Adds Ant-style patterns that identify files that must be unpacked from the archive when it is launched. * Parameters: `patterns` - the patterns * ### requiresUnpack void requiresUnpack​([Spec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/specs/Spec.html "class or interface in org.gradle.api.specs")<[FileTreeElement](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileTreeElement.html "class or interface in org.gradle.api.file")> spec) Adds a spec that identifies files that must be unpacked from the archive when it is launched. * Parameters: `spec` - the spec * ### getClasspath [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") [@Classpath](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Classpath.html "class or interface in org.gradle.api.tasks") @Nullable [FileCollection](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCollection.html "class or interface in org.gradle.api.file") getClasspath() Returns the classpath that will be included in the archive. * Returns: the classpath * ### classpath void classpath​([Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang")... classpath) Adds files to the classpath to include in the archive. The given `classpath` is evaluated as per [`Project.files(Object...)`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Project.html#files\(java.lang.Object...\) "class or interface in org.gradle.api"). * Parameters: `classpath` - the additions to the classpath * ### setClasspath void setClasspath​([Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") classpath) Sets the classpath to include in the archive. The given `classpath` is evaluated as per [`Project.files(Object...)`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Project.html#files\(java.lang.Object...\) "class or interface in org.gradle.api"). * Parameters: `classpath` - the classpath * Since: 2.0.7 * ### setClasspath void setClasspath​([FileCollection](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCollection.html "class or interface in org.gradle.api.file") classpath) Sets the classpath to include in the archive. * Parameters: `classpath` - the classpath * Since: 2.0.7 * ### getTargetJavaVersion [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[JavaVersion](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/JavaVersion.html "class or interface in org.gradle.api")> getTargetJavaVersion() Returns the target Java version of the project (e.g. as provided by the `targetCompatibility` build property). * Returns: the target Java version * ### resolvedArtifacts void resolvedArtifacts​([Provider](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Provider.html "class or interface in org.gradle.api.provider")<[Set](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html "class or interface in java.util")<[ResolvedArtifactResult](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/artifacts/result/ResolvedArtifactResult.html "class or interface in org.gradle.api.artifacts.result")>> resolvedArtifacts) Registers the given lazily provided `resolvedArtifacts`. They are used to map from the files in the [`classpath`](#getClasspath\(\)) to their dependency coordinates. * Parameters: `resolvedArtifacts` - the lazily provided resolved artifacts * Since: 3.0.7 * ### getIncludeTools [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[Boolean](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html "class or interface in java.lang")> getIncludeTools() Returns whether the JAR tools should be included as a dependency in the layered archive. * Returns: whether the JAR tools should be included * Since: 3.3.0 ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/ArtifactsLibraries.html ---- # Class ArtifactsLibraries [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.maven.ArtifactsLibraries * All Implemented Interfaces: `org.springframework.boot.loader.tools.Libraries` *** public class ArtifactsLibraries extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") implements org.springframework.boot.loader.tools.Libraries `Libraries` backed by Maven `Artifact`s. * Since: 1.0.0 * Author: Phillip Webb, Andy Wilkinson, Stephane Nicoll, Scott Frederick - ## Field Summary ### Fields inherited from interface org.springframework.boot.loader.tools.Libraries `NONE` - ## Constructor Summary Constructors Constructor Description `ArtifactsLibraries(Set artifacts, Collection localProjects, @Nullable Collection unpacks, org.apache.maven.plugin.logging.Log log)` Creates a new `ArtifactsLibraries` from the given `artifacts`. `ArtifactsLibraries(Set artifacts, Set includedArtifacts, Collection localProjects, @Nullable Collection unpacks, org.apache.maven.plugin.logging.Log log)` Creates a new `ArtifactsLibraries` from the given `artifacts`. - ## Method Summary Modifier and Type Method Description `void` `doWithLibraries(org.springframework.boot.loader.tools.LibraryCallback callback)`   ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### ArtifactsLibraries public ArtifactsLibraries​([Set](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html "class or interface in java.util")\ artifacts, [Collection](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html "class or interface in java.util")\ localProjects, @Nullable [Collection](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html "class or interface in java.util")\ unpacks, org.apache.maven.plugin.logging.Log log) Creates a new `ArtifactsLibraries` from the given `artifacts`. * Parameters: * `artifacts` - the artifacts to represent as libraries * `localProjects` - projects for which `local` libraries should be created * `unpacks` - artifacts that should be unpacked on launch * `log` - the log * Since: 2.4.0 * ### ArtifactsLibraries public ArtifactsLibraries​([Set](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html "class or interface in java.util")\ artifacts, [Set](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html "class or interface in java.util")\ includedArtifacts, [Collection](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html "class or interface in java.util")\ localProjects, @Nullable [Collection](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html "class or interface in java.util")\ unpacks, org.apache.maven.plugin.logging.Log log) Creates a new `ArtifactsLibraries` from the given `artifacts`. * Parameters: * `artifacts` - all artifacts that can be represented as libraries * `includedArtifacts` - the actual artifacts to include in the uber jar * `localProjects` - projects for which `local` libraries should be created * `unpacks` - artifacts that should be unpacked on launch * `log` - the log * Since: 2.4.8 * ## Method Details * ### doWithLibraries public void doWithLibraries​(org.springframework.boot.loader.tools.LibraryCallback callback) throws [IOException](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html "class or interface in java.io") * Specified by: `doWithLibraries` in interface `org.springframework.boot.loader.tools.Libraries` * Throws: `IOException` ---- url: https://docs.spring.io/spring-boot/how-to/nosql.html ---- # NoSQL Spring Boot offers a number of starters that support NoSQL technologies. This section answers questions that arise from using NoSQL with Spring Boot. ## [](#howto.nosql.jedis-instead-of-lettuce)Use Jedis Instead of Lettuce By default, the Spring Boot starter (`spring-boot-starter-data-redis`) uses [Lettuce](https://github.com/redis/lettuce/). You need to exclude that dependency and include the [Jedis](https://github.com/redis/jedis/) one instead. Spring Boot manages both of these dependencies, allowing you to switch to Jedis without specifying a version. The following example shows how to accomplish this in Maven: ```xml org.springframework.boot spring-boot-starter-data-redis io.lettuce lettuce-core redis.clients jedis ``` The following example shows how to accomplish this in Gradle: ```gradle dependencies { implementation('org.springframework.boot:spring-boot-starter-data-redis') { exclude group: 'io.lettuce', module: 'lettuce-core' } implementation 'redis.clients:jedis' // ... } ``` * [Spring Boot](../index.html) * [4.1.1](nosql.html) * [4.0.8](../4.0/how-to/nosql.html) * [3.5.16](../3.5/how-to/nosql.html) * [3.4.13](../3.4/how-to/nosql.html) * [3.3.13](../3.3/how-to/nosql.html) - [4.2.0-M2](../4.2/how-to/nosql.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/nosql.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/nosql.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/nosql.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/web/spring-hateoas.html ---- # Spring HATEOAS If you develop a RESTful API that makes use of hypermedia, Spring Boot provides auto-configuration for Spring HATEOAS that works well with most applications. The auto-configuration replaces the need to use [`@EnableHypermediaSupport`](https://docs.spring.io/spring-hateoas/docs/3.1.x/api/org/springframework/hateoas/config/EnableHypermediaSupport.html) and registers a number of beans to ease building hypermedia-based applications, including a [`LinkDiscoverers`](https://docs.spring.io/spring-hateoas/docs/3.1.x/api/org/springframework/hateoas/client/LinkDiscoverers.html) (for client side support) and an [`JsonMapper`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.html) configured to correctly marshal responses into the desired representation. The [`JsonMapper`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.html) is customized by setting the various `spring.jackson.*` properties or, if any exist, the [`JsonMapperBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson/autoconfigure/JsonMapperBuilderCustomizer.html) beans. You can take control of Spring HATEOAS’s configuration by using [`@EnableHypermediaSupport`](https://docs.spring.io/spring-hateoas/docs/3.1.x/api/org/springframework/hateoas/config/EnableHypermediaSupport.html). Note that doing so disables the [`JsonMapper`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.html) customization described earlier. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | `spring-boot-starter-hateoas` is specific to Spring MVC and should not be combined with Spring WebFlux. In order to use Spring HATEOAS with Spring WebFlux, you can add a direct dependency on `org.springframework.hateoas:spring-hateoas` along with `spring-boot-starter-webflux`. | By default, requests that accept `application/json` will receive an `application/hal+json` response. To disable this behavior set `spring.hateoas.use-hal-as-default-json-media-type` to `false` and define a [`HypermediaMappingInformation`](https://docs.spring.io/spring-hateoas/docs/3.1.x/api/org/springframework/hateoas/config/HypermediaMappingInformation.html) or [`HalConfiguration`](https://docs.spring.io/spring-hateoas/docs/3.1.x/api/org/springframework/hateoas/mediatype/hal/HalConfiguration.html) to configure Spring HATEOAS to meet the needs of your application and its clients. * [Spring Boot](../../index.html) * [4.1.1](spring-hateoas.html) * [4.0.8](../../4.0/reference/web/spring-hateoas.html) * [3.5.16](../../3.5/reference/web/spring-hateoas.html) * [3.4.13](../../3.4/reference/web/spring-hateoas.html) * [3.3.13](../../3.3/reference/web/spring-hateoas.html) - [4.2.0-M2](../../4.2/reference/web/spring-hateoas.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/web/spring-hateoas.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/web/spring-hateoas.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/web/spring-hateoas.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/how-to/http-clients.html ---- # HTTP Clients Spring Boot offers a number of starters that work with HTTP clients. This section answers questions related to using them. ## [](#howto.http-clients.rest-template-proxy-configuration)Configure RestTemplate to Use a Proxy As described in [RestTemplate Customization](../reference/io/rest-client.html#io.rest-client.resttemplate.customization), you can use a [`RestTemplateCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateCustomizer.html) with [`RestTemplateBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateBuilder.html) to build a customized [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html). This is the recommended approach for creating a [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html) configured to use a proxy. The exact details of the proxy configuration depend on the underlying client request factory that is being used. ## [](#howto.http-clients.webclient-reactor-netty-customization)Configure the TcpClient used by a Reactor Netty-based WebClient When Reactor Netty is on the classpath a Reactor Netty-based [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html) is auto-configured. To customize the client’s handling of network connections, provide a [`ClientHttpConnector`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/client/reactive/ClientHttpConnector.html) bean. The following example configures a 60 second connect timeout and adds a [`ReadTimeoutHandler`](https://netty.io/4.2/api/io/netty/handler/timeout/ReadTimeoutHandler.html): * Java * Kotlin ```java import io.netty.channel.ChannelOption; import io.netty.handler.timeout.ReadTimeoutHandler; import reactor.netty.http.client.HttpClient; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.http.client.ReactorResourceFactory; import org.springframework.http.client.reactive.ClientHttpConnector; import org.springframework.http.client.reactive.ReactorClientHttpConnector; @Configuration(proxyBeanMethods = false) public class MyReactorNettyClientConfiguration { @Bean ClientHttpConnector clientHttpConnector(ReactorResourceFactory resourceFactory) { HttpClient httpClient = HttpClient.create(resourceFactory.getConnectionProvider()) .runOn(resourceFactory.getLoopResources()) .option(ChannelOption.CONNECT_TIMEOUT_MILLIS, 60000) .doOnConnected((connection) -> connection.addHandlerLast(new ReadTimeoutHandler(60))); return new ReactorClientHttpConnector(httpClient); } } ``` ```kotlin import io.netty.channel.ChannelOption import io.netty.handler.timeout.ReadTimeoutHandler import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.http.client.reactive.ClientHttpConnector import org.springframework.http.client.reactive.ReactorClientHttpConnector import org.springframework.http.client.ReactorResourceFactory import reactor.netty.http.client.HttpClient @Configuration(proxyBeanMethods = false) class MyReactorNettyClientConfiguration { @Bean fun clientHttpConnector(resourceFactory: ReactorResourceFactory): ClientHttpConnector { val httpClient = HttpClient.create(resourceFactory.connectionProvider) .runOn(resourceFactory.loopResources) .option(ChannelOption.CONNECT_TIMEOUT_MILLIS, 60000) .doOnConnected { connection -> connection.addHandlerLast(ReadTimeoutHandler(60)) } return ReactorClientHttpConnector(httpClient) } } ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Note the use of [`ReactorResourceFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/client/ReactorResourceFactory.html) for the connection provider and event loop resources. This ensures efficient sharing of resources for the server receiving requests and the client making requests. | * [Spring Boot](../index.html) * [4.1.1](http-clients.html) * [4.0.8](../4.0/how-to/http-clients.html) * [3.5.16](../3.5/how-to/http-clients.html) * [3.4.13](../3.4/how-to/http-clients.html) * [3.3.13](../3.3/how-to/http-clients.html) - [4.2.0-M2](../4.2/how-to/http-clients.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/http-clients.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/http-clients.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/http-clients.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/CacheInfo.BindCacheInfo.html ---- Uses of Class\ org.springframework.boot.maven.CacheInfo.BindCacheInfo ====================================================== * ## Uses of [CacheInfo.BindCacheInfo](../CacheInfo.BindCacheInfo.html "class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Methods in [org.springframework.boot.maven](../package-summary.html) with parameters of type [CacheInfo.BindCacheInfo](../CacheInfo.BindCacheInfo.html "class in org.springframework.boot.maven") Modifier and Type Method Description `void` CacheInfo.`setBind(CacheInfo.BindCacheInfo info)` ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/Include.html ---- Uses of Class\ org.springframework.boot.maven.Include ====================================== * ## Uses of [Include](../Include.html "class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Method parameters in [org.springframework.boot.maven](../package-summary.html) with type arguments of type [Include](../Include.html "class in org.springframework.boot.maven") Modifier and Type Method Description `protected void` AbstractDependencyFilterMojo.`setIncludes(@Nullable List includes)`   Constructor parameters in [org.springframework.boot.maven](../package-summary.html) with type arguments of type [Include](../Include.html "class in org.springframework.boot.maven") Modifier Constructor Description ` ` `IncludeFilter(List includes)` ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/BuildImageNoForkMojo.html ---- Uses of Class\ org.springframework.boot.maven.BuildImageNoForkMojo =================================================== No usage of org.springframework.boot.maven.BuildImageNoForkMojo ---- url: https://docs.spring.io/spring-boot/reference/features/kotlin.html ---- # Kotlin Support [Kotlin](https://kotlinlang.org) is a statically-typed language targeting the JVM (and other platforms) which allows writing concise and elegant code while providing [interoperability](https://kotlinlang.org/docs/reference/java-interop.html) with existing libraries written in Java. Spring Boot provides Kotlin support by leveraging the support in other Spring projects such as Spring Framework, Spring Data, and Reactor. See the [Spring Framework Kotlin support documentation](https://docs.spring.io/spring-framework/reference/7.0/languages/kotlin.html) for more information. The easiest way to start with Spring Boot and Kotlin is to follow [this comprehensive tutorial](https://spring.io/guides/tutorials/spring-boot-kotlin/). You can create new Kotlin projects by using [start.spring.io](https://start.spring.io/#!language=kotlin). Feel free to join the #spring channel of [Kotlin Slack](https://slack.kotlinlang.org/) or ask a question with the `spring` and `kotlin` tags on [Stack Overflow](https://stackoverflow.com/questions/tagged/spring+kotlin) if you need support. ## [](#features.kotlin.requirements)Requirements Spring Boot requires at least Kotlin 2.2.x and manages a suitable Kotlin version through dependency management. To use Kotlin, `org.jetbrains.kotlin:kotlin-stdlib` and `org.jetbrains.kotlin:kotlin-reflect` must be present on the classpath. Kotlin 2.2.x introduces [new defaulting rules for propagating annotations to parameters, fields, and properties](https://kotlinlang.org/docs/whatsnew22.html#new-defaulting-rules-for-use-site-annotation-targets). In order to avoid related warnings and use what will likely become the Kotlin default behavior in an upcoming version, it is recommended to configure the `-Xannotation-default-target=param-property` compiler flag. Since [Kotlin classes are final by default](https://discuss.kotlinlang.org/t/classes-final-by-default/166), you are likely to want to configure [kotlin-spring](https://kotlinlang.org/docs/reference/compiler-plugins.html#spring-support) plugin in order to automatically open Spring-annotated classes so that they can be proxied. [Jackson’s Kotlin module](https://github.com/FasterXML/jackson-module-kotlin) is required for serializing / deserializing JSON data in Kotlin. It is automatically registered when found on the classpath. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | These dependencies and plugins are provided by default if one bootstraps a Kotlin project on [start.spring.io](https://start.spring.io/#!language=kotlin). | ## [](#features.kotlin.null-safety)Null-safety One of Kotlin’s key features is [null-safety](https://kotlinlang.org/docs/reference/null-safety.html). It deals with `null` values at compile time rather than deferring the problem to runtime and encountering a [`NullPointerException`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html). This helps to eliminate a common source of bugs without paying the cost of wrappers like [`Optional`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html). Kotlin also allows using functional constructs with nullable values as described in this [comprehensive guide to null-safety in Kotlin](https://www.baeldung.com/kotlin-null-safety). Although Java does not let you express null-safety in its type-system, most Spring projects provide [null-safety](https://docs.spring.io/spring-framework/reference/7.0/core/null-safety.html) via [JSpecify](https://jspecify.dev/) annotations. As of Kotlin 2.1, Kotlin enforces strict handling of nullability annotations from the `org.jspecify.annotations` package. ## [](#features.kotlin.api)Kotlin API ### [](#features.kotlin.api.run-application)runApplication Spring Boot provides an idiomatic way to run an application with `runApplication(*args)` as shown in the following example: ```kotlin import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.runApplication @SpringBootApplication class MyApplication fun main(args: Array) { runApplication(*args) } ``` This is a drop-in replacement for `SpringApplication.run(MyApplication::class.java, *args)`. It also allows customization of the application as shown in the following example: ```kotlin runApplication(*args) { setBannerMode(OFF) } ``` ### [](#features.kotlin.api.extensions)Extensions Kotlin [extensions](https://kotlinlang.org/docs/reference/extensions.html) provide the ability to extend existing classes with additional functionality. The Spring Boot Kotlin API makes use of these extensions to add new Kotlin specific conveniences to existing APIs. [`TestRestTemplate`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/resttestclient/TestRestTemplate.html) extensions, similar to those provided by Spring Framework for [`RestOperations`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestOperations.html) in Spring Framework, are provided. Among other things, the extensions make it possible to take advantage of Kotlin reified type parameters. ## [](#features.kotlin.dependency-management)Dependency Management In order to avoid mixing different versions of Kotlin dependencies on the classpath, Spring Boot imports the Kotlin BOM. With Maven, the Kotlin version can be customized by setting the `kotlin.version` property and plugin management is provided for `kotlin-maven-plugin`. With Gradle, the Spring Boot plugin automatically aligns the `kotlin.version` with the version of the Kotlin plugin. Spring Boot also manages the version of Coroutines dependencies by importing the Kotlin Coroutines BOM. The version can be customized by setting the `kotlin-coroutines.version` property. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | `org.jetbrains.kotlinx:kotlinx-coroutines-reactor` dependency is provided by default if one bootstraps a Kotlin project with at least one reactive dependency on [start.spring.io](https://start.spring.io/#!language=kotlin). | ## [](#features.kotlin.configuration-properties)@ConfigurationProperties [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) when used in combination with [constructor binding](external-config.html#features.external-config.typesafe-configuration-properties.constructor-binding) supports data classes with immutable `val` properties as shown in the following example: ```kotlin @ConfigurationProperties("example.kotlin") data class KotlinExampleProperties( val name: String, val description: String, val myService: MyService ) { data class MyService( val apiToken: String, val uri: URI ) } ``` Due to the limitations of their interoperability with Java, support for value classes is limited. In particular, relying upon a value class’s default value will not work with configuration property binding. In such cases, a data class should be used instead. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | To generate [your own metadata](../../specification/configuration-metadata/annotation-processor.html) using the annotation processor, [`kapt` should be configured](https://kotlinlang.org/docs/reference/kapt.html) with the `spring-boot-configuration-processor` dependency. Note that some features (such as detecting the default value or deprecated items) are not working due to limitations in the model kapt provides. | ## [](#features.kotlin.testing)Testing While it is possible to use JUnit 4 to test Kotlin code, JUnit 6 is provided by default and is recommended. JUnit 6 enables a test class to be instantiated once and reused for all of the class’s tests. This makes it possible to use [`@BeforeAll`](https://junit.org/junit5/docs/6.0.3/api/org.junit.jupiter.api/org/junit/jupiter/api/BeforeAll.html) and [`@AfterAll`](https://junit.org/junit5/docs/6.0.3/api/org.junit.jupiter.api/org/junit/jupiter/api/AfterAll.html) annotations on non-static methods, which is a good fit for Kotlin. To mock Kotlin classes, [MockK](https://mockk.io/) is recommended. If you need the `MockK` equivalent of the Mockito specific [`@MockitoBean` and ](../testing/spring-boot-applications.html#testing.spring-boot-applications.mocking-beans)[`@MockitoSpyBean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/context/bean/override/mockito/MockitoSpyBean.html) annotations, you can use [SpringMockK](https://github.com/Ninja-Squad/springmockk) which provides similar `@MockkBean` and `@SpykBean` annotations. ## [](#features.kotlin.resources)Resources ### [](#features.kotlin.resources.further-reading)Further Reading * [Kotlin language reference](https://kotlinlang.org/docs/reference) * [Kotlin Slack](https://kotlinlang.slack.com/) (with a dedicated #spring channel) * [Stack Overflow with `spring` and `kotlin` tags](https://stackoverflow.com/questions/tagged/spring+kotlin) * [Try Kotlin in your browser](https://try.kotlinlang.org/) * [Kotlin blog](https://blog.jetbrains.com/kotlin/) * [Awesome Kotlin](https://kotlin.link/) * [Tutorial: building web applications with Spring Boot and Kotlin](https://spring.io/guides/tutorials/spring-boot-kotlin/) * [Developing Spring Boot applications with Kotlin](https://spring.io/blog/2016/02/15/developing-spring-boot-applications-with-kotlin) * [A Geospatial Messenger with Kotlin, Spring Boot and PostgreSQL](https://spring.io/blog/2016/03/20/a-geospatial-messenger-with-kotlin-spring-boot-and-postgresql) * [Introducing Kotlin support in Spring Framework 5.0](https://spring.io/blog/2017/01/04/introducing-kotlin-support-in-spring-framework-5-0) * [Spring Framework 5 Kotlin APIs, the functional way](https://spring.io/blog/2017/08/01/spring-framework-5-kotlin-apis-the-functional-way) ### [](#features.kotlin.resources.examples)Examples * [spring-boot-kotlin-demo](https://github.com/sdeleuze/spring-boot-kotlin-demo): regular Spring Boot + Spring Data JPA project * [mixit](https://github.com/mixitconf/mixit): Spring Boot 2 + WebFlux + Reactive Spring Data MongoDB * [spring-kotlin-fullstack](https://github.com/sdeleuze/spring-kotlin-fullstack): WebFlux Kotlin fullstack example with Kotlin2js for frontend instead of JavaScript or TypeScript * [spring-petclinic-kotlin](https://github.com/spring-petclinic/spring-petclinic-kotlin): Kotlin version of the Spring PetClinic Sample Application * [spring-kotlin-deepdive](https://github.com/sdeleuze/spring-kotlin-deepdive): a step by step migration for Boot 1.0 + Java to Boot 2.0 + Kotlin * [spring-boot-coroutines-demo](https://github.com/sdeleuze/spring-boot-coroutines-demo): Coroutines sample project - [Spring Boot](../../index.html) * [4.1.1](kotlin.html) * [4.0.8](../../4.0/reference/features/kotlin.html) * [3.5.16](../../3.5/reference/features/kotlin.html) * [3.4.13](../../3.4/reference/features/kotlin.html) * [3.3.13](../../3.3/reference/features/kotlin.html) - [4.2.0-M2](../../4.2/reference/features/kotlin.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/features/kotlin.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/features/kotlin.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/features/kotlin.html) * Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/packaging.html ---- # Packaging Executable Archives The plugin can create executable archives (jar files and war files) that contain all of an application’s dependencies and can then be run with `java -jar`. Packaging an executable archive is performed by the `repackage` goal, as shown in the following example: ```xml org.springframework.boot spring-boot-maven-plugin repackage ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The `repackage` goal is not meant to be used alone on the command-line as it operates on the source `jar` (or `war`) produced by the `package` phase. To use this goal on the command-line, you must include the `package` phase: `mvn package spring-boot:repackage`. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you are using `spring-boot-starter-parent`, such execution is already pre-configured with a `repackage` execution ID so that only the plugin definition should be added. | The example above repackages a `jar` or `war` archive that is built during the package phase of the Maven lifecycle, including any `provided` dependencies that are defined in the project. If some of these dependencies need to be excluded, you can use one of the `exclude` options; see the [dependency exclusion](#packaging.examples.exclude-dependency) for more details. The original (that is non-executable) artifact is renamed to `.original` by default but it is also possible to keep the original artifact using a custom classifier. | | | | -- | ----------------------------------------------------------------------------------------- | | ** | The `outputFileNameMapping` feature of the `maven-war-plugin` is currently not supported. | The `spring-boot-devtools` and `spring-boot-docker-compose` modules are automatically excluded by default (you can control this using the `excludeDevtools` and `excludeDockerCompose` properties). In order to make that work with `war` packaging, the `spring-boot-devtools` and `spring-boot-docker-compose` dependencies must be set as `optional` or with the `provided` scope. Pay also attention that optional dependencies are not included by default. If you have defined those modules as optional, you also need to set the `includeOptional` property to `true`. The plugin rewrites your manifest, and in particular it manages the `Main-Class` and `Start-Class` entries. If the defaults don’t work you have to configure the values in the Spring Boot plugin, not in the jar plugin. The `Main-Class` in the manifest is controlled by the `layout` property of the Spring Boot plugin, as shown in the following example: ```xml org.springframework.boot spring-boot-maven-plugin ${start.class} ZIP repackage ``` The `layout` property defaults to a value determined by the archive type (`jar` or `war`). The following layouts are available: * `JAR`: regular executable JAR layout. * `WAR`: executable WAR layout. `provided` dependencies are placed in `WEB-INF/lib-provided` to avoid any clash when the `war` is deployed in a servlet container. * `ZIP` (alias to `DIR`): similar to the `JAR` layout using `PropertiesLauncher`. * `NONE`: Bundle all dependencies and project resources. Does not bundle a bootstrap loader. ## [](#packaging.layers)Layered Jar or War A repackaged jar contains the application’s classes and dependencies in `BOOT-INF/classes` and `BOOT-INF/lib` respectively. Similarly, an executable war contains the application’s classes in `WEB-INF/classes` and dependencies in `WEB-INF/lib` and `WEB-INF/lib-provided`. For cases where a docker image needs to be built from the contents of a jar or war, it’s useful to be able to separate these directories further so that they can be written into distinct layers. Layered archives use the same layout as a regular repackaged jar or war, but include an additional meta-data file that describes each layer. By default, the following layers are defined: * `dependencies` for any dependency whose version does not contain `SNAPSHOT`. * `spring-boot-loader` for the loader classes. * `snapshot-dependencies` for any dependency whose version contains `SNAPSHOT`. * `application` for local module dependencies, application classes, and resources. Module dependencies are identified by looking at all of the modules that are part of the current build. If a module dependency can only be resolved because it has been installed into Maven’s local cache and it is not part of the current build, it will be identified as regular dependency. The layers order is important as it determines how likely previous layers can be cached when part of the application changes. The default order is `dependencies`, `spring-boot-loader`, `snapshot-dependencies`, `application`. Content that is least likely to change should be added first, followed by layers that are more likely to change. The repackaged archive includes the `layers.idx` file by default. To disable this feature, you can do so in the following manner: ```xml org.springframework.boot spring-boot-maven-plugin false ``` ### [](#packaging.layers.configuration)Custom Layers Configuration Depending on your application, you may want to tune how layers are created and add new ones. This can be done using a configuration loaded from a file or from the classpath. To use a configuration file, register it as shown below: ```xml org.springframework.boot spring-boot-maven-plugin true ${project.basedir}/src/layers.xml ``` Alternatively, the configuration can be loaded from the classpath by specifying its name. A matching file is expected at `META-INF/spring/layers/.xml` on the plugin’s classpath. The jar that contains the configuration can be added as a plugin dependency, as shown below: ```xml org.springframework.boot spring-boot-maven-plugin true custom com.example layers-configuration 1.0.0 ``` In the example above, `META-INF/spring/layers/custom.xml` is expected to be available on the plugin’s classpath. The configuration file describes how an archive can be separated into layers, and the order of those layers. The following example shows how the default ordering described above can be defined explicitly: ```xml org/springframework/boot/loader/** *:*:*SNAPSHOT dependencies spring-boot-loader snapshot-dependencies application ``` The `layers` XML format is defined in three sections: * The `` block defines how the application classes and resources should be layered. * The `` block defines how dependencies should be layered. * The `` block defines the order that the layers should be written. Nested `` blocks are used within `` and `` sections to claim content for a layer. The blocks are evaluated in the order that they are defined, from top to bottom. Any content not claimed by an earlier block remains available for subsequent blocks to consider. The `` block claims content using nested `` and `` elements. The `` section uses Ant-style path matching for include/exclude expressions. The `` section uses `group:artifact[:version]` patterns. It also provides `` and `` elements that can be used to include or exclude local module dependencies. If no `` is defined, then all content (not claimed by an earlier block) is considered. If no `` is defined, then no exclusions are applied. Looking at the `` example above, we can see that the first `` will claim all module dependencies for the `application.layer`. The next `` will claim all SNAPSHOT dependencies for the `snapshot-dependencies` layer. The final `` will claim anything left (in this case, any dependency that is not a SNAPSHOT) for the `dependencies` layer. The `` block has similar rules. First claiming `org/springframework/boot/loader/**` content for the `spring-boot-loader` layer. Then claiming any remaining classes and resources for the `application` layer. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The order that `` blocks are defined is often different from the order that the layers are written. For this reason the `` element must always be included and *must* cover all layers referenced by the `` blocks. | ## [](#packaging.repackage-goal)`spring-boot:repackage` `org.springframework.boot:spring-boot-maven-plugin:4.1.1` Repackage existing JAR and WAR archives so that they can be executed from the command line using `java -jar`. With `layout=NONE` can also be used simply to package a JAR with nested dependencies (and no main class, so not executable). ### [](#packaging.repackage-goal.required-parameters)Required parameters | Name | Type | Default | | ------------------------------------------------------------------------------- | ------ | ---------------------------- | | [outputDirectory](#packaging.repackage-goal.parameter-details.output-directory) | `File` | `${project.build.directory}` | ### [](#packaging.repackage-goal.optional-parameters)Optional parameters | Name | Type | Default | | ------------------------------------------------------------------------------------------ | --------------- | ---------------------------------- | | [attach](#packaging.repackage-goal.parameter-details.attach) | `boolean` | `true` | | [classifier](#packaging.repackage-goal.parameter-details.classifier) | `String` | | | [excludeDevtools](#packaging.repackage-goal.parameter-details.exclude-devtools) | `boolean` | `true` | | [excludeDockerCompose](#packaging.repackage-goal.parameter-details.exclude-docker-compose) | `boolean` | `true` | | [excludeGroupIds](#packaging.repackage-goal.parameter-details.exclude-group-ids) | `String` | | | [excludes](#packaging.repackage-goal.parameter-details.excludes) | `List` | | | [includeOptional](#packaging.repackage-goal.parameter-details.include-optional) | `boolean` | `false` | | [includeSystemScope](#packaging.repackage-goal.parameter-details.include-system-scope) | `boolean` | `false` | | [includeTools](#packaging.repackage-goal.parameter-details.include-tools) | `boolean` | `true` | | [includes](#packaging.repackage-goal.parameter-details.includes) | `List` | | | [layers](#packaging.repackage-goal.parameter-details.layers) | `Layers` | | | [layout](#packaging.repackage-goal.parameter-details.layout) | `LayoutType` | | | [layoutFactory](#packaging.repackage-goal.parameter-details.layout-factory) | `LayoutFactory` | | | [mainClass](#packaging.repackage-goal.parameter-details.main-class) | `String` | | | [outputTimestamp](#packaging.repackage-goal.parameter-details.output-timestamp) | `String` | `${project.build.outputTimestamp}` | | [requiresUnpack](#packaging.repackage-goal.parameter-details.requires-unpack) | `List` | | | [skip](#packaging.repackage-goal.parameter-details.skip) | `boolean` | `false` | ### [](#packaging.repackage-goal.parameter-details)Parameter details #### [](#packaging.repackage-goal.parameter-details.attach)`attach` Attach the repackaged archive to be installed into your local Maven repository or deployed to a remote repository. If no classifier has been configured, it will replace the normal jar. If a `classifier` has been configured such that the normal jar and the repackaged jar are different, it will be attached alongside the normal jar. When the property is set to `false`, the repackaged archive will not be installed or deployed. | Name | `attach` | | ------------- | --------- | | Type | `boolean` | | Default value | `true` | | User property | | | Since | `1.4.0` | #### [](#packaging.repackage-goal.parameter-details.classifier)`classifier` Classifier to add to the repackaged archive. If not given, the main artifact will be replaced by the repackaged archive. If given, the classifier will also be used to determine the source archive to repackage: if an artifact with that classifier already exists, it will be used as source and replaced. If no such artifact exists, the main artifact will be used as source and the repackaged archive will be attached as a supplemental artifact with that classifier. Attaching the artifact allows to deploy it alongside to the original one, see [the Maven documentation for more details](https://maven.apache.org/plugins/maven-deploy-plugin/examples/deploying-with-classifiers.html). | Name | `classifier` | | ------------- | ------------------ | | Type | `java.lang.String` | | Default value | | | User property | | | Since | `1.0.0` | #### [](#packaging.repackage-goal.parameter-details.exclude-devtools)`excludeDevtools` Exclude Spring Boot devtools from the repackaged archive. | Name | `excludeDevtools` | | ------------- | --------------------------------------- | | Type | `boolean` | | Default value | `true` | | User property | `spring-boot.repackage.excludeDevtools` | | Since | `1.3.0` | #### [](#packaging.repackage-goal.parameter-details.exclude-docker-compose)`excludeDockerCompose` Exclude Spring Boot dev services from the repackaged archive. | Name | `excludeDockerCompose` | | ------------- | -------------------------------------------- | | Type | `boolean` | | Default value | `true` | | User property | `spring-boot.repackage.excludeDockerCompose` | | Since | `3.1.0` | #### [](#packaging.repackage-goal.parameter-details.exclude-group-ids)`excludeGroupIds` Comma separated list of groupId names to exclude (exact match). | Name | `excludeGroupIds` | | ------------- | ----------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.excludeGroupIds` | | Since | `1.1.0` | #### [](#packaging.repackage-goal.parameter-details.excludes)`excludes` Collection of artifact definitions to exclude. The `Exclude` element defines mandatory `groupId` and `artifactId` components and an optional `classifier` component. When configured as a property, values should be comma-separated with colon-separated components: `groupId:artifactId,groupId:artifactId:classifier` | Name | `excludes` | | ------------- | ---------------------- | | Type | `java.util.List` | | Default value | | | User property | `spring-boot.excludes` | | Since | `1.1.0` | #### [](#packaging.repackage-goal.parameter-details.include-optional)`includeOptional` Include optional dependencies. | Name | `includeOptional` | | ------------- | ----------------- | | Type | `boolean` | | Default value | `false` | | User property | | | Since | `3.5.7` | #### [](#packaging.repackage-goal.parameter-details.include-system-scope)`includeSystemScope` Include system scoped dependencies. | Name | `includeSystemScope` | | ------------- | -------------------- | | Type | `boolean` | | Default value | `false` | | User property | | | Since | `1.4.0` | #### [](#packaging.repackage-goal.parameter-details.include-tools)`includeTools` Include JAR tools. | Name | `includeTools` | | ------------- | -------------- | | Type | `boolean` | | Default value | `true` | | User property | | | Since | `3.3.0` | #### [](#packaging.repackage-goal.parameter-details.includes)`includes` Collection of artifact definitions to include. The `Include` element defines mandatory `groupId` and `artifactId` components and an optional `classifier` component. When configured as a property, values should be comma-separated with colon-separated components: `groupId:artifactId,groupId:artifactId:classifier` | Name | `includes` | | ------------- | ---------------------- | | Type | `java.util.List` | | Default value | | | User property | `spring-boot.includes` | | Since | `1.2.0` | #### [](#packaging.repackage-goal.parameter-details.layers)`layers` Layer configuration with options to disable layer creation, exclude layer tools jar, and provide a custom layers configuration file. | Name | `layers` | | ------------- | --------------------------------------- | | Type | `org.springframework.boot.maven.Layers` | | Default value | | | User property | | | Since | `2.3.0` | #### [](#packaging.repackage-goal.parameter-details.layout)`layout` The type of archive (which corresponds to how the dependencies are laid out inside it). Possible values are `JAR`, `WAR`, `ZIP`, `DIR`, `NONE`. Defaults to a guess based on the archive type. | Name | `layout` | | ------------- | ---------------------------------------------------------------- | | Type | `org.springframework.boot.maven.AbstractPackagerMojo$LayoutType` | | Default value | | | User property | `spring-boot.repackage.layout` | | Since | `1.0.0` | #### [](#packaging.repackage-goal.parameter-details.layout-factory)`layoutFactory` The layout factory that will be used to create the executable archive if no explicit layout is set. Alternative layouts implementations can be provided by 3rd parties. | Name | `layoutFactory` | | ------------- | ----------------------------------------------------- | | Type | `org.springframework.boot.loader.tools.LayoutFactory` | | Default value | | | User property | | | Since | `1.5.0` | #### [](#packaging.repackage-goal.parameter-details.main-class)`mainClass` The name of the main class. If not specified the first compiled class found that contains a `main` method will be used. | Name | `mainClass` | | ------------- | ------------------ | | Type | `java.lang.String` | | Default value | | | User property | | | Since | `1.0.0` | #### [](#packaging.repackage-goal.parameter-details.output-directory)`outputDirectory` Directory containing the generated archive. | Name | `outputDirectory` | | ------------- | ---------------------------- | | Type | `java.io.File` | | Default value | `${project.build.directory}` | | User property | | | Since | `1.0.0` | #### [](#packaging.repackage-goal.parameter-details.output-timestamp)`outputTimestamp` Timestamp for reproducible output archive entries, either formatted as ISO 8601 (`yyyy-MM-dd’T’HH:mm:ssXXX`) or an `int` representing seconds since the epoch. | Name | `outputTimestamp` | | ------------- | ---------------------------------- | | Type | `java.lang.String` | | Default value | `${project.build.outputTimestamp}` | | User property | | | Since | `2.3.0` | #### [](#packaging.repackage-goal.parameter-details.requires-unpack)`requiresUnpack` A list of the libraries that must be unpacked from uber jars in order to run. Specify each library as a `` with a `` and a `` and they will be unpacked at runtime. | Name | `requiresUnpack` | | ------------- | ---------------- | | Type | `java.util.List` | | Default value | | | User property | | | Since | `1.1.0` | #### [](#packaging.repackage-goal.parameter-details.skip)`skip` Skip the execution. | Name | `skip` | | ------------- | ---------------------------- | | Type | `boolean` | | Default value | `false` | | User property | `spring-boot.repackage.skip` | | Since | `1.2.0` | ## [](#packaging.examples)Examples ### [](#packaging.examples.custom-classifier)Custom Classifier By default, the `repackage` goal replaces the original artifact with the repackaged one. That is a sane behavior for modules that represent an application but if your module is used as a dependency of another module, you need to provide a classifier for the repackaged one. The reason for that is that application classes are packaged in `BOOT-INF/classes` so that the dependent module cannot load a repackaged jar’s classes. If that is the case or if you prefer to keep the original artifact and attach the repackaged one with a different classifier, configure the plugin as shown in the following example: ```xml org.springframework.boot spring-boot-maven-plugin repackage repackage exec ``` If you are using `spring-boot-starter-parent`, the `repackage` goal is executed automatically in an execution with id `repackage`. In that setup, only the configuration should be specified, as shown in the following example: ```xml org.springframework.boot spring-boot-maven-plugin repackage exec ``` This configuration will generate two artifacts: the original one and the repackaged counter part produced by the repackage goal. Both will be installed/deployed transparently. You can also use the same configuration if you want to repackage a secondary artifact the same way the main artifact is replaced. The following configuration installs/deploys a single `task` classified artifact with the repackaged application: ```xml org.apache.maven.plugins maven-jar-plugin jar package task org.springframework.boot spring-boot-maven-plugin repackage repackage task ``` As both the `maven-jar-plugin` and the `spring-boot-maven-plugin` run at the same phase, it is important that the jar plugin is defined first (so that it runs before the repackage goal). Again, if you are using `spring-boot-starter-parent`, this can be simplified as follows: ```xml org.apache.maven.plugins maven-jar-plugin default-jar task org.springframework.boot spring-boot-maven-plugin repackage task ``` ### [](#packaging.examples.custom-name)Custom Name If you need the repackaged jar to have a different local name than the one defined by the `artifactId` attribute of the project, use the standard `finalName`, as shown in the following example: ```xml my-app org.springframework.boot spring-boot-maven-plugin repackage repackage ``` This configuration will generate the repackaged artifact in `target/my-app.jar`. ### [](#packaging.examples.local-artifact)Local Repackaged Artifact By default, the `repackage` goal replaces the original artifact with the executable one. If you need to only deploy the original jar and yet be able to run your app with the regular file name, configure the plugin as follows: ```xml org.springframework.boot spring-boot-maven-plugin repackage repackage false ``` This configuration generates two artifacts: the original one and the executable counter part produced by the `repackage` goal. Only the original one will be installed/deployed. ### [](#packaging.examples.custom-layout)Custom Layout Spring Boot repackages the jar file for this project using a custom layout factory defined in the additional jar file, provided as a dependency to the build plugin: ```xml org.springframework.boot spring-boot-maven-plugin repackage repackage value com.example custom-layout 0.0.1.BUILD-SNAPSHOT ``` The layout factory is provided as an implementation of `LayoutFactory` (from `spring-boot-loader-tools`) explicitly specified in the pom. If there is only one custom `LayoutFactory` on the plugin classpath and it is listed in `META-INF/spring.factories` then it is unnecessary to explicitly set it in the plugin configuration. Layout factories are always ignored if an explicit [layout](#packaging.repackage-goal.parameter-details.layout-factory) is set. ### [](#packaging.examples.exclude-dependency)Dependency Exclusion By default, both the `repackage` and the `run` goals will include any `provided` dependencies that are defined in the project. A Spring Boot project should consider `provided` dependencies as "container" dependencies that are required to run the application. Generally speaking, Spring Boot projects are not used as dependencies and are therefore unlikely to have any `optional` dependencies. When a project does have optional dependencies they too will be included by the `repackage` and `run` goals. Some of these dependencies may not be required at all and should be excluded from the executable jar. For consistency, they should not be present either when running the application. There are two ways one can exclude a dependency from being packaged/used at runtime: * Exclude a specific artifact identified by `groupId` and `artifactId`, optionally with a `classifier` if needed. * Exclude any artifact belonging to a given `groupId`. The following example excludes `com.example:module1`, and only that artifact: ```xml org.springframework.boot spring-boot-maven-plugin com.example module1 ``` This example excludes any artifact belonging to the `com.example` group: ```xml org.springframework.boot spring-boot-maven-plugin com.example ``` ### [](#packaging.examples.layered-archive-tools)JAR Tools When a layered jar or war is created, the `spring-boot-jarmode-tools` jar will be added as a dependency to your archive. With this jar on the classpath, you can launch your application in a special mode which allows the bootstrap code to run something entirely different from your application, for example, something that extracts the layers. If you wish to exclude this dependency, you can do so in the following manner: ```xml org.springframework.boot spring-boot-maven-plugin false ``` ### [](#packaging.examples.custom-layers-configuration)Custom Layers Configuration The default setup splits dependencies into snapshot and non-snapshot, however, you may have more complex rules. For example, you may want to isolate company-specific dependencies of your project in a dedicated layer. The following `layers.xml` configuration shown one such setup: ```xml org/springframework/boot/loader/** *:*:*SNAPSHOT com.acme:* dependencies spring-boot-loader snapshot-dependencies company-dependencies application ``` The configuration above creates an additional `company-dependencies` layer with all libraries with the `com.acme` groupId. * [Spring Boot](../index.html) * [4.1.1](packaging.html) * [4.0.8](../4.0/maven-plugin/packaging.html) * [3.5.16](../3.5/maven-plugin/packaging.html) * [3.4.13](../3.4/maven-plugin/packaging.html) * [3.3.13](../3.3/maven-plugin/packaging.html) - [4.2.0-M2](../4.2/maven-plugin/packaging.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/maven-plugin/packaging.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/maven-plugin/packaging.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/maven-plugin/packaging.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/goals.html ---- # Goals The Spring Boot Plugin has the following goals: | Goal | Description | | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [spring-boot:build-image](build-image.html#build-image.build-image-goal) | Package an application into an OCI image using a buildpack, forking the lifecycle to make sure that `package` ran. This goal is suitable for command-line invocation. If you need to configure a goal `execution` in your build, use `build-image-no-fork` instead. | | [spring-boot:build-image-no-fork](build-image.html#build-image.build-image-no-fork-goal) | Package an application into an OCI image using a buildpack, but without forking the lifecycle. This goal should be used when configuring a goal `execution` in your build. To invoke the goal on the command-line, use `build-image` instead. | | [spring-boot:build-info](build-info.html#build-info.build-info-goal) | Generate a `build-info.properties` file based on the content of the current `MavenProject`. | | [spring-boot:help](help.html#help.help-goal) | Display help information on spring-boot-maven-plugin. Call `mvn spring-boot:help -Ddetail=true -Dgoal=` to display parameter details. | | [spring-boot:process-aot](aot.html#aot.process-aot-goal) | Invoke the AOT engine on the application. | | [spring-boot:process-test-aot](aot.html#aot.process-test-aot-goal) | Invoke the AOT engine on tests. | | [spring-boot:repackage](packaging.html#packaging.repackage-goal) | Repackage existing JAR and WAR archives so that they can be executed from the command line using `java -jar`. With `layout=NONE` can also be used simply to package a JAR with nested dependencies (and no main class, so not executable). | | [spring-boot:run](run.html#run.run-goal) | Run an application in place. | | [spring-boot:start](integration-tests.html#integration-tests.start-goal) | Start a spring application. Contrary to the `run` goal, this does not block and allows other goals to operate on the application. This goal is typically used in integration test scenario where the application is started before a test suite and stopped after. | | [spring-boot:stop](integration-tests.html#integration-tests.stop-goal) | Stop an application that has been started by the "start" goal. Typically invoked once a test suite has completed. | | [spring-boot:test-run](run.html#run.test-run-goal) | Run an application in place using the test runtime classpath. The main class that will be used to launch the application is determined as follows: The configured main class, if any. Then the main class found in the test classes directory, if any. Then the main class found in the classes directory, if any. | * [Spring Boot](../index.html) * [4.1.1](goals.html) * [4.0.8](../4.0/maven-plugin/goals.html) * [3.5.16](../3.5/maven-plugin/goals.html) * [3.4.13](../3.4/maven-plugin/goals.html) * [3.3.13](../3.3/maven-plugin/goals.html) - [4.2.0-M2](../4.2/maven-plugin/goals.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/maven-plugin/goals.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/maven-plugin/goals.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/maven-plugin/goals.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/RepackageMojo.html ---- # Class RepackageMojo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.plugin.AbstractMojo [org.springframework.boot.maven.AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") [org.springframework.boot.maven.AbstractPackagerMojo](AbstractPackagerMojo.html "class in org.springframework.boot.maven") org.springframework.boot.maven.RepackageMojo * All Implemented Interfaces: `org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo` *** @Mojo(name="repackage", defaultPhase=PACKAGE, requiresProject=true, threadSafe=true, requiresDependencyResolution=COMPILE\_PLUS\_RUNTIME, requiresDependencyCollection=COMPILE\_PLUS\_RUNTIME) public class RepackageMojo extends [AbstractPackagerMojo](AbstractPackagerMojo.html "class in org.springframework.boot.maven") Repackage existing JAR and WAR archives so that they can be executed from the command line using java -jar. With `layout=NONE` can also be used simply to package a JAR with nested dependencies (and no main class, so not executable). * Since: 1.0.0 * Author: Phillip Webb, Dave Syer, Stephane Nicoll, Björn Lindström, Scott Frederick Constructor Description `RepackageMojo(org.apache.maven.project.MavenProjectHelper projectHelper)` Return the type of archive that should be packaged by this MOJO. * ### RepackageMojo @Inject public RepackageMojo​(org.apache.maven.project.MavenProjectHelper projectHelper) * ## Method Details * ### getLayout protected @Nullable [AbstractPackagerMojo.LayoutType](AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") getLayout() Return the type of archive that should be packaged by this MOJO. * Overrides: `getLayout` in class `AbstractPackagerMojo` * Returns: the value of the `layout` parameter, or `null` if the parameter is not provided * ### getLayoutFactory protected @Nullable org.springframework.boot.loader.tools.LayoutFactory getLayoutFactory() Return the layout factory that will be used to determine the [`AbstractPackagerMojo.LayoutType`](AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") if no explicit layout is set. * Overrides: `getLayoutFactory` in class `AbstractPackagerMojo` * Returns: the value of the `layoutFactory` parameter, or `null` if the parameter is not provided * ### execute public void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException * Throws: * `org.apache.maven.plugin.MojoExecutionException` * `org.apache.maven.plugin.MojoFailureException` ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/plugin/SpringBootAotPlugin.html ---- # Class SpringBootAotPlugin [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.gradle.plugin.SpringBootAotPlugin * All Implemented Interfaces: `Plugin` *** public class SpringBootAotPlugin extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") implements [Plugin](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Plugin.html "class or interface in org.gradle.api")<[Project](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Project.html "class or interface in org.gradle.api")> Gradle plugin for Spring Boot AOT. * Since: 3.0.0 * Author: Andy Wilkinson - ## Field Summary Fields Modifier and Type Field Description `static final String` `AOT_SOURCE_SET_NAME` Name of the main `aot` [`source set`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html "class or interface in org.gradle.api.tasks"). `static final String` `AOT_TEST_SOURCE_SET_NAME` Name of the `aotTest` [`source set`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html "class or interface in org.gradle.api.tasks"). `static final String` `PROCESS_AOT_TASK_NAME` Name of the default [`ProcessAot`](../tasks/aot/ProcessAot.html "class in org.springframework.boot.gradle.tasks.aot") task. `static final String` `PROCESS_TEST_AOT_TASK_NAME` Name of the default [`ProcessAot`](../tasks/aot/ProcessAot.html "class in org.springframework.boot.gradle.tasks.aot") task. - ## Constructor Summary Constructors Constructor Description `SpringBootAotPlugin()` * ### AOT\_SOURCE\_SET\_NAME public static final [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") AOT\_SOURCE\_SET\_NAME Name of the main `aot` [`source set`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html "class or interface in org.gradle.api.tasks"). * See Also: * [Constant Field Values](../../../../../constant-values.html#org.springframework.boot.gradle.plugin.SpringBootAotPlugin.AOT_SOURCE_SET_NAME) * ### AOT\_TEST\_SOURCE\_SET\_NAME public static final [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") AOT\_TEST\_SOURCE\_SET\_NAME Name of the `aotTest` [`source set`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html "class or interface in org.gradle.api.tasks"). * See Also: * [Constant Field Values](../../../../../constant-values.html#org.springframework.boot.gradle.plugin.SpringBootAotPlugin.AOT_TEST_SOURCE_SET_NAME) * ### PROCESS\_AOT\_TASK\_NAME public static final [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") PROCESS\_AOT\_TASK\_NAME Name of the default [`ProcessAot`](../tasks/aot/ProcessAot.html "class in org.springframework.boot.gradle.tasks.aot") task. * See Also: * [Constant Field Values](../../../../../constant-values.html#org.springframework.boot.gradle.plugin.SpringBootAotPlugin.PROCESS_AOT_TASK_NAME) * ### PROCESS\_TEST\_AOT\_TASK\_NAME public static final [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") PROCESS\_TEST\_AOT\_TASK\_NAME Name of the default [`ProcessAot`](../tasks/aot/ProcessAot.html "class in org.springframework.boot.gradle.tasks.aot") task. * See Also: * [Constant Field Values](../../../../../constant-values.html#org.springframework.boot.gradle.plugin.SpringBootAotPlugin.PROCESS_TEST_AOT_TASK_NAME) * ## Constructor Details * ### SpringBootAotPlugin public SpringBootAotPlugin() * ## Method Details * ### apply public void apply​([Project](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Project.html "class or interface in org.gradle.api") project) * Specified by: `apply` in interface `Plugin` ---- url: https://docs.spring.io/spring-boot/reference/web/spring-session.html ---- # Spring Session Spring Boot provides [Spring Session](https://spring.io/projects/spring-session) auto-configuration for a range of data stores. For each data store, a specific Spring Boot starter is provided. When building a servlet web application, the following stores can be auto-configured: * Redis (`spring-boot-starter-session-data-redis`) * JDBC (`spring-boot-starter-session-jdbc`) The servlet auto-configuration replaces the need to use `@Enable*HttpSession`. When building a reactive web application, the Redis store can be auto-configured by depending on `spring-boot-starter-session-data-redis`. This replaces the need to use `@EnableRedisWebSession`. Each store has specific additional settings. For instance, it is possible to customize the name of the table for the JDBC store, as shown in the following example: * Properties * YAML ```properties spring.session.jdbc.table-name=SESSIONS ``` ```yaml spring: session: jdbc: table-name: "SESSIONS" ``` For setting the timeout of the session you can use the `spring.session.timeout` property. If that property is not set with a servlet web application, the auto-configuration falls back to the value of `server.servlet.session.timeout`. To provide the timeout programmatically, define a [`SessionTimeout`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/session/autoconfigure/SessionTimeout.html) bean. You can take control over Spring Session’s configuration using `@Enable*HttpSession` (servlet) or `@EnableRedisWebSession` (reactive). This will cause the auto-configuration to back off. Alternatively, depend on the relevant Spring Session module directly rather than using one of Spring Boot’s starters for Spring Session. With either approach, Spring Session can then be configured using the annotation’s attributes rather than the previously described configuration properties. * [Spring Boot](../../index.html) * [4.1.1](spring-session.html) * [4.0.8](../../4.0/reference/web/spring-session.html) * [3.5.16](../../3.5/reference/web/spring-session.html) * [3.4.13](../../3.4/reference/web/spring-session.html) * [3.3.13](../../3.3/reference/web/spring-session.html) - [4.2.0-M2](../../4.2/reference/web/spring-session.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/web/spring-session.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/web/spring-session.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/web/spring-session.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/aot/package-tree.html ---- # Hierarchy For Package org.springframework.boot.gradle.tasks.aot Package Hierarchies: * [All Packages](../../../../../../overview-tree.html) ## Class Hierarchy * java.lang.[Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") * org.gradle.api.internal.AbstractTask (implements org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal) * org.gradle.api.[DefaultTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/DefaultTask.html "class or interface in org.gradle.api") (implements org.gradle.api.[Task](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api")) * org.gradle.api.internal.ConventionTask (implements org.gradle.api.internal.IConventionAware) * org.gradle.api.tasks.[JavaExec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") (implements org.gradle.process.[JavaExecSpec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/process/JavaExecSpec.html "class or interface in org.gradle.process")) * org.springframework.boot.gradle.tasks.aot.[AbstractAot](AbstractAot.html "class in org.springframework.boot.gradle.tasks.aot") * org.springframework.boot.gradle.tasks.aot.[ProcessAot](ProcessAot.html "class in org.springframework.boot.gradle.tasks.aot") * org.springframework.boot.gradle.tasks.aot.[ProcessTestAot](ProcessTestAot.html "class in org.springframework.boot.gradle.tasks.aot") ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/allclasses-index.html ---- # All Classes and Interfaces Class Description [AbstractAotMojo](org/springframework/boot/maven/AbstractAotMojo.html "class in org.springframework.boot.maven") Abstract base class for AOT processing MOJOs. [AbstractAotMojo.Errors](org/springframework/boot/maven/AbstractAotMojo.Errors.html "class in org.springframework.boot.maven") [`DiagnosticListener`](https://docs.oracle.com/en/java/javase/17/docs/api/java.compiler/javax/tools/DiagnosticListener.html "class or interface in javax.tools") used to collect errors. [AbstractDependencyFilterMojo](org/springframework/boot/maven/AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") A base mojo filtering the dependencies of the project. [AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter](org/springframework/boot/maven/AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter.html "class in org.springframework.boot.maven") `ArtifactFilter` to exclude test scope dependencies. [AbstractPackagerMojo](org/springframework/boot/maven/AbstractPackagerMojo.html "class in org.springframework.boot.maven") Abstract base class for classes that work with an `Packager`. [AbstractPackagerMojo.LayoutType](org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") Archive layout types. [AbstractRunMojo](org/springframework/boot/maven/AbstractRunMojo.html "class in org.springframework.boot.maven") Base class to run a Spring Boot application. [ArtifactsLibraries](org/springframework/boot/maven/ArtifactsLibraries.html "class in org.springframework.boot.maven") `Libraries` backed by Maven `Artifact`s. [BuildImageForkMojo](org/springframework/boot/maven/BuildImageForkMojo.html "class in org.springframework.boot.maven") Package an application into an OCI image using a buildpack, forking the lifecycle to make sure that `package` ran. [BuildImageMojo](org/springframework/boot/maven/BuildImageMojo.html "class in org.springframework.boot.maven") Package an application into an OCI image using a buildpack. [BuildImageNoForkMojo](org/springframework/boot/maven/BuildImageNoForkMojo.html "class in org.springframework.boot.maven") Package an application into an OCI image using a buildpack, but without forking the lifecycle. [BuildInfoMojo](org/springframework/boot/maven/BuildInfoMojo.html "class in org.springframework.boot.maven") Generate a `build-info.properties` file based on the content of the current `MavenProject`. [CacheInfo](org/springframework/boot/maven/CacheInfo.html "class in org.springframework.boot.maven") Encapsulates configuration of an image building cache. [CacheInfo.BindCacheInfo](org/springframework/boot/maven/CacheInfo.BindCacheInfo.html "class in org.springframework.boot.maven") Encapsulates configuration of an image building cache stored in a bind mount. [CacheInfo.VolumeCacheInfo](org/springframework/boot/maven/CacheInfo.VolumeCacheInfo.html "class in org.springframework.boot.maven") Encapsulates configuration of an image building cache stored in a volume. [DependencyFilter](org/springframework/boot/maven/DependencyFilter.html "class in org.springframework.boot.maven") Base class for `ArtifactsFilter` based on a [`FilterableDependency`](org/springframework/boot/maven/FilterableDependency.html "class in org.springframework.boot.maven") list. [Docker](org/springframework/boot/maven/Docker.html "class in org.springframework.boot.maven") Docker configuration options. [Docker.DockerRegistry](org/springframework/boot/maven/Docker.DockerRegistry.html "class in org.springframework.boot.maven") Encapsulates Docker registry authentication configuration options. [Exclude](org/springframework/boot/maven/Exclude.html "class in org.springframework.boot.maven") A model for a dependency to exclude. [ExcludeFilter](org/springframework/boot/maven/ExcludeFilter.html "class in org.springframework.boot.maven") An {DependencyFilter} that filters out any artifact matching an [`Exclude`](org/springframework/boot/maven/Exclude.html "class in org.springframework.boot.maven"). [FilterableDependency](org/springframework/boot/maven/FilterableDependency.html "class in org.springframework.boot.maven") A model for a dependency to include or exclude. [HelpMojo](org/springframework/boot/maven/HelpMojo.html "class in org.springframework.boot.maven") Display help information on spring-boot-maven-plugin.\ Call `mvn spring-boot:help -Ddetail=true -Dgoal=` to display parameter details. [Image](org/springframework/boot/maven/Image.html "class in org.springframework.boot.maven") Image configuration options. [Include](org/springframework/boot/maven/Include.html "class in org.springframework.boot.maven") A model for a dependency to include. [IncludeFilter](org/springframework/boot/maven/IncludeFilter.html "class in org.springframework.boot.maven") An `ArtifactsFilter` that filters out any artifact not matching an [`Include`](org/springframework/boot/maven/Include.html "class in org.springframework.boot.maven"). [Layers](org/springframework/boot/maven/Layers.html "class in org.springframework.boot.maven") Layer configuration options. [MatchingGroupIdFilter](org/springframework/boot/maven/MatchingGroupIdFilter.html "class in org.springframework.boot.maven") An `ArtifactsFilter` that filters by matching groupId. [ProcessAotMojo](org/springframework/boot/maven/ProcessAotMojo.html "class in org.springframework.boot.maven") Invoke the AOT engine on the application. [ProcessTestAotMojo](org/springframework/boot/maven/ProcessTestAotMojo.html "class in org.springframework.boot.maven") Invoke the AOT engine on tests. [PropertiesMergingResourceTransformer](org/springframework/boot/maven/PropertiesMergingResourceTransformer.html "class in org.springframework.boot.maven") Extension for the [Maven shade plugin](https://maven.apache.org/plugins/maven-shade-plugin/) to allow properties files (e.g. [RepackageMojo](org/springframework/boot/maven/RepackageMojo.html "class in org.springframework.boot.maven") Repackage existing JAR and WAR archives so that they can be executed from the command line using java -jar. [RunMojo](org/springframework/boot/maven/RunMojo.html "class in org.springframework.boot.maven") Run an application in place. [StartMojo](org/springframework/boot/maven/StartMojo.html "class in org.springframework.boot.maven") Start a spring application. [StopMojo](org/springframework/boot/maven/StopMojo.html "class in org.springframework.boot.maven") Stop an application that has been started by the "start" goal. [TestRunMojo](org/springframework/boot/maven/TestRunMojo.html "class in org.springframework.boot.maven") Run an application in place using the test runtime classpath. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-19.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## V * [valueOf(String)](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html#valueOf\(java.lang.String\)) - Static method in enum class org.springframework.boot.maven.[AbstractPackagerMojo.LayoutType](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") Returns the enum constant of this class with the specified name. * [values()](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html#values\(\)) - Static method in enum class org.springframework.boot.maven.[AbstractPackagerMojo.LayoutType](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") Returns an array containing the constants of this enum class, in the order they are declared. * [VolumeCacheInfo()](../org/springframework/boot/maven/CacheInfo.VolumeCacheInfo.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.maven.[CacheInfo.VolumeCacheInfo](../org/springframework/boot/maven/CacheInfo.VolumeCacheInfo.html "class in org.springframework.boot.maven")   [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/how-to/native-image/testing-native-applications.html ---- # Testing GraalVM Native Images When writing native image applications, we recommend that you continue to use the JVM whenever possible to develop the majority of your unit and integration tests. This will help keep developer build times down and allow you to use existing IDE integrations. With broad test coverage on the JVM, you can then focus native image testing on the areas that are likely to be different. For native image testing, you’re generally looking to ensure that the following aspects work: * The Spring AOT engine is able to process your application, and it will run in an AOT-processed mode. * GraalVM has enough hints to ensure that a valid native image can be produced. ## [](#howto.native-image.testing.with-the-jvm)Testing Ahead-of-Time Processing With the JVM When a Spring Boot application runs, it attempts to detect if it is running as a native image. If it is running as a native image, it will initialize the application using the code that was generated during at build-time by the Spring AOT engine. If the application is running on a regular JVM, then any AOT generated code is ignored. Since the `native-image` compilation phase can take a while to complete, it’s sometimes useful to run your application on the JVM but have it use the AOT generated initialization code. Doing so helps you to quickly validate that there are no errors in the AOT generated code and nothing is missing when your application is eventually converted to a native image. To run a Spring Boot application on the JVM and have it use AOT generated code you can set the `spring.aot.enabled` system property to `true`. For example: ```shell $ java -Dspring.aot.enabled=true -jar myapplication.jar ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | You need to ensure that the jar you are testing includes AOT generated code. For Maven, this means that you should build with `-Pnative` to activate the `native` profile. For Gradle, you need to ensure that your build includes the `org.graalvm.buildtools.native` plugin. | If your application starts with the `spring.aot.enabled` property set to `true`, then you have higher confidence that it will work when converted to a native image. You can also consider running integration tests against the running application. For example, you could use the Spring [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html) to call your application REST endpoints. Or you might consider using a project like Selenium to check your application’s HTML responses. ## [](#howto.native-image.testing.with-native-build-tools)Testing With Native Build Tools GraalVM Native Build Tools includes the ability to run tests inside a native image. This can be helpful when you want to deeply test that the internals of your application work in a GraalVM native image. Generating the native image that contains the tests to run can be a time-consuming operation, so most developers will probably prefer to use the JVM locally. They can, however, be very useful as part of a CI pipeline. For example, you might choose to run native tests once a day. Spring Framework includes ahead-of-time support for running tests. All the usual Spring testing features work with native image tests. For example, you can continue to use the [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html) annotation. You can also use Spring Boot [test slices](../../reference/testing/spring-boot-applications.html#testing.spring-boot-applications.autoconfigured-tests) to test only specific parts of your application. Spring Framework’s native testing support works in the following way: * Tests are analyzed in order to discover any [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) instances that will be required. * Ahead-of-time processing is applied to each of these application contexts and assets are generated. * A native image is created, with the generated assets being processed by GraalVM. * The native image also includes the JUnit [`TestEngine`](https://junit.org/junit5/docs/6.0.3/api/org.junit.platform.engine/org/junit/platform/engine/TestEngine.html) configured with a list of the discovered tests. * The native image is started, triggering the engine which will run each test and report results. ### [](#howto.native-image.testing.with-native-build-tools.maven)Using Maven To run native tests using Maven, ensure that your `pom.xml` file uses the `spring-boot-starter-parent`. You should have a `` section that looks like this: ```xml org.springframework.boot spring-boot-starter-parent 4.1.1 ``` The `spring-boot-starter-parent` defines a `nativeTest` profile that provides the necessary configuration for the Spring Boot and Native Build Tools plugins. First you need to add those two plugin in the module to opt-in for the feature. Your tests are executed in native mode only when the `nativeTest` is enabled. You can activate profiles using the `-P` flag on the command line. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you don’t want to use `spring-boot-starter-parent` you’ll need to configure executions for the `process-test-aot` goal from the Spring Boot plugin and the `test` goal from the Native Build Tools plugin. | To build the image and run the tests, use the `test` goal with the `nativeTest` profile active: ```shell $ mvn -PnativeTest test ``` ### [](#howto.native-image.testing.with-native-build-tools.gradle)Using Gradle The Spring Boot Gradle plugin automatically configures AOT test tasks when the GraalVM Native Image plugin is applied. You should check that your Gradle build contains a `plugins` block that includes `org.graalvm.buildtools.native`. To run native tests using Gradle you can use the `nativeTest` task: ```shell $ gradle nativeTest ``` * [Spring Boot](../../index.html) * [4.1.1](testing-native-applications.html) * [4.0.8](../../4.0/how-to/native-image/testing-native-applications.html) * [3.5.16](../../3.5/how-to/native-image/testing-native-applications.html) * [3.4.13](../../3.4/how-to/native-image/testing-native-applications.html) * [3.3.13](../../3.3/how-to/native-image/testing-native-applications.html) - [4.2.0-M2](../../4.2/how-to/native-image/testing-native-applications.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/how-to/native-image/testing-native-applications.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/how-to/native-image/testing-native-applications.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/how-to/native-image/testing-native-applications.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesIntoLayerSpec.html ---- # Class LayeredSpec.DependenciesIntoLayerSpec [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") [org.springframework.boot.gradle.tasks.bundling.LayeredSpec.IntoLayerSpec](LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") org.springframework.boot.gradle.tasks.bundling.LayeredSpec.DependenciesIntoLayerSpec * All Implemented Interfaces: `Serializable` - Enclosing class: `LayeredSpec` *** public static class LayeredSpec.DependenciesIntoLayerSpec extends [LayeredSpec.IntoLayerSpec](LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Spec that controls the dependencies that should be part of a particular layer. * Since: 2.4.0 * Author: Madhura Bhave, Scott Frederick, Phillip Webb * See Also: * [Serialized Form](../../../../../../serialized-form.html#org.springframework.boot.gradle.tasks.bundling.LayeredSpec.DependenciesIntoLayerSpec) - ## Constructor Summary Constructors Constructor Description `DependenciesIntoLayerSpec(String intoLayer)` Creates a new `IntoLayerSpec` that will control the content of the given layer. - ## Method Summary Modifier and Type Method Description `void` `excludeProjectDependencies()` Configures the layer to exclude project dependencies. `void` `includeProjectDependencies()` Configures the layer to include project dependencies. ### Methods inherited from class [LayeredSpec.IntoLayerSpec](LayeredSpec.IntoLayerSpec.html#method-summary "class in org.springframework.boot.gradle.tasks.bundling") `exclude, include` ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### DependenciesIntoLayerSpec public DependenciesIntoLayerSpec​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") intoLayer) Creates a new `IntoLayerSpec` that will control the content of the given layer. * Parameters: `intoLayer` - the layer * ## Method Details * ### includeProjectDependencies public void includeProjectDependencies() Configures the layer to include project dependencies. If no includes are specified then all content is included. If includes are specified then content must match an inclusion and not match any exclusions to be included. * ### excludeProjectDependencies public void excludeProjectDependencies() Configures the layer to exclude project dependencies. If no excludes a specified no content is excluded. If exclusions are specified then any content that matches an exclusion will be excluded irrespective of whether it matches an include. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/BuildImageNoForkMojo.html ---- # Class BuildImageNoForkMojo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.plugin.AbstractMojo [org.springframework.boot.maven.AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") [org.springframework.boot.maven.AbstractPackagerMojo](AbstractPackagerMojo.html "class in org.springframework.boot.maven") [org.springframework.boot.maven.BuildImageMojo](BuildImageMojo.html "class in org.springframework.boot.maven") org.springframework.boot.maven.BuildImageNoForkMojo * All Implemented Interfaces: `org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo` *** @Mojo(name="build-image-no-fork", defaultPhase=PACKAGE, requiresProject=true, threadSafe=true, requiresDependencyResolution=COMPILE\_PLUS\_RUNTIME, requiresDependencyCollection=COMPILE\_PLUS\_RUNTIME) public class BuildImageNoForkMojo extends [BuildImageMojo](BuildImageMojo.html "class in org.springframework.boot.maven") Package an application into an OCI image using a buildpack, but without forking the lifecycle. This goal should be used when configuring a goal `execution` in your build. To invoke the goal on the command-line, use `build-image` instead. `BuildImageNoForkMojo(org.apache.maven.project.MavenProjectHelper projectHelper)` * ### BuildImageNoForkMojo @Inject public BuildImageNoForkMojo​(org.apache.maven.project.MavenProjectHelper projectHelper) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/RunMojo.html ---- # Class RunMojo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.plugin.AbstractMojo [org.springframework.boot.maven.AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") [org.springframework.boot.maven.AbstractRunMojo](AbstractRunMojo.html "class in org.springframework.boot.maven") org.springframework.boot.maven.RunMojo * All Implemented Interfaces: `org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo` *** @Mojo(name="run", requiresProject=true, defaultPhase=VALIDATE, requiresDependencyResolution=TEST) @Execute(phase=TEST\_COMPILE) public class RunMojo extends [AbstractRunMojo](AbstractRunMojo.html "class in org.springframework.boot.maven") Run an application in place. * Since: 1.0.0 `RunMojo(org.apache.maven.toolchain.ToolchainManager toolchainManager)`   - ## Method Summary Modifier and Type Method Description `execute, getClassesDirectories, getClassPathUrls, resolveApplicationArguments, resolveEnvVariables` * ### RunMojo @Inject public RunMojo​(org.apache.maven.toolchain.ToolchainManager toolchainManager) * ## Method Details * ### resolveJvmArguments protected org.springframework.boot.maven.RunArguments resolveJvmArguments() Description copied from class: `AbstractRunMojo` Resolve the JVM arguments to use. * Overrides: `resolveJvmArguments` in class `AbstractRunMojo` * Returns: a `RunArguments` defining the JVM arguments * ### run protected void run​(org.springframework.boot.maven.JavaProcessExecutor processExecutor, [File](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html "class or interface in java.io") workingDirectory, [List](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html "class or interface in java.util")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> args, [Map](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html "class or interface in java.util")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang"),​[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> environmentVariables) throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException Description copied from class: `AbstractRunMojo` Run the application. * Specified by: `run` in class `AbstractRunMojo` * Parameters: * `processExecutor` - the `JavaProcessExecutor` to use * `workingDirectory` - the working directory of the forked JVM * `args` - the arguments (JVM arguments and application arguments) * `environmentVariables` - the environment variables * Throws: * `org.apache.maven.plugin.MojoExecutionException` - in case of MOJO execution errors * `org.apache.maven.plugin.MojoFailureException` - in case of MOJO failures * ### isUseTestClasspath protected boolean isUseTestClasspath() * Specified by: `isUseTestClasspath` in class `AbstractRunMojo` ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-12.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## M * [MatchingGroupIdFilter](../org/springframework/boot/maven/MatchingGroupIdFilter.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) An `ArtifactsFilter` that filters by matching groupId. * [MatchingGroupIdFilter(String)](../org/springframework/boot/maven/MatchingGroupIdFilter.html#%3Cinit%3E\(java.lang.String\)) - Constructor for class org.springframework.boot.maven.[MatchingGroupIdFilter](../org/springframework/boot/maven/MatchingGroupIdFilter.html "class in org.springframework.boot.maven") Create a new instance with the CSV groupId values that should be excluded. * [modifyOutputStream(JarOutputStream)](../org/springframework/boot/maven/PropertiesMergingResourceTransformer.html#modifyOutputStream\(java.util.jar.JarOutputStream\)) - Method in class org.springframework.boot.maven.[PropertiesMergingResourceTransformer](../org/springframework/boot/maven/PropertiesMergingResourceTransformer.html "class in org.springframework.boot.maven")   [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/reference/actuator/observability.html ---- # Observability Observability is the ability to observe the internal state of a running system from the outside. It consists of the three pillars: logging, metrics and traces. For metrics and traces, Spring Boot uses [Micrometer Observation](https://docs.micrometer.io/micrometer/reference/1.17/observation). To create your own observations (which will lead to metrics and traces), you can inject an [`ObservationRegistry`](https://javadoc.io/doc/io.micrometer/micrometer-observation/1.17.1/io/micrometer/observation/ObservationRegistry.html). * Java * Kotlin ```java import io.micrometer.observation.Observation; import io.micrometer.observation.ObservationRegistry; import org.springframework.stereotype.Component; @Component public class MyCustomObservation { private final ObservationRegistry observationRegistry; public MyCustomObservation(ObservationRegistry observationRegistry) { this.observationRegistry = observationRegistry; } public void doSomething() { Observation.createNotStarted("doSomething", this.observationRegistry) .lowCardinalityKeyValue("locale", "en-US") .highCardinalityKeyValue("userId", "42") .observe(() -> { // Execute business logic here }); } } ``` ```kotlin import io.micrometer.observation.Observation import io.micrometer.observation.ObservationRegistry; import org.springframework.stereotype.Component @Component class MyCustomObservation(private val observationRegistry: ObservationRegistry) { fun doSomething() { Observation.createNotStarted("doSomething", observationRegistry) .lowCardinalityKeyValue("locale", "en-US") .highCardinalityKeyValue("userId", "42") .observe { // Execute business logic here } } } ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------- | | ** | Low cardinality tags will be added to metrics and traces, while high cardinality tags will only be added to traces. | Beans of type [`ObservationPredicate`](https://javadoc.io/doc/io.micrometer/micrometer-observation/1.17.1/io/micrometer/observation/ObservationPredicate.html), [`GlobalObservationConvention`](https://javadoc.io/doc/io.micrometer/micrometer-observation/1.17.1/io/micrometer/observation/GlobalObservationConvention.html), [`ObservationFilter`](https://javadoc.io/doc/io.micrometer/micrometer-observation/1.17.1/io/micrometer/observation/ObservationFilter.html) and [`ObservationHandler`](https://javadoc.io/doc/io.micrometer/micrometer-observation/1.17.1/io/micrometer/observation/ObservationHandler.html) will be automatically registered on the [`ObservationRegistry`](https://javadoc.io/doc/io.micrometer/micrometer-observation/1.17.1/io/micrometer/observation/ObservationRegistry.html). You can additionally register any number of [`ObservationRegistryCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/observation/autoconfigure/ObservationRegistryCustomizer.html) beans to further configure the registry. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Observability for JDBC can be configured using a separate project. The [Datasource Micrometer project](https://github.com/jdbc-observations/datasource-micrometer) provides a Spring Boot starter which automatically creates observations when JDBC operations are invoked. Read more about it [in the reference documentation](https://jdbc-observations.github.io/datasource-micrometer/docs/current/docs/html/). | | | | | -- | --------------------------------------------------------------------------------------------------------------------------- | | ** | Observability for R2DBC is built into Spring Boot. To enable it, add the `io.r2dbc:r2dbc-proxy` dependency to your project. | ## [](#actuator.observability.context-propagation)Context Propagation Observability support relies on the [Context Propagation library](https://github.com/micrometer-metrics/context-propagation) for forwarding the current observation across threads and reactive pipelines. By default, [`ThreadLocal`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/ThreadLocal.html) values are not automatically reinstated in reactive operators. This behavior is controlled with the `spring.reactor.context-propagation` property, which can be set to `auto` to enable automatic propagation. If you’re working with [`@Async`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/annotation/Async.html) methods and the [`AsyncTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/AsyncTaskExecutor.html) is auto-configured, you have to opt-in for context propagation using the `spring.task.execution.propagate-context` property. If you are configuring the [`AsyncTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/AsyncTaskExecutor.html) yourself, then you need to register a [`ContextPropagatingTaskDecorator`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/support/ContextPropagatingTaskDecorator.html) bean, as shown in the following example: * Java * Kotlin ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.core.task.support.ContextPropagatingTaskDecorator; @Configuration(proxyBeanMethods = false) class ContextPropagationConfiguration { @Bean ContextPropagatingTaskDecorator contextPropagatingTaskDecorator() { return new ContextPropagatingTaskDecorator(); } } ``` ```kotlin import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.core.task.support.ContextPropagatingTaskDecorator @Configuration(proxyBeanMethods = false) class ContextPropagationConfiguration { @Bean fun contextPropagatingTaskDecorator(): ContextPropagatingTaskDecorator { return ContextPropagatingTaskDecorator() } } ``` For more details about observations please see the [Micrometer Observation documentation](https://docs.micrometer.io/micrometer/reference/1.17/observation). ## [](#actuator.observability.common-tags)Common Tags Common tags are generally used for dimensional drill-down on the operating environment, such as host, instance, region, stack, and others. Common tags are applied to all observations as low cardinality tags and can be configured, as the following example shows: * Properties * YAML ```properties management.observations.key-values.region=us-east-1 management.observations.key-values.stack=prod ``` ```yaml management: observations: key-values: region: "us-east-1" stack: "prod" ``` The preceding example adds `region` and `stack` tags to all observations with a value of `us-east-1` and `prod`, respectively. ## [](#actuator.observability.preventing-observations)Preventing Observations If you’d like to prevent some observations from being reported, you can use the `management.observations.enable` properties: * Properties * YAML ```properties management.observations.enable.denied.prefix=false management.observations.enable.another.denied.prefix=false ``` ```yaml management: observations: enable: denied: prefix: false another: denied: prefix: false ``` The preceding example will prevent all observations with a name starting with `denied.prefix` or `another.denied.prefix`. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you want to prevent Spring Security from reporting observations, set the property `management.observations.enable.spring.security` to `false`. | If you need greater control over the prevention of observations, you can register beans of type [`ObservationPredicate`](https://javadoc.io/doc/io.micrometer/micrometer-observation/1.17.1/io/micrometer/observation/ObservationPredicate.html). Observations are only reported if all the [`ObservationPredicate`](https://javadoc.io/doc/io.micrometer/micrometer-observation/1.17.1/io/micrometer/observation/ObservationPredicate.html) beans return `true` for that observation. * Java * Kotlin ```java import io.micrometer.observation.Observation.Context; import io.micrometer.observation.ObservationPredicate; import org.springframework.stereotype.Component; @Component class MyObservationPredicate implements ObservationPredicate { @Override public boolean test(String name, Context context) { return !name.contains("denied"); } } ``` ```kotlin import io.micrometer.observation.Observation.Context import io.micrometer.observation.ObservationPredicate import org.springframework.stereotype.Component @Component class MyObservationPredicate : ObservationPredicate { override fun test(name: String, context: Context): Boolean { return !name.contains("denied") } } ``` The preceding example will prevent all observations whose name contains "denied". ## [](#actuator.observability.annotations)Micrometer Observation Annotations support To enable scanning of observability annotations like [`@Observed`](https://javadoc.io/doc/io.micrometer/micrometer-observation/1.17.1/io/micrometer/observation/annotation/Observed.html), [`@Timed`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/annotation/Timed.html), [`@Counted`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/annotation/Counted.html), [`@MeterTag`](https://javadoc.io/doc/io.micrometer/micrometer-core/1.17.1/io/micrometer/core/aop/MeterTag.html) and [`@NewSpan`](https://javadoc.io/doc/io.micrometer/micrometer-tracing/1.7.1/io/micrometer/tracing/annotation/NewSpan.html), set the `management.observations.annotations.enabled` property to `true`. A dependency on `org.aspectj:aspectjweaver`, which is part of `spring-boot-starter-aspectj`, is also required. This feature is supported by Micrometer directly. Please refer to the [Micrometer](https://docs.micrometer.io/micrometer/reference/1.17/concepts/timers.html#_the_timed_annotation), [Micrometer Observation](https://docs.micrometer.io/micrometer/reference/1.17/observation/components.html#micrometer-observation-annotations) and [Micrometer Tracing](https://docs.micrometer.io/tracing/reference/1.7/api.html#_aspect_oriented_programming) reference docs. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | When you annotate methods or classes which are already instrumented (for example, [Spring Data repositories](metrics.html#actuator.metrics.supported.spring-data-repository) or [Spring MVC controllers](metrics.html#actuator.metrics.supported.spring-mvc)), you will get duplicate observations. In that case you can either disable the automatic instrumentation using [properties](#actuator.observability.preventing-observations) or an [`ObservationPredicate`](https://javadoc.io/doc/io.micrometer/micrometer-observation/1.17.1/io/micrometer/observation/ObservationPredicate.html) and rely on your annotations, or you can remove your annotations. | ## [](#actuator.observability.opentelemetry)OpenTelemetry Support | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | There are several ways to support [OpenTelemetry](https://opentelemetry.io/) in your application. You can use the [OpenTelemetry Java Agent](https://opentelemetry.io/docs/zero-code/java/agent/) or the [OpenTelemetry Spring Boot Starter](https://opentelemetry.io/docs/zero-code/java/spring-boot-starter/), which are supported by the OTel community; the metrics and traces use the semantic conventions defined by OTel libraries. This documentation describes OpenTelemetry as officially supported by the Spring team, using Micrometer and the OTLP exporter; the metrics and traces use the semantic conventions described in the Spring projects documentation, such as [Spring Framework](https://docs.spring.io/spring-framework/reference/7.0/integration/observability.html). | Spring Boot’s actuator module includes basic support for OpenTelemetry. It provides a bean of type [`OpenTelemetry`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-api/1.62.0/io/opentelemetry/api/OpenTelemetry.html), and if there are beans of type [`SdkTracerProvider`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-trace/1.62.0/io/opentelemetry/sdk/trace/SdkTracerProvider.html), [`ContextPropagators`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-context/1.62.0/io/opentelemetry/context/propagation/ContextPropagators.html), [`SdkLoggerProvider`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-logs/1.62.0/io/opentelemetry/sdk/logs/SdkLoggerProvider.html) or [`SdkMeterProvider`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-metrics/1.62.0/io/opentelemetry/sdk/metrics/SdkMeterProvider.html) in the application context, they automatically get registered. Additionally, it provides a [`Resource`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-common/1.62.0/io/opentelemetry/sdk/resources/Resource.html) bean. The attributes of the auto-configured [`Resource`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-common/1.62.0/io/opentelemetry/sdk/resources/Resource.html) can be configured via the `management.opentelemetry.resource-attributes` configuration property. Auto-configured attributes will be merged with attributes from the `OTEL_RESOURCE_ATTRIBUTES` and `OTEL_SERVICE_NAME` environment variables, with attributes configured through the configuration property taking precedence over those from the environment variables. If you have defined your own [`Resource`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-common/1.62.0/io/opentelemetry/sdk/resources/Resource.html) bean, this will no longer be the case. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Spring Boot does not provide automatic exporting of OpenTelemetry metrics or logs. Exporting OpenTelemetry traces is only auto-configured when used together with [Micrometer Tracing](tracing.html). | ### [](#actuator.observability.opentelemetry.disabling)Disabling OpenTelemetry The OpenTelemetry support can be disabled by setting the `management.opentelemetry.enabled` property to `false`. This behaves similarly to the [`OTEL_SDK_DISABLED`](https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#general-sdk-configuration) environment variable (but negated): when the SDK is disabled, metrics, traces, and logging will use no-op implementations. Context propagators are not affected and continue to function normally. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Keep in mind that Spring Boot doesn’t use OpenTelemetry’s metrics functionality, so metrics might still be enabled even when disabling OpenTelemetry. | ### [](#actuator.observability.opentelemetry.environment-variables)Environment variables Spring Boot supports a subset of the [OpenTelemetry SDK environment variables](https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/). These environment variables are automatically mapped to Spring Boot configuration properties at startup. When an environment variable has a signal-specific variant (for example, `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT`) and a general variant (`OTEL_EXPORTER_OTLP_ENDPOINT`), the signal-specific variant takes precedence and is used as-is. When the general variant is used as a fallback, the signal-specific path (`v1/traces`, `v1/metrics`, or `v1/logs`) is appended to it. For example, setting `OTEL_EXPORTER_OTLP_ENDPOINT=http://collector:4318` results in `collector:4318/v1/traces` for traces. This mapping can be disabled by setting `management.opentelemetry.map-environment-variables` to `false`. #### [](#actuator.observability.opentelemetry.environment-variables.general)General | Environment Variable | Spring Boot Property | | ------------------------------ | ------------------------------------------------------------------------------ | | `OTEL_SDK_DISABLED` | `management.opentelemetry.enabled` (inverted) | | `OTEL_PROPAGATORS` | `management.tracing.propagation.type` and `management.tracing.baggage.enabled` | | `OTEL_TRACES_SAMPLER` | `management.opentelemetry.tracing.sampler` | | `OTEL_TRACES_SAMPLER_ARG` | `management.tracing.sampling.probability` | | `OTEL_METRICS_EXEMPLAR_FILTER` | `management.tracing.exemplars.include` | #### [](#actuator.observability.opentelemetry.environment-variables.metrics)Metrics Exporter | Environment Variable | Spring Boot Property | | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `OTEL_EXPORTER_OTLP_METRICS_ENDPOINT` / `OTEL_EXPORTER_OTLP_ENDPOINT` | `management.otlp.metrics.export.url` | | `OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE` | `management.otlp.metrics.export.aggregation-temporality` | | `OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION` | `management.otlp.metrics.export.histogram-flavor` | | `OTEL_EXPORTER_OTLP_METRICS_COMPRESSION` / `OTEL_EXPORTER_OTLP_COMPRESSION` | `management.otlp.metrics.export.compression-mode` | | `OTEL_EXPORTER_OTLP_METRICS_TIMEOUT` / `OTEL_EXPORTER_OTLP_TIMEOUT` | `management.otlp.metrics.export.read-timeout` | | `OTEL_EXPORTER_OTLP_METRICS_HEADERS` / `OTEL_EXPORTER_OTLP_HEADERS` | `management.otlp.metrics.export.headers` | | `OTEL_METRIC_EXPORT_INTERVAL` | `management.otlp.metrics.export.step` | | `OTEL_METRICS_EXPORTER` | `management.otlp.metrics.export.enabled` (only `otlp` enables OTLP export; other values disable it but do not enable alternative exporters) | | `OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE` / `OTEL_EXPORTER_OTLP_CERTIFICATE` | `management.otlp.metrics.export.ssl.bundle` (auto-configured SSL bundle) | | `OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY` / `OTEL_EXPORTER_OTLP_CLIENT_KEY` | `management.otlp.metrics.export.ssl.bundle` (auto-configured SSL bundle) | | `OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE` / `OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE` | `management.otlp.metrics.export.ssl.bundle` (auto-configured SSL bundle) | #### [](#actuator.observability.opentelemetry.environment-variables.traces)Traces Exporter | Environment Variable | Spring Boot Property | | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` / `OTEL_EXPORTER_OTLP_ENDPOINT` | `management.opentelemetry.tracing.export.otlp.endpoint` | | `OTEL_EXPORTER_OTLP_TRACES_COMPRESSION` / `OTEL_EXPORTER_OTLP_COMPRESSION` | `management.opentelemetry.tracing.export.otlp.compression` | | `OTEL_EXPORTER_OTLP_TRACES_TIMEOUT` / `OTEL_EXPORTER_OTLP_TIMEOUT` | `management.opentelemetry.tracing.export.otlp.timeout` | | `OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` / `OTEL_EXPORTER_OTLP_PROTOCOL` | `management.opentelemetry.tracing.export.otlp.transport` | | `OTEL_EXPORTER_OTLP_TRACES_HEADERS` / `OTEL_EXPORTER_OTLP_HEADERS` | `management.opentelemetry.tracing.export.otlp.headers` | | `OTEL_BSP_SCHEDULE_DELAY` | `management.opentelemetry.tracing.export.schedule-delay` | | `OTEL_BSP_EXPORT_TIMEOUT` | `management.opentelemetry.tracing.export.timeout` | | `OTEL_BSP_MAX_QUEUE_SIZE` | `management.opentelemetry.tracing.export.max-queue-size` | | `OTEL_BSP_MAX_EXPORT_BATCH_SIZE` | `management.opentelemetry.tracing.export.max-batch-size` | | `OTEL_TRACES_EXPORTER` | `management.tracing.export.otlp.enabled` (only `otlp` enables OTLP export; other values disable it but do not enable alternative exporters) | | `OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT` / `OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT` | `management.opentelemetry.tracing.limits.max-attribute-value-length` | | `OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT` / `OTEL_ATTRIBUTE_COUNT_LIMIT` | `management.opentelemetry.tracing.limits.max-attributes` | | `OTEL_SPAN_EVENT_COUNT_LIMIT` | `management.opentelemetry.tracing.limits.max-events` | | `OTEL_SPAN_LINK_COUNT_LIMIT` | `management.opentelemetry.tracing.limits.max-links` | | `OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT` | `management.opentelemetry.tracing.limits.max-attributes-per-event` | | `OTEL_LINK_ATTRIBUTE_COUNT_LIMIT` | `management.opentelemetry.tracing.limits.max-attributes-per-link` | | `OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE` / `OTEL_EXPORTER_OTLP_CERTIFICATE` | `management.opentelemetry.tracing.export.otlp.ssl.bundle` (auto-configured SSL bundle) | | `OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY` / `OTEL_EXPORTER_OTLP_CLIENT_KEY` | `management.opentelemetry.tracing.export.otlp.ssl.bundle` (auto-configured SSL bundle) | | `OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE` / `OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE` | `management.opentelemetry.tracing.export.otlp.ssl.bundle` (auto-configured SSL bundle) | #### [](#actuator.observability.opentelemetry.environment-variables.logs)Logs Exporter | Environment Variable | Spring Boot Property | | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `OTEL_EXPORTER_OTLP_LOGS_ENDPOINT` / `OTEL_EXPORTER_OTLP_ENDPOINT` | `management.opentelemetry.logging.export.otlp.endpoint` | | `OTEL_EXPORTER_OTLP_LOGS_COMPRESSION` / `OTEL_EXPORTER_OTLP_COMPRESSION` | `management.opentelemetry.logging.export.otlp.compression` | | `OTEL_EXPORTER_OTLP_LOGS_TIMEOUT` / `OTEL_EXPORTER_OTLP_TIMEOUT` | `management.opentelemetry.logging.export.otlp.timeout` | | `OTEL_EXPORTER_OTLP_LOGS_PROTOCOL` / `OTEL_EXPORTER_OTLP_PROTOCOL` | `management.opentelemetry.logging.export.otlp.transport` | | `OTEL_EXPORTER_OTLP_LOGS_HEADERS` / `OTEL_EXPORTER_OTLP_HEADERS` | `management.opentelemetry.logging.export.otlp.headers` | | `OTEL_BLRP_SCHEDULE_DELAY` | `management.opentelemetry.logging.export.schedule-delay` | | `OTEL_BLRP_EXPORT_TIMEOUT` | `management.opentelemetry.logging.export.timeout` | | `OTEL_BLRP_MAX_QUEUE_SIZE` | `management.opentelemetry.logging.export.max-queue-size` | | `OTEL_BLRP_MAX_EXPORT_BATCH_SIZE` | `management.opentelemetry.logging.export.max-batch-size` | | `OTEL_LOGS_EXPORTER` | `management.logging.export.otlp.enabled` (only `otlp` enables OTLP export; other values disable it but do not enable alternative exporters) | | `OTEL_LOGRECORD_ATTRIBUTE_VALUE_LENGTH_LIMIT` / `OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT` | `management.opentelemetry.logging.limits.max-attribute-value-length` | | `OTEL_LOGRECORD_ATTRIBUTE_COUNT_LIMIT` / `OTEL_ATTRIBUTE_COUNT_LIMIT` | `management.opentelemetry.logging.limits.max-attributes` | | `OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE` / `OTEL_EXPORTER_OTLP_CERTIFICATE` | `management.opentelemetry.logging.export.otlp.ssl.bundle` (auto-configured SSL bundle) | | `OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY` / `OTEL_EXPORTER_OTLP_CLIENT_KEY` | `management.opentelemetry.logging.export.otlp.ssl.bundle` (auto-configured SSL bundle) | | `OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE` / `OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE` | `management.opentelemetry.logging.export.otlp.ssl.bundle` (auto-configured SSL bundle) | #### [](#actuator.observability.opentelemetry.environment-variables.resource)Resource The following environment variables configure the OpenTelemetry resource: * [`OTEL_RESOURCE_ATTRIBUTES`](https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#general-sdk-configuration) * [`OTEL_SERVICE_NAME`](https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#general-sdk-configuration) | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The `OTEL_RESOURCE_ATTRIBUTES` environment variable consists of a list of key-value pairs. For example: `key1=value1,key2=value2,key3=spring%20boot`. All attribute values are treated as strings, and any characters outside the baggage-octet range must be **percent-encoded**. | #### [](#actuator.observability.opentelemetry.environment-variables.unsupported)Unsupported Environment Variables Other environment variables as described in [the OpenTelemetry documentation](https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/) are not supported. If you want all environment variables specified by OpenTelemetry’s SDK to be effective, you have to supply your own `OpenTelemetry` bean. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------- | | ** | Doing this will switch off Spring Boot’s OpenTelemetry auto-configuration and may break the built-in observability functionality. | First, add a dependency to `io.opentelemetry:opentelemetry-sdk-extension-autoconfigure` to get [OpenTelemetry’s zero-code SDK autoconfigure module](https://opentelemetry.io/docs/languages/java/configuration/#zero-code-sdk-autoconfigure), then add this configuration: ```java import io.opentelemetry.api.OpenTelemetry; import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) class AutoConfiguredOpenTelemetrySdkConfiguration { @Bean OpenTelemetry autoConfiguredOpenTelemetrySdk() { return AutoConfiguredOpenTelemetrySdk.initialize().getOpenTelemetrySdk(); } } ``` ### [](#actuator.observability.opentelemetry.logging)Logging The [`OpenTelemetryLoggingAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/opentelemetry/autoconfigure/logging/OpenTelemetryLoggingAutoConfiguration.html) configures OpenTelemetry’s [`SdkLoggerProvider`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-logs/1.62.0/io/opentelemetry/sdk/logs/SdkLoggerProvider.html). Exporting logs via OTLP is supported through the [`OtlpLoggingAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/opentelemetry/autoconfigure/logging/otlp/OtlpLoggingAutoConfiguration.html), which enables OTLP log exporting over HTTP or gRPC. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | If you need to apply advanced customizations to OTLP log record exporters, consider registering [`OtlpHttpLogRecordExporterBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/opentelemetry/autoconfigure/logging/otlp/OtlpHttpLogRecordExporterBuilderCustomizer.html) or [`OtlpGrpcLogRecordExporterBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/opentelemetry/autoconfigure/logging/otlp/OtlpGrpcLogRecordExporterBuilderCustomizer.html) beans. These will be invoked before the creation of the [`OtlpHttpLogRecordExporter`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-otlp/1.62.0/io/opentelemetry/exporter/otlp/http/logs/OtlpHttpLogRecordExporter.html) or [`OtlpGrpcLogRecordExporter`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-otlp/1.62.0/io/opentelemetry/exporter/otlp/logs/OtlpGrpcLogRecordExporter.html). The customizers take precedence over anything applied by the auto-configuration. | However, while there is a `SdkLoggerProvider` bean, Spring Boot doesn’t support bridging logs to this bean out of the box. This can be done with 3rd-party log bridges, as described in the [Logging with OpenTelemetry](loggers.html#actuator.loggers.opentelemetry) section. ### [](#actuator.observability.opentelemetry.metrics)Metrics The choice of metrics in the Spring portfolio is Micrometer, which means that metrics are not collected and exported through the OpenTelemetry’s [`SdkMeterProvider`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-metrics/1.62.0/io/opentelemetry/sdk/metrics/SdkMeterProvider.html). Spring Boot doesn’t provide a `SdkMeterProvider` bean. However, Micrometer metrics can be exported via OTLP to any OpenTelemetry capable backend using the [`OtlpMeterRegistry`](https://javadoc.io/doc/io.micrometer/micrometer-registry-otlp/1.17.1/io/micrometer/registry/otlp/OtlpMeterRegistry.html), as described in the [Metrics with OTLP](metrics.html#actuator.metrics.export.otlp) section. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Micrometer’s OTLP registry doesn’t use the `Resource` bean, but setting `OTEL_RESOURCE_ATTRIBUTES`, `OTEL_SERVICE_NAME` or `management.opentelemetry.resource-attributes` works. | #### [](#actuator.observability.opentelemetry.metrics.api-and-sdk)Metrics via the OpenTelemetry API and SDK If you or a dependency you include make use of OpenTelemetry’s [`MeterProvider`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-api/1.62.0/io/opentelemetry/api/metrics/MeterProvider.html), those metrics are not exported. We strongly recommend that you report your metrics with Micrometer. If a dependency you include uses OpenTelemetry’s `MeterProvider`, you can include this configuration in your application to configure a `MeterProvider` bean, which you then have to wire into your dependency: ```java import java.time.Duration; import io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporter; import io.opentelemetry.sdk.metrics.SdkMeterProvider; import io.opentelemetry.sdk.metrics.export.MetricExporter; import io.opentelemetry.sdk.metrics.export.MetricReader; import io.opentelemetry.sdk.metrics.export.PeriodicMetricReader; import io.opentelemetry.sdk.resources.Resource; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) class OpenTelemetryMetricsConfiguration { @Bean OtlpHttpMetricExporter metricExporter() { String endpoint = "http://localhost:4318/v1/metrics"; return OtlpHttpMetricExporter.builder().setEndpoint(endpoint).build(); } @Bean PeriodicMetricReader metricReader(MetricExporter exporter) { Duration interval = Duration.ofMinutes(1); return PeriodicMetricReader.builder(exporter).setInterval(interval).build(); } @Bean SdkMeterProvider meterProvider(Resource resource, MetricReader metricReader) { return SdkMeterProvider.builder().registerMetricReader(metricReader).setResource(resource).build(); } } ``` This configuration also enables metrics export via OTLP over HTTP. ### [](#actuator.observability.opentelemetry.tracing)Tracing If Micrometer tracing is used, the [`OpenTelemetryTracingAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/tracing/opentelemetry/autoconfigure/OpenTelemetryTracingAutoConfiguration.html) configures OpenTelemetry’s [`SdkTracerProvider`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-trace/1.62.0/io/opentelemetry/sdk/trace/SdkTracerProvider.html). Exporting traces through OTLP is enabled by the [`OtlpTracingAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/micrometer/tracing/opentelemetry/autoconfigure/otlp/OtlpTracingAutoConfiguration.html), which supports exporting traces with OTLP over HTTP or gRPC. We strongly recommend using the Micrometer Observation or Tracing API instead of using the OpenTelemetry API directly. * [Spring Boot](../../index.html) * [4.1.1](observability.html) * [4.0.8](../../4.0/reference/actuator/observability.html) * [3.5.16](../../3.5/reference/actuator/observability.html) * [3.4.13](../../3.4/reference/actuator/observability.html) * [3.3.13](../../3.3/reference/actuator/observability.html) - [4.2.0-M2](../../4.2/reference/actuator/observability.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/actuator/observability.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/actuator/observability.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/actuator/observability.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/io/email.html ---- # Sending Email The Spring Framework provides an abstraction for sending email by using the [`JavaMailSender`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/mail/javamail/JavaMailSender.html) interface, and Spring Boot provides auto-configuration for it as well as a starter module. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | See the [reference documentation](https://docs.spring.io/spring-framework/reference/7.0/integration/email.html) for a detailed explanation of how you can use [`JavaMailSender`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/mail/javamail/JavaMailSender.html). | If `spring.mail.host` and the relevant libraries (as defined by `spring-boot-starter-mail`) are available, a default [`JavaMailSender`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/mail/javamail/JavaMailSender.html) is created if none exists. The sender can be further customized by configuration items from the `spring.mail` namespace. See [`MailProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/mail/autoconfigure/MailProperties.html) for more details. In particular, certain default timeout values are infinite, and you may want to change that to avoid having a thread blocked by an unresponsive mail server, as shown in the following example: * Properties * YAML ```properties spring.mail.properties[mail.smtp.connectiontimeout]=5000 spring.mail.properties[mail.smtp.timeout]=3000 spring.mail.properties[mail.smtp.writetimeout]=5000 ``` ```yaml spring: mail: properties: "[mail.smtp.connectiontimeout]": 5000 "[mail.smtp.timeout]": 3000 "[mail.smtp.writetimeout]": 5000 ``` It is also possible to configure a [`JavaMailSender`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/mail/javamail/JavaMailSender.html) with an existing [`Session`](https://jakarta.ee/specifications/mail/2.1/apidocs/jakarta/mail/Session.html) from JNDI: * Properties * YAML ```properties spring.mail.jndi-name=mail/Session ``` ```yaml spring: mail: jndi-name: "mail/Session" ``` When a `jndi-name` is set, it takes precedence over all other Session-related settings. * [Spring Boot](../../index.html) * [4.1.1](email.html) * [4.0.8](../../4.0/reference/io/email.html) * [3.5.16](../../3.5/reference/io/email.html) * [3.4.13](../../3.4/reference/io/email.html) * [3.3.13](../../3.3/reference/io/email.html) - [4.2.0-M2](../../4.2/reference/io/email.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/io/email.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/io/email.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/io/email.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/class-use/LayeredSpec.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.bundling.LayeredSpec ========================================================== Packages that use [LayeredSpec](../LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Package Description [org.springframework.boot.gradle.tasks.bundling](#org.springframework.boot.gradle.tasks.bundling) Support for creating executable jars and wars. * ## Uses of [LayeredSpec](../LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling") in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) Methods in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) that return [LayeredSpec](../LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Modifier and Type Method Description `LayeredSpec` BootJar.`getLayered()` Returns the spec that describes the layers in a layered jar. `LayeredSpec` BootWar.`getLayered()` Returns the spec that describes the layers in a layered jar. Method parameters in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) with type arguments of type [LayeredSpec](../LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Modifier and Type Method Description `void` BootJar.`layered(Action action)` Configures the jar's layering using the given `action`. `void` BootWar.`layered(Action action)` Configures the war's layering using the given `action`. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/TestRunMojo.html ---- Uses of Class\ org.springframework.boot.maven.TestRunMojo ========================================== No usage of org.springframework.boot.maven.TestRunMojo ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/BuildInfoMojo.html ---- Uses of Class\ org.springframework.boot.maven.BuildInfoMojo ============================================ No usage of org.springframework.boot.maven.BuildInfoMojo ---- url: https://docs.spring.io/spring-boot/reference/web/servlet.html ---- # Servlet Web Applications If you want to build servlet-based web applications, you can take advantage of Spring Boot’s auto-configuration for Spring MVC or Jersey. ## [](#web.servlet.spring-mvc)The “Spring Web MVC Framework” The [Spring Web MVC framework](https://docs.spring.io/spring-framework/reference/7.0/web/webmvc.html) (often referred to as “Spring MVC”) is a rich “model view controller” web framework. Spring MVC lets you create special [`@Controller`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Controller.html) or [`@RestController`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/RestController.html) beans to handle incoming HTTP requests. Methods in your controller are mapped to HTTP by using [`@RequestMapping`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/RequestMapping.html) annotations. The following code shows a typical [`@RestController`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/RestController.html) that serves JSON data: * Java * Kotlin ```java import java.util.List; import org.springframework.web.bind.annotation.DeleteMapping; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController @RequestMapping("/users") public class MyRestController { private final UserRepository userRepository; private final CustomerRepository customerRepository; public MyRestController(UserRepository userRepository, CustomerRepository customerRepository) { this.userRepository = userRepository; this.customerRepository = customerRepository; } @GetMapping("/{userId}") public User getUser(@PathVariable Long userId) { return this.userRepository.findById(userId).get(); } @GetMapping("/{userId}/customers") public List getUserCustomers(@PathVariable Long userId) { return this.userRepository.findById(userId).map(this.customerRepository::findByUser).get(); } @DeleteMapping("/{userId}") public void deleteUser(@PathVariable Long userId) { this.userRepository.deleteById(userId); } } ``` ```kotlin import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController @RestController @RequestMapping("/users") class MyRestController(private val userRepository: UserRepository, private val customerRepository: CustomerRepository) { @GetMapping("/{userId}") fun getUser(@PathVariable userId: Long): User { return userRepository.findById(userId).get() } @GetMapping("/{userId}/customers") fun getUserCustomers(@PathVariable userId: Long): List { return userRepository.findById(userId).map(customerRepository::findByUser).get() } @DeleteMapping("/{userId}") fun deleteUser(@PathVariable userId: Long) { userRepository.deleteById(userId) } } ``` “WebMvc.fn”, the functional variant, separates the routing configuration from the actual handling of the requests, as shown in the following example: * Java * Kotlin ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.http.MediaType; import org.springframework.web.servlet.function.RequestPredicate; import org.springframework.web.servlet.function.RouterFunction; import org.springframework.web.servlet.function.ServerResponse; import static org.springframework.web.servlet.function.RequestPredicates.accept; import static org.springframework.web.servlet.function.RouterFunctions.route; @Configuration(proxyBeanMethods = false) public class MyRoutingConfiguration { private static final RequestPredicate ACCEPT_JSON = accept(MediaType.APPLICATION_JSON); @Bean public RouterFunction routerFunction(MyUserHandler userHandler) { return route() .GET("/{user}", ACCEPT_JSON, userHandler::getUser) .GET("/{user}/customers", ACCEPT_JSON, userHandler::getUserCustomers) .DELETE("/{user}", ACCEPT_JSON, userHandler::deleteUser) .build(); } } ``` ```kotlin import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.http.MediaType import org.springframework.web.servlet.function.RequestPredicates.accept import org.springframework.web.servlet.function.RouterFunction import org.springframework.web.servlet.function.RouterFunctions import org.springframework.web.servlet.function.ServerResponse @Configuration(proxyBeanMethods = false) class MyRoutingConfiguration { @Bean fun routerFunction(userHandler: MyUserHandler): RouterFunction { return RouterFunctions.route() .GET("/{user}", ACCEPT_JSON, userHandler::getUser) .GET("/{user}/customers", ACCEPT_JSON, userHandler::getUserCustomers) .DELETE("/{user}", ACCEPT_JSON, userHandler::deleteUser) .build() } companion object { private val ACCEPT_JSON = accept(MediaType.APPLICATION_JSON) } } ``` * Java * Kotlin ```java import org.springframework.stereotype.Component; import org.springframework.web.servlet.function.ServerRequest; import org.springframework.web.servlet.function.ServerResponse; @Component public class MyUserHandler { public ServerResponse getUser(ServerRequest request) { ... } public ServerResponse getUserCustomers(ServerRequest request) { ... } public ServerResponse deleteUser(ServerRequest request) { ... } } ``` ```kotlin import org.springframework.stereotype.Component import org.springframework.web.servlet.function.ServerRequest import org.springframework.web.servlet.function.ServerResponse @Component class MyUserHandler { fun getUser(request: ServerRequest?): ServerResponse { ... } fun getUserCustomers(request: ServerRequest?): ServerResponse { ... } fun deleteUser(request: ServerRequest?): ServerResponse { ... } } ``` Spring MVC is part of the core Spring Framework, and detailed information is available in the [reference documentation](https://docs.spring.io/spring-framework/reference/7.0/web/webmvc.html). There are also several guides that cover Spring MVC available at [spring.io/guides](https://spring.io/guides). | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can define as many [`RouterFunction`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/function/RouterFunction.html) beans as you like to modularize the definition of the router. Beans can be ordered if you need to apply a precedence. | ### [](#web.servlet.spring-mvc.auto-configuration)Spring MVC Auto-configuration Spring Boot provides auto-configuration for Spring MVC that works well with most applications. It replaces the need for [`@EnableWebMvc`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/config/annotation/EnableWebMvc.html) and the two cannot be used together. In addition to Spring MVC’s defaults, the auto-configuration provides the following features: * Inclusion of [`ContentNegotiatingViewResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/view/ContentNegotiatingViewResolver.html) and [`BeanNameViewResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/view/BeanNameViewResolver.html) beans. * Support for serving static resources, including support for WebJars (covered [later in this document](#web.servlet.spring-mvc.static-content)). * Automatic registration of [`Converter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/convert/converter/Converter.html), [`GenericConverter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/convert/converter/GenericConverter.html), and [`Formatter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/format/Formatter.html) beans. * Support for [`HttpMessageConverters`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/converter/HttpMessageConverters.html) (covered [later in this document](#web.servlet.spring-mvc.message-converters)). * Automatic registration of [`MessageCodesResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/validation/MessageCodesResolver.html) (covered [later in this document](#web.servlet.spring-mvc.message-codes)). * Static `index.html` support. * Automatic use of a [`ConfigurableWebBindingInitializer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/support/ConfigurableWebBindingInitializer.html) bean (covered [later in this document](#web.servlet.spring-mvc.binding-initializer)). If you want to keep those Spring Boot MVC customizations and make more [MVC customizations](https://docs.spring.io/spring-framework/reference/7.0/web/webmvc.html) (interceptors, formatters, view controllers, and other features), you can add your own [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class of type [`WebMvcConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.html) but **without** [`@EnableWebMvc`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/config/annotation/EnableWebMvc.html). If you want to provide custom instances of [`RequestMappingHandlerMapping`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/mvc/method/annotation/RequestMappingHandlerMapping.html), [`RequestMappingHandlerAdapter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/mvc/method/annotation/RequestMappingHandlerAdapter.html), or [`ExceptionHandlerExceptionResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/mvc/method/annotation/ExceptionHandlerExceptionResolver.html), and still keep the Spring Boot MVC customizations, you can declare a bean of type [`WebMvcRegistrations`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/autoconfigure/WebMvcRegistrations.html) and use it to provide custom instances of those components. The custom instances will be subject to further initialization and configuration by Spring MVC. To participate in, and if desired, override that subsequent processing, a [`WebMvcConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.html) should be used. If you do not want to use the auto-configuration and want to take complete control of Spring MVC, add your own [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) annotated with [`@EnableWebMvc`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/config/annotation/EnableWebMvc.html). Alternatively, add your own [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html)-annotated [`DelegatingWebMvcConfiguration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/config/annotation/DelegatingWebMvcConfiguration.html) as described in the [`@EnableWebMvc`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/config/annotation/EnableWebMvc.html) API documentation. ### [](#web.servlet.spring-mvc.conversion-service)Spring MVC Conversion Service Spring MVC uses a different [`ConversionService`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/convert/ConversionService.html) to the one used to convert values from your `application.properties` or `application.yaml` file. It means that [`Period`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Period.html), [`Duration`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html) and [`DataSize`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/util/unit/DataSize.html) converters are not available and that [`@DurationUnit`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/convert/DurationUnit.html) and [`@DataSizeUnit`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/convert/DataSizeUnit.html) annotations will be ignored. If you want to customize the [`ConversionService`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/convert/ConversionService.html) used by Spring MVC, you can provide a [`WebMvcConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.html) bean with an `addFormatters` method. From this method you can register any converter that you like, or you can delegate to the static methods available on [`ApplicationConversionService`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/convert/ApplicationConversionService.html). Conversion can also be customized using the `spring.mvc.format.*` configuration properties. When not configured, the following defaults are used: | Property | `DateTimeFormatter` | Formats | | ----------------------------- | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `spring.mvc.format.date` | `ofLocalizedDate(FormatStyle.SHORT)` | `java.util.Date` and [`LocalDate`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/LocalDate.html) | | `spring.mvc.format.time` | `ofLocalizedTime(FormatStyle.SHORT)` | java.time’s [`LocalTime`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/LocalTime.html) and [`OffsetTime`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/OffsetTime.html) | | `spring.mvc.format.date-time` | `ofLocalizedDateTime(FormatStyle.SHORT)` | java.time’s [`LocalDateTime`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/LocalDateTime.html), [`OffsetDateTime`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/OffsetDateTime.html), and [`ZonedDateTime`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/ZonedDateTime.html) | ### [](#web.servlet.spring-mvc.message-converters)HttpMessageConverters Spring MVC uses the [`HttpMessageConverter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/converter/HttpMessageConverter.html) interface to convert HTTP requests and responses. Sensible defaults are included out of the box. For example, objects can be automatically converted to JSON (by using the Jackson library) or XML (by using the Jackson XML extension, if available, or by using JAXB if the Jackson XML extension is not available). By default, strings are encoded in `UTF-8`. Any [`HttpMessageConverter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/converter/HttpMessageConverter.html) bean that is present in the context is added to the list of converters. You can also override default converters in the same way. If you need to add or customize converters, you can declare one or more [`ClientHttpMessageConvertersCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/http/converter/autoconfigure/ClientHttpMessageConvertersCustomizer.html) or [`ServerHttpMessageConvertersCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/http/converter/autoconfigure/ServerHttpMessageConvertersCustomizer.html) as beans. There, you can choose whether converter instances should be added before default ones (`addCustomConverter`) or if they should override a specific default converter (like `withJsonConverter`). See the following listing for an example: * Java * Kotlin ```java import java.text.SimpleDateFormat; import tools.jackson.databind.json.JsonMapper; import org.springframework.boot.http.converter.autoconfigure.ClientHttpMessageConvertersCustomizer; import org.springframework.boot.http.converter.autoconfigure.ServerHttpMessageConvertersCustomizer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.http.converter.HttpMessageConverters.ClientBuilder; import org.springframework.http.converter.HttpMessageConverters.ServerBuilder; import org.springframework.http.converter.json.JacksonJsonHttpMessageConverter; @Configuration(proxyBeanMethods = false) public class MyHttpMessageConvertersConfiguration { @Bean public ClientHttpMessageConvertersCustomizer myClientConvertersCustomizer() { return (clientBuilder) -> clientBuilder.addCustomConverter(new AdditionalHttpMessageConverter()) .addCustomConverter(new AnotherHttpMessageConverter()); } @Bean public JacksonConverterCustomizer jacksonConverterCustomizer() { JsonMapper jsonMapper = JsonMapper.builder().defaultDateFormat(new SimpleDateFormat("yyyy-MM")).build(); return new JacksonConverterCustomizer(jsonMapper); } // contribute a custom JSON converter to both client and server static class JacksonConverterCustomizer implements ClientHttpMessageConvertersCustomizer, ServerHttpMessageConvertersCustomizer { private final JsonMapper jsonMapper; JacksonConverterCustomizer(JsonMapper jsonMapper) { this.jsonMapper = jsonMapper; } @Override public void customize(ClientBuilder builder) { builder.withJsonConverter(new JacksonJsonHttpMessageConverter(this.jsonMapper)); } @Override public void customize(ServerBuilder builder) { builder.withJsonConverter(new JacksonJsonHttpMessageConverter(this.jsonMapper)); } } } ``` ```kotlin import org.springframework.boot.http.converter.autoconfigure.ClientHttpMessageConvertersCustomizer import org.springframework.boot.http.converter.autoconfigure.ServerHttpMessageConvertersCustomizer import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.http.converter.HttpMessageConverters import org.springframework.http.converter.json.JacksonJsonHttpMessageConverter import tools.jackson.databind.json.JsonMapper import java.text.SimpleDateFormat @Configuration(proxyBeanMethods = false) class MyHttpMessageConvertersConfiguration { @Bean fun myClientConvertersCustomizer(): ClientHttpMessageConvertersCustomizer { return ClientHttpMessageConvertersCustomizer { clientBuilder: HttpMessageConverters.ClientBuilder -> clientBuilder .addCustomConverter(AdditionalHttpMessageConverter()) .addCustomConverter(AnotherHttpMessageConverter()) } } @Bean fun jacksonConverterCustomizer(): JacksonConverterCustomizer { val jsonMapper = JsonMapper.builder() .defaultDateFormat(SimpleDateFormat("yyyy-MM")) .build() return JacksonConverterCustomizer(jsonMapper) } // contribute a custom JSON converter to both client and server class JacksonConverterCustomizer(private val jsonMapper: JsonMapper) : ClientHttpMessageConvertersCustomizer, ServerHttpMessageConvertersCustomizer { override fun customize(builder: HttpMessageConverters.ClientBuilder) { builder.withJsonConverter(JacksonJsonHttpMessageConverter(this.jsonMapper)) } override fun customize(builder: HttpMessageConverters.ServerBuilder) { builder.withJsonConverter(JacksonJsonHttpMessageConverter(this.jsonMapper)) } } } ``` ### [](#web.servlet.spring-mvc.message-codes)MessageCodesResolver Spring MVC has a strategy for generating error codes for rendering error messages from binding errors: [`MessageCodesResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/validation/MessageCodesResolver.html). If you set the `spring.mvc.message-codes-resolver-format` property `PREFIX_ERROR_CODE` or `POSTFIX_ERROR_CODE`, Spring Boot creates one for you (see the enumeration in [`DefaultMessageCodesResolver.Format`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/validation/DefaultMessageCodesResolver.Format.html)). ### [](#web.servlet.spring-mvc.static-content)Static Content By default, Spring Boot serves static content from a directory called `/static` (or `/public` or `/resources` or `/META-INF/resources`) in the classpath or from the root of the [`ServletContext`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/ServletContext.html). It uses the [`ResourceHttpRequestHandler`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/resource/ResourceHttpRequestHandler.html) from Spring MVC so that you can modify that behavior by adding your own [`WebMvcConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.html) and overriding the `addResourceHandlers` method. In a stand-alone web application, the default servlet from the container is not enabled. It can be enabled using the `server.servlet.register-default-servlet` property. The default servlet acts as a fallback, serving content from the root of the [`ServletContext`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/ServletContext.html) if Spring decides not to handle it. Most of the time, this does not happen (unless you modify the default MVC configuration), because Spring can always handle requests through the [`DispatcherServlet`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/DispatcherServlet.html). By default, resources are mapped on `/**`, but you can tune that with the `spring.mvc.static-path-pattern` property. For instance, relocating all resources to `/resources/**` can be achieved as follows: * Properties * YAML ```properties spring.mvc.static-path-pattern=/resources/** ``` ```yaml spring: mvc: static-path-pattern: "/resources/**" ``` You can also customize the static resource locations by using the `spring.web.resources.static-locations` property (replacing the default values with a list of directory locations). The root servlet context path, `"/"`, is automatically added as a location as well. In addition to the “standard” static resource locations mentioned earlier, a special case is made for [Webjars content](https://www.webjars.org/). By default, any resources with a path in `/webjars/**` are served from jar files if they are packaged in the Webjars format. The path can be customized with the `spring.mvc.webjars-path-pattern` property. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Do not use the `src/main/webapp` directory if your application is packaged as a jar. Although this directory is a common standard, it works **only** with war packaging, and it is silently ignored by most build tools if you generate a jar. | Spring Boot also supports the advanced resource handling features provided by Spring MVC, allowing use cases such as cache-busting static resources or using version agnostic URLs for Webjars. To use version agnostic URLs for Webjars, add the `org.webjars:webjars-locator-lite` dependency. Then declare your Webjar. Using jQuery as an example, adding `"/webjars/jquery/jquery.min.js"` results in `"/webjars/jquery/x.y.z/jquery.min.js"` where `x.y.z` is the Webjar version. To use cache busting, the following configuration configures a cache busting solution for all static resources, effectively adding a content hash, such as ``, in URLs: * Properties * YAML ```properties spring.web.resources.chain.strategy.content.enabled=true spring.web.resources.chain.strategy.content.paths=/** ``` ```yaml spring: web: resources: chain: strategy: content: enabled: true paths: "/**" ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Links to resources are rewritten in templates at runtime, thanks to a [`ResourceUrlEncodingFilter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/resource/ResourceUrlEncodingFilter.html) that is auto-configured for Thymeleaf and FreeMarker. You should manually declare this filter when using JSPs. Other template engines are currently not automatically supported but can be with custom template macros/helpers and the use of the [`ResourceUrlProvider`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/resource/ResourceUrlProvider.html). | When loading resources dynamically with, for example, a JavaScript module loader, renaming files is not an option. That is why other strategies are also supported and can be combined. A "fixed" strategy adds a static version string in the URL without changing the file name, as shown in the following example: * Properties * YAML ```properties spring.web.resources.chain.strategy.content.enabled=true spring.web.resources.chain.strategy.content.paths=/** spring.web.resources.chain.strategy.fixed.enabled=true spring.web.resources.chain.strategy.fixed.paths=/js/lib/ spring.web.resources.chain.strategy.fixed.version=v12 ``` ```yaml spring: web: resources: chain: strategy: content: enabled: true paths: "/**" fixed: enabled: true paths: "/js/lib/" version: "v12" ``` With this configuration, JavaScript modules located under `"/js/lib/"` use a fixed versioning strategy (`"/v12/js/lib/mymodule.js"`), while other resources still use the content one (``). See [`WebProperties.Resources`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/web/WebProperties.Resources.html) for more supported options. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | This feature has been thoroughly described in a dedicated [blog post](https://spring.io/blog/2014/07/24/spring-framework-4-1-handling-static-web-resources) and in Spring Framework’s [reference documentation](https://docs.spring.io/spring-framework/reference/7.0/web/webmvc/mvc-config/static-resources.html). | ### [](#web.servlet.spring-mvc.welcome-page)Welcome Page Spring Boot supports both static and templated welcome pages. It first looks for an `index.html` file in the configured static content locations. If one is not found, it then looks for an `index` template. If either is found, it is automatically used as the welcome page of the application. This only acts as a fallback for actual index routes defined by the application. The ordering is defined by the order of [`HandlerMapping`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/HandlerMapping.html) beans which is by default the following: | | | | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `RouterFunctionMapping` | Endpoints declared with [`RouterFunction`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/function/RouterFunction.html) beans | | `RequestMappingHandlerMapping` | Endpoints declared in [`@Controller`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Controller.html) beans | | `WelcomePageHandlerMapping` | The welcome page support | ### [](#web.servlet.spring-mvc.favicon)Custom Favicon As with other static resources, Spring Boot checks for a `favicon.ico` in the configured static content locations. If such a file is present, it is automatically used as the favicon of the application. ### [](#web.servlet.spring-mvc.content-negotiation)Path Matching and Content Negotiation Spring MVC can map incoming HTTP requests to handlers by looking at the request path and matching it to the mappings defined in your application (for example, [`@GetMapping`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/GetMapping.html) annotations on Controller methods). Spring Boot chooses to disable suffix pattern matching by default, which means that requests like `"GET /projects/spring-boot.json"` will not be matched to `@GetMapping("/projects/spring-boot")` mappings. This is considered as a [best practice for Spring MVC applications](https://docs.spring.io/spring-framework/reference/7.0/web/webmvc/mvc-controller/ann-requestmapping.html#mvc-ann-requestmapping-suffix-pattern-match). This feature was mainly useful in the past for HTTP clients which did not send proper "Accept" request headers; we needed to make sure to send the correct Content Type to the client. Nowadays, Content Negotiation is much more reliable. There are other ways to deal with HTTP clients that do not consistently send proper "Accept" request headers. Instead of using suffix matching, we can use a query parameter to ensure that requests like `"GET /projects/spring-boot?format=json"` will be mapped to `@GetMapping("/projects/spring-boot")`: * Properties * YAML ```properties spring.mvc.contentnegotiation.favor-parameter=true ``` ```yaml spring: mvc: contentnegotiation: favor-parameter: true ``` Or if you prefer to use a different parameter name: * Properties * YAML ```properties spring.mvc.contentnegotiation.favor-parameter=true spring.mvc.contentnegotiation.parameter-name=myparam ``` ```yaml spring: mvc: contentnegotiation: favor-parameter: true parameter-name: "myparam" ``` Most standard media types are supported out-of-the-box, but you can also define new ones: * Properties * YAML ```properties spring.mvc.contentnegotiation.media-types.markdown=text/markdown ``` ```yaml spring: mvc: contentnegotiation: media-types: markdown: "text/markdown" ``` As of Spring Framework 5.3, Spring MVC supports two strategies for matching request paths to controllers. By default, Spring Boot uses the [`PathPatternParser`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/util/pattern/PathPatternParser.html) strategy. [`PathPatternParser`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/util/pattern/PathPatternParser.html) is an [optimized implementation](https://spring.io/blog/2020/06/30/url-matching-with-pathpattern-in-spring-mvc) but comes with some restrictions compared to the [`AntPathMatcher`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/util/AntPathMatcher.html) strategy. [`PathPatternParser`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/util/pattern/PathPatternParser.html) restricts usage of [some path pattern variants](https://docs.spring.io/spring-framework/reference/7.0/web/webmvc/mvc-controller/ann-requestmapping.html#mvc-ann-requestmapping-uri-templates). It is also incompatible with configuring the [`DispatcherServlet`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/DispatcherServlet.html) with a path prefix (`spring.mvc.servlet.path`). The strategy can be configured using the `spring.mvc.pathmatch.matching-strategy` configuration property, as shown in the following example: * Properties * YAML ```properties spring.mvc.pathmatch.matching-strategy=ant-path-matcher ``` ```yaml spring: mvc: pathmatch: matching-strategy: "ant-path-matcher" ``` Spring MVC will throw a [`NoHandlerFoundException`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/NoHandlerFoundException.html) if a handler is not found for a request. Note that, by default, the [serving of static content](#web.servlet.spring-mvc.static-content) is mapped to `/**` and will, therefore, provide a handler for all requests. If no static content is available, [`ResourceHttpRequestHandler`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/resource/ResourceHttpRequestHandler.html) will throw a [`NoResourceFoundException`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/resource/NoResourceFoundException.html). For a [`NoHandlerFoundException`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/NoHandlerFoundException.html) to be thrown, set `spring.mvc.static-path-pattern` to a more specific value such as `/resources/**` or set `spring.web.resources.add-mappings` to `false` to disable serving of static content entirely. ### [](#web.servlet.spring-mvc.binding-initializer)ConfigurableWebBindingInitializer Spring MVC uses a [`WebBindingInitializer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/support/WebBindingInitializer.html) to initialize a [`WebDataBinder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/WebDataBinder.html) for a particular request. If you create your own [`ConfigurableWebBindingInitializer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/support/ConfigurableWebBindingInitializer.html) [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html), Spring Boot automatically configures Spring MVC to use it. ### [](#web.servlet.spring-mvc.template-engines)Template Engines As well as REST web services, you can also use Spring MVC to serve dynamic HTML content. Spring MVC supports a variety of templating technologies, including Thymeleaf, FreeMarker, and JSPs. Also, many other templating engines include their own Spring MVC integrations. Spring Boot includes auto-configuration support for the following templating engines: * [FreeMarker](https://freemarker.apache.org/docs/) * [Groovy](https://docs.groovy-lang.org/docs/next/html/documentation/template-engines.html#_the_markuptemplateengine) * [Thymeleaf](https://www.thymeleaf.org) * [Mustache](https://mustache.github.io/) | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If possible, JSPs should be avoided. There are several [known limitations](#web.servlet.embedded-container.jsp-limitations) when using them with embedded servlet containers. | When you use one of these templating engines with the default configuration, your templates are picked up automatically from `src/main/resources/templates`. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Depending on how you run your application, your IDE may order the classpath differently. Running your application in the IDE from its main method results in a different ordering than when you run your application by using Maven or Gradle or from its packaged jar. This can cause Spring Boot to fail to find the expected template. If you have this problem, you can reorder the classpath in the IDE to place the module’s classes and resources first. | ### [](#web.servlet.spring-mvc.error-handling)Error Handling By default, Spring Boot provides an `/error` mapping that handles all errors in a sensible way, and it is registered as a “global” error page in the servlet container. For machine clients, it produces a JSON response with details of the error, the HTTP status, and the exception message. For browser clients, there is a “whitelabel” error view that renders the same data in HTML format (to customize it, add a [`View`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/View.html) that resolves to `error`). There are a number of `spring.web.error` properties that can be set if you want to customize the default error handling behavior. See the [Web Properties](../../appendix/application-properties/index.html#appendix.application-properties.web) section of the Appendix. To replace the default behavior completely, you can implement [`ErrorController`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/error/ErrorController.html) and register a bean definition of that type or add a bean of type [`ErrorAttributes`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/error/ErrorAttributes.html) to use the existing mechanism but replace the contents. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The [`BasicErrorController`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/autoconfigure/error/BasicErrorController.html) can be used as a base class for a custom [`ErrorController`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/error/ErrorController.html). This is particularly useful if you want to add a handler for a new content type (the default is to handle `text/html` specifically and provide a fallback for everything else). To do so, extend [`BasicErrorController`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/autoconfigure/error/BasicErrorController.html), add a public method with a [`@RequestMapping`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/RequestMapping.html) that has a `produces` attribute, and create a bean of your new type. | As of Spring Framework 6.0, [RFC 9457 Problem Details](https://docs.spring.io/spring-framework/reference/7.0/web/webmvc/mvc-ann-rest-exceptions.html) is supported. Spring MVC can produce custom error messages with the `application/problem+json` media type, like: ```json { "type": "https://example.org/problems/unknown-project", "title": "Unknown project", "status": 404, "detail": "No project found for id 'spring-unknown'", "instance": "/projects/spring-unknown" } ``` This support can be enabled by setting `spring.mvc.problemdetails.enabled` to `true`. You can also define a class annotated with [`@ControllerAdvice`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/ControllerAdvice.html) to customize the JSON document to return for a particular controller and/or exception type, as shown in the following example: * Java * Kotlin ```java import jakarta.servlet.RequestDispatcher; import jakarta.servlet.http.HttpServletRequest; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.ControllerAdvice; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.ResponseBody; import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler; @ControllerAdvice(basePackageClasses = SomeController.class) public class MyControllerAdvice extends ResponseEntityExceptionHandler { @ResponseBody @ExceptionHandler(MyException.class) public ResponseEntity handleControllerException(HttpServletRequest request, Throwable ex) { HttpStatus status = getStatus(request); return new ResponseEntity<>(new MyErrorBody(status.value(), ex.getMessage()), status); } private HttpStatus getStatus(HttpServletRequest request) { Integer code = (Integer) request.getAttribute(RequestDispatcher.ERROR_STATUS_CODE); HttpStatus status = HttpStatus.resolve(code); return (status != null) ? status : HttpStatus.INTERNAL_SERVER_ERROR; } } ``` ```kotlin import jakarta.servlet.RequestDispatcher import jakarta.servlet.http.HttpServletRequest import org.springframework.http.HttpStatus import org.springframework.http.ResponseEntity import org.springframework.web.bind.annotation.ControllerAdvice import org.springframework.web.bind.annotation.ExceptionHandler import org.springframework.web.bind.annotation.ResponseBody import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler @ControllerAdvice(basePackageClasses = [SomeController::class]) class MyControllerAdvice : ResponseEntityExceptionHandler() { @ResponseBody @ExceptionHandler(MyException::class) fun handleControllerException(request: HttpServletRequest, ex: Throwable): ResponseEntity<*> { val status = getStatus(request) return ResponseEntity(MyErrorBody(status.value(), ex.message), status) } private fun getStatus(request: HttpServletRequest): HttpStatus { val code = request.getAttribute(RequestDispatcher.ERROR_STATUS_CODE) as Int val status = HttpStatus.resolve(code) return status ?: HttpStatus.INTERNAL_SERVER_ERROR } } ``` In the preceding example, if `MyException` is thrown by a controller defined in the same package as `SomeController`, a JSON representation of the `MyErrorBody` POJO is used instead of the [`ErrorAttributes`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/error/ErrorAttributes.html) representation. In some cases, errors handled at the controller level are not recorded by web observations or the [metrics infrastructure](../actuator/metrics.html#actuator.metrics.supported.spring-mvc). Applications can ensure that such exceptions are recorded with the observations by [setting the handled exception on the observation context](https://docs.spring.io/spring-framework/reference/7.0/integration/observability.html#observability.http-server.servlet). #### [](#web.servlet.spring-mvc.error-handling.error-pages)Custom Error Pages If you want to display a custom HTML error page for a given status code, you can add a file to an `/error` directory. Error pages can either be static HTML (that is, added under any of the static resource directories) or be built by using templates. The name of the file should be the exact status code or a series mask. For example, to map `404` to a static HTML file, your directory structure would be as follows: ```none src/ +- main/ +- java/ | + +- resources/ +- public/ +- error/ | +- 404.html +- ``` To map all `5xx` errors by using a FreeMarker template, your directory structure would be as follows: ```none src/ +- main/ +- java/ | + +- resources/ +- templates/ +- error/ | +- 5xx.ftlh +- ``` For more complex mappings, you can also add beans that implement the [`ErrorViewResolver`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/autoconfigure/error/ErrorViewResolver.html) interface, as shown in the following example: * Java * Kotlin ```java import java.util.Map; import jakarta.servlet.http.HttpServletRequest; import org.springframework.boot.webmvc.autoconfigure.error.ErrorViewResolver; import org.springframework.http.HttpStatus; import org.springframework.web.servlet.ModelAndView; public class MyErrorViewResolver implements ErrorViewResolver { @Override public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status, Map model) { // Use the request or status to optionally return a ModelAndView if (status == HttpStatus.INSUFFICIENT_STORAGE) { // We could add custom model values here return new ModelAndView("myview"); } return null; } } ``` ```kotlin import jakarta.servlet.http.HttpServletRequest import org.springframework.boot.webmvc.autoconfigure.error.ErrorViewResolver import org.springframework.http.HttpStatus import org.springframework.web.servlet.ModelAndView class MyErrorViewResolver : ErrorViewResolver { override fun resolveErrorView(request: HttpServletRequest, status: HttpStatus, model: Map): ModelAndView? { // Use the request or status to optionally return a ModelAndView if (status == HttpStatus.INSUFFICIENT_STORAGE) { // We could add custom model values here return ModelAndView("myview") } return null } } ``` You can also use regular Spring MVC features such as [`@ExceptionHandler` methods](https://docs.spring.io/spring-framework/reference/7.0/web/webmvc/mvc-servlet/exceptionhandlers.html) and [`@ControllerAdvice`](https://docs.spring.io/spring-framework/reference/7.0/web/webmvc/mvc-controller/ann-advice.html). The [`ErrorController`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webmvc/error/ErrorController.html) then picks up any unhandled exceptions. #### [](#web.servlet.spring-mvc.error-handling.error-pages-without-spring-mvc)Mapping Error Pages Outside of Spring MVC For applications that do not use Spring MVC, you can use the [`ErrorPageRegistrar`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/error/ErrorPageRegistrar.html) interface to directly register [`ErrorPage`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/error/ErrorPage.html) instances. This abstraction works directly with the underlying embedded servlet container and works even if you do not have a Spring MVC [`DispatcherServlet`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/DispatcherServlet.html). * Java * Kotlin ```java import org.springframework.boot.web.error.ErrorPage; import org.springframework.boot.web.error.ErrorPageRegistrar; import org.springframework.boot.web.error.ErrorPageRegistry; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.http.HttpStatus; @Configuration(proxyBeanMethods = false) public class MyErrorPagesConfiguration { @Bean public ErrorPageRegistrar errorPageRegistrar() { return this::registerErrorPages; } private void registerErrorPages(ErrorPageRegistry registry) { registry.addErrorPages(new ErrorPage(HttpStatus.BAD_REQUEST, "/400")); } } ``` ```kotlin import org.springframework.boot.web.error.ErrorPage import org.springframework.boot.web.error.ErrorPageRegistrar import org.springframework.boot.web.error.ErrorPageRegistry import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.http.HttpStatus @Configuration(proxyBeanMethods = false) class MyErrorPagesConfiguration { @Bean fun errorPageRegistrar(): ErrorPageRegistrar { return ErrorPageRegistrar { registry: ErrorPageRegistry -> registerErrorPages(registry) } } private fun registerErrorPages(registry: ErrorPageRegistry) { registry.addErrorPages(ErrorPage(HttpStatus.BAD_REQUEST, "/400")) } } ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you register an [`ErrorPage`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/error/ErrorPage.html) with a path that ends up being handled by a [`Filter`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Filter.html) (as is common with some non-Spring web frameworks, like Jersey and Wicket), then the [`Filter`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Filter.html) has to be explicitly registered as an `ERROR` dispatcher, as shown in the following example: | * Java * Kotlin ```java import java.util.EnumSet; import jakarta.servlet.DispatcherType; import org.springframework.boot.web.servlet.FilterRegistrationBean; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyFilterConfiguration { @Bean public FilterRegistrationBean myFilter() { FilterRegistrationBean registration = new FilterRegistrationBean<>(new MyFilter()); // ... registration.setDispatcherTypes(EnumSet.allOf(DispatcherType.class)); return registration; } } ``` ```kotlin import jakarta.servlet.DispatcherType import org.springframework.boot.web.servlet.FilterRegistrationBean import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import java.util.EnumSet @Configuration(proxyBeanMethods = false) class MyFilterConfiguration { @Bean fun myFilter(): FilterRegistrationBean { val registration = FilterRegistrationBean(MyFilter()) // ... registration.setDispatcherTypes(EnumSet.allOf(DispatcherType::class.java)) return registration } } ``` Note that the default [`FilterRegistrationBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/FilterRegistrationBean.html) does not include the `ERROR` dispatcher type. #### [](#web.servlet.spring-mvc.error-handling.in-a-war-deployment)Error Handling in a WAR Deployment When deployed to a servlet container, Spring Boot uses its error page filter to forward a request with an error status to the appropriate error page. This is necessary as the servlet specification does not provide an API for registering error pages. Depending on the container that you are deploying your war file to and the technologies that your application uses, some additional configuration may be required. The error page filter can only forward the request to the correct error page if the response has not already been committed. By default, WebSphere Application Server 8.0 and later commits the response upon successful completion of a servlet’s service method. You should disable this behavior by setting `com.ibm.ws.webcontainer.invokeFlushAfterService` to `false`. ### [](#web.servlet.spring-mvc.cors)CORS Support [Cross-origin resource sharing](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) (CORS) is a [W3C specification](https://www.w3.org/TR/cors/) implemented by [most browsers](https://caniuse.com/#feat=cors) that lets you specify in a flexible way what kind of cross-domain requests are authorized, instead of using some less secure and less powerful approaches such as IFRAME or JSONP. As of version 4.2, Spring MVC [supports CORS](https://docs.spring.io/spring-framework/reference/7.0/web/webmvc-cors.html). Using [controller method CORS configuration](https://docs.spring.io/spring-framework/reference/7.0/web/webmvc-cors.html#mvc-cors-controller) with [`@CrossOrigin`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/CrossOrigin.html) annotations in your Spring Boot application does not require any specific configuration. [Global CORS configuration](https://docs.spring.io/spring-framework/reference/7.0/web/webmvc-cors.html#mvc-cors-global) can be defined by registering a [`WebMvcConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.html) bean with a customized `addCorsMappings(CorsRegistry)` method, as shown in the following example: * Java * Kotlin ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.CorsRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; @Configuration(proxyBeanMethods = false) public class MyCorsConfiguration { @Bean public WebMvcConfigurer corsConfigurer() { return new WebMvcConfigurer() { @Override public void addCorsMappings(CorsRegistry registry) { registry.addMapping("/api/**"); } }; } } ``` ```kotlin import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.web.servlet.config.annotation.CorsRegistry import org.springframework.web.servlet.config.annotation.WebMvcConfigurer @Configuration(proxyBeanMethods = false) class MyCorsConfiguration { @Bean fun corsConfigurer(): WebMvcConfigurer { return object : WebMvcConfigurer { override fun addCorsMappings(registry: CorsRegistry) { registry.addMapping("/api/**") } } } } ``` ### [](#web.servlet.spring-mvc.api-versioning)API Versioning Spring MVC supports API versioning which can be used to evolve an HTTP API over time. The same `@Controller` path can be mapped multiple times to support different versions of the API. For more details see [Spring Framework’s reference documentation](https://docs.spring.io/spring-framework/reference/7.0/web/webmvc/mvc-controller/ann-requestmapping.html#mvc-ann-requestmapping-version). Once mappings have been added, you additionally need to configure Spring MVC so that it is able to use any version information sent with a request. Typically, versions are sent as HTTP headers, query parameters, media type parameters, or as part of the path. To configure Spring MVC, you can either use a [`WebMvcConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.html) bean and override the `configureApiVersioning(…​)` method, or you can use properties. For example, the following will use an `X-Version` HTTP header to obtain version information and default to `1.0.0` when no header is sent. * Properties * YAML ```properties spring.mvc.apiversion.default=1.0.0 spring.mvc.apiversion.use.header=X-Version ``` ```yaml spring: mvc: apiversion: default: 1.0.0 use: header: X-Version ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If your setup requires multiple strategies, such as header and query parameter, consider declaring the order programmatically by overriding the `configureApiVersioning` method. | For more complete control, you can also define [`ApiVersionResolver`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/accept/ApiVersionResolver.html), [`ApiVersionParser`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/accept/ApiVersionParser.html) and [`ApiVersionDeprecationHandler`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/accept/ApiVersionDeprecationHandler.html) beans which will be injected into the auto-configured Spring MVC configuration. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | API versioning is also supported with both `WebClient` and `RestClient`. See [API Versioning](../io/rest-client.html#io.rest-client.apiversioning) for details. | ## [](#web.servlet.jersey)JAX-RS and Jersey If you prefer the JAX-RS programming model for REST endpoints, you can use one of the available implementations instead of Spring MVC. [Jersey](https://jersey.github.io/) and [Apache CXF](https://cxf.apache.org/) work quite well out of the box. CXF requires you to register its [`Servlet`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Servlet.html) or [`Filter`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Filter.html) as a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) in your application context. Jersey has some native Spring support, so we also provide auto-configuration support for it in Spring Boot, together with a starter. To get started with Jersey, include the `spring-boot-starter-jersey` as a dependency and then you need one [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) of type [`ResourceConfig`](https://javadoc.io/doc/org.glassfish.jersey.core/jersey-server/4.0.2/org/glassfish/jersey/server/ResourceConfig.html) in which you register all the endpoints, as shown in the following example: * Java * Kotlin ```java import org.glassfish.jersey.server.ResourceConfig; import org.springframework.stereotype.Component; @Component public class MyJerseyConfig extends ResourceConfig { public MyJerseyConfig() { register(MyEndpoint.class); } } ``` ```kotlin import org.glassfish.jersey.server.ResourceConfig import org.springframework.stereotype.Component @Component class MyJerseyConfig : ResourceConfig() { init { register(MyEndpoint::class.java) } } ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Jersey’s support for scanning executable archives is rather limited. For example, it cannot scan for endpoints in a package found in a [fully executable jar file](../../how-to/deployment/installing.html) or in `WEB-INF/classes` when running an executable war file. To avoid this limitation, the `packages` method should not be used, and endpoints should be registered individually by using the `register` method, as shown in the preceding example. | For more advanced customizations, you can also register an arbitrary number of beans that implement [`ResourceConfigCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jersey/autoconfigure/ResourceConfigCustomizer.html). All the registered endpoints should be a [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html) with HTTP resource annotations (`@GET` and others), as shown in the following example: * Java * Kotlin ```java import jakarta.ws.rs.GET; import jakarta.ws.rs.Path; import org.springframework.stereotype.Component; @Component @Path("/hello") public class MyEndpoint { @GET public String message() { return "Hello"; } } ``` ```kotlin import jakarta.ws.rs.GET import jakarta.ws.rs.Path import org.springframework.stereotype.Component @Component @Path("/hello") class MyEndpoint { @GET fun message(): String { return "Hello" } } ``` Since the [`@Endpoint`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/Endpoint.html) is a Spring [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html), its lifecycle is managed by Spring and you can use the [`@Autowired`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Autowired.html) annotation to inject dependencies and use the [`@Value`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Value.html) annotation to inject external configuration. By default, the Jersey servlet is registered and mapped to `/*`. You can change the mapping by adding [`@ApplicationPath`](https://jakarta.ee/specifications/restful-ws/4.0/apidocs/jakarta/ws/rs/ApplicationPath.html) to your [`ResourceConfig`](https://javadoc.io/doc/org.glassfish.jersey.core/jersey-server/4.0.2/org/glassfish/jersey/server/ResourceConfig.html). By default, Jersey is set up as a servlet in a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) of type [`ServletRegistrationBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/ServletRegistrationBean.html) named `jerseyServletRegistration`. By default, the servlet is initialized lazily, but you can customize that behavior by setting `spring.jersey.servlet.load-on-startup`. You can disable or override that bean by creating one of your own with the same name. You can also use a filter instead of a servlet by setting `spring.jersey.type=filter` (in which case, the [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) to replace or override is `jerseyFilterRegistration`). The filter has an [`@Order`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/annotation/Order.html), which you can set with `spring.jersey.filter.order`. When using Jersey as a filter, a servlet that will handle any requests that are not intercepted by Jersey must be present. If your application does not contain such a servlet, you may want to enable the default servlet by setting `server.servlet.register-default-servlet` to `true`. Both the servlet and the filter registrations can be given init parameters by using `spring.jersey.init.*` to specify a map of properties. ## [](#web.servlet.embedded-container)Embedded Servlet Container Support For servlet application, Spring Boot includes support for embedded [Tomcat](https://tomcat.apache.org/) and [Jetty](https://www.eclipse.org/jetty/) servers. Most developers use the appropriate starter to obtain a fully configured instance. By default, the embedded server listens for HTTP requests on port `8080`. ### [](#web.servlet.embedded-container.servlets-filters-listeners)Servlets, Filters, and Listeners When using an embedded servlet container, you can register servlets, filters, and all the listeners (such as [`HttpSessionListener`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/http/HttpSessionListener.html)) from the servlet spec, either by using Spring beans or by scanning for servlet components. #### [](#web.servlet.embedded-container.servlets-filters-listeners.beans)Registering Servlets, Filters, and Listeners as Spring Beans Any [`Servlet`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Servlet.html), [`Filter`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Filter.html), or servlet `*Listener` instance that is a Spring bean is registered with the embedded container. This can be particularly convenient if you want to refer to a value from your `application.properties` during configuration. By default, if the context contains only a single Servlet, it is mapped to `/`. In the case of multiple servlet beans, the bean name is used as a path prefix. Filters map to `/*`. If convention-based mapping is not flexible enough, you can use the [`ServletRegistrationBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/ServletRegistrationBean.html), [`FilterRegistrationBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/FilterRegistrationBean.html), and [`ServletListenerRegistrationBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/ServletListenerRegistrationBean.html) classes for complete control. If you prefer annotations over [`ServletRegistrationBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/ServletRegistrationBean.html) and [`FilterRegistrationBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/FilterRegistrationBean.html), you can also use [`@ServletRegistration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/ServletRegistration.html) and [`@FilterRegistration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/FilterRegistration.html) as an alternative. It is usually safe to leave filter beans unordered. If a specific order is required, you should annotate the [`Filter`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Filter.html) with [`@Order`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/annotation/Order.html) or make it implement [`Ordered`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/Ordered.html). You cannot configure the order of a [`Filter`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Filter.html) by annotating its bean method with [`@Order`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/annotation/Order.html). If you cannot change the [`Filter`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Filter.html) class to add [`@Order`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/annotation/Order.html) or implement [`Ordered`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/Ordered.html), you must define a [`FilterRegistrationBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/FilterRegistrationBean.html) for the [`Filter`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Filter.html) and set the registration bean’s order using the `setOrder(int)` method. Or, if you prefer annotations, you can also use [`@FilterRegistration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/FilterRegistration.html) and set the `order` attribute. Avoid configuring a filter that reads the request body at `Ordered.HIGHEST_PRECEDENCE`, since it might go against the character encoding configuration of your application. If a servlet filter wraps the request, it should be configured with an order that is less than or equal to `OrderedFilter.REQUEST_WRAPPER_FILTER_MAX_ORDER`. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | To see the order of every [`Filter`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Filter.html) in your application, enable debug level logging for the `web` [logging group](../features/logging.html#features.logging.log-groups) (`logging.level.web=debug`). Details of the registered filters, including their order and URL patterns, will then be logged at startup. | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Take care when registering [`Filter`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Filter.html) beans since they are initialized very early in the application lifecycle. If you need to register a [`Filter`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/Filter.html) that interacts with other beans, consider using a [`DelegatingFilterProxyRegistrationBean`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/DelegatingFilterProxyRegistrationBean.html) instead. | ### [](#web.servlet.embedded-container.context-initializer)Servlet Context Initialization Embedded servlet containers do not directly execute the [`ServletContainerInitializer`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/ServletContainerInitializer.html) interface or Spring’s [`WebApplicationInitializer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/WebApplicationInitializer.html) interface. This is an intentional design decision intended to reduce the risk that third party libraries designed to run inside a war may break Spring Boot applications. If you need to perform servlet context initialization in a Spring Boot application, you should register a bean that implements the [`ServletContextInitializer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/servlet/ServletContextInitializer.html) interface. The single `onStartup` method provides access to the [`ServletContext`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/ServletContext.html) and, if necessary, can easily be used as an adapter to an existing [`WebApplicationInitializer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/WebApplicationInitializer.html). #### [](#web.servlet.embedded-container.context-initializer.init-parameters)Init Parameters Init parameters can be configured on the [`ServletContext`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/ServletContext.html) using `server.servlet.context-parameters.*` properties. For example, the property `server.servlet.context-parameters.com.example.parameter=example` will configure a `ServletContext` init parameter named `com.example.parameter` with the value `example`. #### [](#web.servlet.embedded-container.context-initializer.scanning)Scanning for Servlets, Filters, and listeners When using an embedded container, automatic registration of classes annotated with [`@WebServlet`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/annotation/WebServlet.html), [`@WebFilter`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/annotation/WebFilter.html), and [`@WebListener`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/annotation/WebListener.html) can be enabled by using [`@ServletComponentScan`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/servlet/context/ServletComponentScan.html). | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | [`@ServletComponentScan`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/servlet/context/ServletComponentScan.html) has no effect in a standalone container, where the container’s built-in discovery mechanisms are used instead. | ### [](#web.servlet.embedded-container.application-context)The ServletWebServerApplicationContext Under the hood, Spring Boot uses a different type of [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) for embedded servlet container support. The [`ServletWebServerApplicationContext`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/servlet/context/ServletWebServerApplicationContext.html) is a special type of [`WebApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/context/WebApplicationContext.html) that bootstraps itself by searching for a single [`ServletWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/servlet/ServletWebServerFactory.html) bean. Usually a [`TomcatServletWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/tomcat/servlet/TomcatServletWebServerFactory.html), or [`JettyServletWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jetty/servlet/JettyServletWebServerFactory.html) has been auto-configured. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | You usually do not need to be aware of these implementation classes. Most applications are auto-configured, and the appropriate [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) and [`ServletWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/servlet/ServletWebServerFactory.html) are created on your behalf. | In an embedded container setup, the [`ServletContext`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/ServletContext.html) is set as part of server startup which happens during application context initialization. Because of this beans in the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) cannot be reliably initialized with a [`ServletContext`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/ServletContext.html). One way to get around this is to inject [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) as a dependency of the bean and access the [`ServletContext`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/ServletContext.html) only when it is needed. Another way is to use a callback once the server has started. This can be done using an [`ApplicationListener`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationListener.html) which listens for the [`ApplicationStartedEvent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/event/ApplicationStartedEvent.html) as follows: * Java * Kotlin ```java import jakarta.servlet.ServletContext; import org.springframework.boot.context.event.ApplicationStartedEvent; import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationListener; import org.springframework.web.context.WebApplicationContext; public class MyDemoBean implements ApplicationListener { private ServletContext servletContext; @Override public void onApplicationEvent(ApplicationStartedEvent event) { ApplicationContext applicationContext = event.getApplicationContext(); this.servletContext = ((WebApplicationContext) applicationContext).getServletContext(); } } ``` ```kotlin import jakarta.servlet.ServletContext import org.springframework.boot.context.event.ApplicationStartedEvent import org.springframework.context.ApplicationContext import org.springframework.context.ApplicationListener import org.springframework.web.context.WebApplicationContext class MyDemoBean : ApplicationListener { private var servletContext: ServletContext? = null override fun onApplicationEvent(event: ApplicationStartedEvent) { val applicationContext: ApplicationContext = event.applicationContext this.servletContext = (applicationContext as WebApplicationContext).servletContext } } ``` ### [](#web.servlet.embedded-container.customizing)Customizing Embedded Servlet Containers Common servlet container settings can be configured by using Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) properties. Usually, you would define the properties in your `application.properties` or `application.yaml` file. Common server settings include: * Network settings: Listen port for incoming HTTP requests (`server.port`), interface address to bind to (`server.address`), and so on. * Session settings: Whether the session is persistent (`server.servlet.session.persistent`), session timeout (`server.servlet.session.timeout`), location of session data (`server.servlet.session.store-dir`), and session-cookie configuration (`server.servlet.session.cookie.*`). * Error management: Location of the error page (`spring.web.error.path`) and so on. * [SSL](../../how-to/webserver.html#howto.webserver.configure-ssl) * [HTTP compression](../../how-to/webserver.html#howto.webserver.enable-response-compression) Spring Boot tries as much as possible to expose common settings, but this is not always possible. For those cases, dedicated namespaces offer server-specific customizations (see `server.tomcat`). For instance, [access logs](../../how-to/webserver.html#howto.webserver.configure-access-logs) can be configured with specific features of the embedded servlet container. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | See the [`ServerProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/autoconfigure/ServerProperties.html) class for a complete list. | #### [](#web.servlet.embedded-container.customizing.samesite)SameSite Cookies The `SameSite` cookie attribute can be used by web browsers to control if and how cookies are submitted in cross-site requests. The attribute is particularly relevant for modern web browsers which have started to change the default value that is used when the attribute is missing. If you want to change the `SameSite` attribute of your session cookie, you can use the `server.servlet.session.cookie.same-site` property. This property is supported by auto-configured Tomcat and Jetty servers. It is also used to configure Spring Session servlet based [`SessionRepository`](https://docs.spring.io/spring-session/docs/4.1.x/api/org/springframework/session/SessionRepository.html) beans. For example, if you want your session cookie to have a `SameSite` attribute of `None`, you can add the following to your `application.properties` or `application.yaml` file: * Properties * YAML ```properties server.servlet.session.cookie.same-site=none ``` ```yaml server: servlet: session: cookie: same-site: "none" ``` If you want to change the `SameSite` attribute on other cookies added to your [`HttpServletResponse`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/http/HttpServletResponse.html), you can use a [`CookieSameSiteSupplier`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/servlet/CookieSameSiteSupplier.html). The [`CookieSameSiteSupplier`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/servlet/CookieSameSiteSupplier.html) is passed a [`Cookie`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/http/Cookie.html) and may return a `SameSite` value, or `null`. There are a number of convenience factory and filter methods that you can use to quickly match specific cookies. For example, adding the following bean will automatically apply a `SameSite` of `Lax` for all cookies with a name that matches the regular expression `myapp.*`. * Java * Kotlin ```java import org.springframework.boot.web.server.servlet.CookieSameSiteSupplier; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MySameSiteConfiguration { @Bean public CookieSameSiteSupplier applicationCookieSameSiteSupplier() { return CookieSameSiteSupplier.ofLax().whenHasNameMatching("myapp.*"); } } ``` ```kotlin import org.springframework.boot.web.server.servlet.CookieSameSiteSupplier import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MySameSiteConfiguration { @Bean fun applicationCookieSameSiteSupplier(): CookieSameSiteSupplier { return CookieSameSiteSupplier.ofLax().whenHasNameMatching("myapp.*") } } ``` #### [](#web.servlet.embedded-container.customizing.encoding)Character Encoding The character encoding behavior of the embedded servlet container for request and response handling can be configured using the `server.servlet.encoding.*` configuration properties. When a request’s `Accept-Language` header indicates a locale for the request it will be automatically mapped to a charset by the servlet container. Each container provides default locale to charset mappings and you should verify that they meet your application’s needs. When they do not, use the `server.servlet.encoding.mapping` configuration property to customize the mappings, as shown in the following example: * Properties * YAML ```properties server.servlet.encoding.mapping.ko=UTF-8 ``` ```yaml server: servlet: encoding: mapping: ko: "UTF-8" ``` In the preceding example, the `ko` (Korean) locale has been mapped to `UTF-8`. This is equivalent to a `` entry in a `web.xml` file of a traditional war deployment. #### [](#web.servlet.embedded-container.customizing.programmatic)Programmatic Customization If you need to programmatically configure your embedded servlet container, you can register a Spring bean that implements the [`WebServerFactoryCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/WebServerFactoryCustomizer.html) interface. [`WebServerFactoryCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/WebServerFactoryCustomizer.html) provides access to the [`ConfigurableServletWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/servlet/ConfigurableServletWebServerFactory.html), which includes numerous customization setter methods. The following example shows programmatically setting the port: * Java * Kotlin ```java import org.springframework.boot.web.server.WebServerFactoryCustomizer; import org.springframework.boot.web.server.servlet.ConfigurableServletWebServerFactory; import org.springframework.stereotype.Component; @Component public class MyWebServerFactoryCustomizer implements WebServerFactoryCustomizer { @Override public void customize(ConfigurableServletWebServerFactory server) { server.setPort(9000); } } ``` ```kotlin import org.springframework.boot.web.server.servlet.ConfigurableServletWebServerFactory import org.springframework.boot.web.server.WebServerFactoryCustomizer import org.springframework.stereotype.Component @Component class MyWebServerFactoryCustomizer : WebServerFactoryCustomizer { override fun customize(server: ConfigurableServletWebServerFactory) { server.setPort(9000) } } ``` [`TomcatServletWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/tomcat/servlet/TomcatServletWebServerFactory.html), and [`JettyServletWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jetty/servlet/JettyServletWebServerFactory.html) are dedicated variants of [`ConfigurableServletWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/servlet/ConfigurableServletWebServerFactory.html) that have additional customization setter methods for Tomcat, and Jetty respectively. The following example shows how to customize [`TomcatServletWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/tomcat/servlet/TomcatServletWebServerFactory.html) that provides access to Tomcat-specific configuration options: * Java * Kotlin ```java import java.time.Duration; import org.springframework.boot.tomcat.servlet.TomcatServletWebServerFactory; import org.springframework.boot.web.server.WebServerFactoryCustomizer; import org.springframework.stereotype.Component; @Component public class MyTomcatWebServerFactoryCustomizer implements WebServerFactoryCustomizer { @Override public void customize(TomcatServletWebServerFactory server) { server.addConnectorCustomizers((connector) -> connector.setAsyncTimeout(Duration.ofSeconds(20).toMillis())); } } ``` ```kotlin import org.springframework.boot.web.server.WebServerFactoryCustomizer import org.springframework.boot.tomcat.servlet.TomcatServletWebServerFactory import org.springframework.stereotype.Component import java.time.Duration @Component class MyTomcatWebServerFactoryCustomizer : WebServerFactoryCustomizer { override fun customize(server: TomcatServletWebServerFactory) { server.addConnectorCustomizers({ connector -> connector.asyncTimeout = Duration.ofSeconds(20).toMillis() }) } } ``` #### [](#web.servlet.embedded-container.customizing.direct)Customizing ConfigurableServletWebServerFactory Directly For more advanced use cases that require you to extend from [`ServletWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/servlet/ServletWebServerFactory.html), you can expose a bean of such type yourself. Setters are provided for many configuration options. Several protected method “hooks” are also provided should you need to do something more exotic. See the [`ConfigurableServletWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/servlet/ConfigurableServletWebServerFactory.html) API documentation for details. | | | | -- | --------------------------------------------------------------------------------------------------- | | ** | Auto-configured customizers are still applied on your custom factory, so use that option carefully. | ### [](#web.servlet.embedded-container.jsp-limitations)JSP Limitations When running a Spring Boot application that uses an embedded servlet container (and is packaged as an executable archive), there are some limitations in the JSP support. * With Jetty and Tomcat, it should work if you use war packaging. An executable war will work when launched with `java -jar`, and will also be deployable to any standard container. JSPs are not supported when using an executable jar. * Creating a custom `error.jsp` page does not override the default view for [error handling](#web.servlet.spring-mvc.error-handling). [Custom error pages](#web.servlet.spring-mvc.error-handling.error-pages) should be used instead. * If you run your application using `mvn spring-boot:run` or `gradle bootRun` and you deviate from the standard `src/main/webapp` directory structure you may need to set a `WAR_SOURCE_DIRECTORY` environment variable so that Spring Boot can find your JSPs. - [Spring Boot](../../index.html) * [4.1.1](servlet.html) * [4.0.8](../../4.0/reference/web/servlet.html) * [3.5.16](../../3.5/reference/web/servlet.html) * [3.4.13](../../3.4/reference/web/servlet.html) * [3.3.13](../../3.3/reference/web/servlet.html) - [4.2.0-M2](../../4.2/reference/web/servlet.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/web/servlet.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/web/servlet.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/web/servlet.html) * Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/features/profiles.html ---- # Profiles Spring Profiles provide a way to segregate parts of your application configuration and make it be available only in certain environments. Any [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html), [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) or [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) can be marked with [`@Profile`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Profile.html) to limit when it is loaded, as shown in the following example: * Java * Kotlin ```java import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Profile; @Configuration(proxyBeanMethods = false) @Profile("production") public class ProductionConfiguration { // ... } ``` ```kotlin import org.springframework.context.annotation.Configuration import org.springframework.context.annotation.Profile @Configuration(proxyBeanMethods = false) @Profile("production") class ProductionConfiguration { // ... } ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) beans are registered through [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) instead of automatic scanning, the [`@Profile`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Profile.html) annotation needs to be specified on the [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class that has the [`@EnableConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/EnableConfigurationProperties.html) annotation. In the case where [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) are scanned, [`@Profile`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Profile.html) can be specified on the [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) class itself. | You can use a `spring.profiles.active` [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) property to specify which profiles are active. You can specify the property in any of the ways described earlier in this chapter. For example, you could include it in your `application.properties`, as shown in the following example: * Properties * YAML ```properties spring.profiles.active=dev,hsqldb ``` ```yaml spring: profiles: active: "dev,hsqldb" ``` You could also specify it on the command line by using the following switch: `--spring.profiles.active=dev,hsqldb`. If no profile is active, a default profile is enabled. The name of the default profile is `default` and it can be tuned using the `spring.profiles.default` [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) property, as shown in the following example: * Properties * YAML ```properties spring.profiles.default=none ``` ```yaml spring: profiles: default: "none" ``` `spring.profiles.active` and `spring.profiles.default` can only be used in non-profile-specific documents. This means they cannot be included in [profile specific files](external-config.html#features.external-config.files.profile-specific) or [documents activated](external-config.html#features.external-config.files.activation-properties) by `spring.config.activate.on-profile`. For example, the second document configuration is invalid: * Properties * YAML ```properties spring.profiles.active=prod #--- spring.config.activate.on-profile=prod spring.profiles.active=metrics ``` ```yaml # this document is valid spring: profiles: active: "prod" --- # this document is invalid spring: config: activate: on-profile: "prod" profiles: active: "metrics" ``` The `spring.profiles.active` property follows the same ordering rules as other properties. The highest [`PropertySource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/PropertySource.html) wins. This means that you can specify active profiles in `application.properties` and then **replace** them by using the command line switch. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | See [the “Externalized Configuration”](external-config.html#features.external-config.order) for more details on the order in which property sources are considered. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | By default, profile names in Spring Boot may contain letters, numbers, or permitted characters (`-`, `_`, `.`, `+`, `@`). In addition, they can only start and end with a letter or number.This restriction helps to prevent common parsing issues. if, however, you prefer more flexible profile names you can set `spring.profiles.validate` to `false` in your `application.properties` or `application.yaml` file:- Properties - YAML```properties spring.profiles.validate=false ``````yaml spring: profiles: validate: false ``` | ## [](#features.profiles.adding-active-profiles)Adding Active Profiles Sometimes, it is useful to have properties that **add** to the active profiles rather than replace them. The `spring.profiles.include` property can be used to add active profiles on top of those activated by the `spring.profiles.active` property. The [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) entry point also has a Java API for setting additional profiles. See the `setAdditionalProfiles()` method in [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html). For example, when an application with the following properties is run, the common and local profiles will be activated even when it runs using the `--spring.profiles.active` switch: * Properties * YAML ```properties spring.profiles.include[0]=common spring.profiles.include[1]=local ``` ```yaml spring: profiles: include: - "common" - "local" ``` | | | | -- | ------------------------------------------------------------------------- | | ** | Included profiles are added before any `spring.profiles.active` profiles. | | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The `spring.profiles.include` property is processed for each property source, as such the usual [complex type merging rules](external-config.html#features.external-config.typesafe-configuration-properties.merging-complex-types) for lists do not apply. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Similar to `spring.profiles.active`, `spring.profiles.include` can only be used in non-profile-specific documents. This means it cannot be included in [profile specific files](external-config.html#features.external-config.files.profile-specific) or [documents activated](external-config.html#features.external-config.files.activation-properties) by `spring.config.activate.on-profile`. | Profile groups, which are described in the [next section](#features.profiles.groups) can also be used to add active profiles if a given profile is active. ## [](#features.profiles.groups)Profile Groups Occasionally the profiles that you define and use in your application are too fine-grained and become cumbersome to use. For example, you might have `proddb` and `prodmq` profiles that you use to enable database and messaging features independently. To help with this, Spring Boot lets you define profile groups. A profile group allows you to define a logical name for a related group of profiles. For example, we can create a `production` group that consists of our `proddb` and `prodmq` profiles. * Properties * YAML ```properties spring.profiles.group.production[0]=proddb spring.profiles.group.production[1]=prodmq ``` ```yaml spring: profiles: group: production: - "proddb" - "prodmq" ``` Our application can now be started using `--spring.profiles.active=production` to activate the `production`, `proddb` and `prodmq` profiles in one hit. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Similar to `spring.profiles.active` and `spring.profiles.include`, `spring.profiles.group` can only be used in non-profile-specific documents. This means it cannot be included in [profile specific files](external-config.html#features.external-config.files.profile-specific) or [documents activated](external-config.html#features.external-config.files.activation-properties) by `spring.config.activate.on-profile`. | ## [](#features.profiles.programmatically-setting-profiles)Programmatically Setting Profiles You can programmatically set active profiles by calling `SpringApplication.setAdditionalProfiles(…​)` before your application runs. It is also possible to activate profiles by using Spring’s [`ConfigurableEnvironment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/ConfigurableEnvironment.html) interface. ## [](#features.profiles.profile-specific-configuration-files)Profile-specific Configuration Files Profile-specific variants of both `application.properties` (or `application.yaml`) and files referenced through [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html) are considered as files and loaded. See [Profile Specific Files](external-config.html#features.external-config.files.profile-specific) for details. * [Spring Boot](../../index.html) * [4.1.1](profiles.html) * [4.0.8](../../4.0/reference/features/profiles.html) * [3.5.16](../../3.5/reference/features/profiles.html) * [3.4.13](../../3.4/reference/features/profiles.html) * [3.3.13](../../3.3/reference/features/profiles.html) - [4.2.0-M2](../../4.2/reference/features/profiles.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/features/profiles.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/features/profiles.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/features/profiles.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/index-files/index-2.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ## B * [bind(Action)](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.html#bind\(org.gradle.api.Action\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[CacheSpec](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Configures a bind cache using the given `action`. * [BindCacheSpec()](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.BindCacheSpec.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.gradle.tasks.bundling.[CacheSpec.BindCacheSpec](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.BindCacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling")   * [BOM\_COORDINATES](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html#BOM_COORDINATES) - Static variable in class org.springframework.boot.gradle.plugin.[SpringBootPlugin](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html "class in org.springframework.boot.gradle.plugin") The coordinates `(group:name:version)` of the `spring-boot-dependencies` bom. * [BOOT\_ARCHIVES\_CONFIGURATION\_NAME](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html#BOOT_ARCHIVES_CONFIGURATION_NAME) - Static variable in class org.springframework.boot.gradle.plugin.[SpringBootPlugin](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html "class in org.springframework.boot.gradle.plugin") The name of the [`Configuration`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/artifacts/Configuration.html "class or interface in org.gradle.api.artifacts") that contains Spring Boot archives. * [BOOT\_BUILD\_IMAGE\_TASK\_NAME](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html#BOOT_BUILD_IMAGE_TASK_NAME) - Static variable in class org.springframework.boot.gradle.plugin.[SpringBootPlugin](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html "class in org.springframework.boot.gradle.plugin") The name of the default [`BootBuildImage`](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") task. * [BOOT\_JAR\_TASK\_NAME](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html#BOOT_JAR_TASK_NAME) - Static variable in class org.springframework.boot.gradle.plugin.[SpringBootPlugin](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html "class in org.springframework.boot.gradle.plugin") The name of the default [`BootJar`](../org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling") task. * [BOOT\_WAR\_TASK\_NAME](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html#BOOT_WAR_TASK_NAME) - Static variable in class org.springframework.boot.gradle.plugin.[SpringBootPlugin](../org/springframework/boot/gradle/plugin/SpringBootPlugin.html "class in org.springframework.boot.gradle.plugin") The name of the default [`BootWar`](../org/springframework/boot/gradle/tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling") task. * [BootArchive](../org/springframework/boot/gradle/tasks/bundling/BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") - Interface in [org.springframework.boot.gradle.tasks.bundling](../org/springframework/boot/gradle/tasks/bundling/package-summary.html) A Spring Boot "fat" archive task. * [BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") - Class in [org.springframework.boot.gradle.tasks.bundling](../org/springframework/boot/gradle/tasks/bundling/package-summary.html) A [`Task`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") for bundling an application into an OCI image using a [buildpack](https://buildpacks.io). * [BootBuildImage()](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling")   * [bootInf(Action)](../org/springframework/boot/gradle/tasks/bundling/BootJar.html#bootInf\(org.gradle.api.Action\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootJar](../org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling") Calls the given `action` to add content to the `BOOT-INF` directory of the jar. * [BootJar](../org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling") - Class in [org.springframework.boot.gradle.tasks.bundling](../org/springframework/boot/gradle/tasks/bundling/package-summary.html) A custom [`Jar`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/Jar.html "class or interface in org.gradle.api.tasks.bundling") task that produces a Spring Boot executable jar. * [BootJar()](../org/springframework/boot/gradle/tasks/bundling/BootJar.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.gradle.tasks.bundling.[BootJar](../org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling") Creates a new `BootJar` task. * [BootRun](../org/springframework/boot/gradle/tasks/run/BootRun.html "class in org.springframework.boot.gradle.tasks.run") - Class in [org.springframework.boot.gradle.tasks.run](../org/springframework/boot/gradle/tasks/run/package-summary.html) Custom [`JavaExec`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") task for running a Spring Boot application. * [BootRun()](../org/springframework/boot/gradle/tasks/run/BootRun.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.gradle.tasks.run.[BootRun](../org/springframework/boot/gradle/tasks/run/BootRun.html "class in org.springframework.boot.gradle.tasks.run")   * [BootWar](../org/springframework/boot/gradle/tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling") - Class in [org.springframework.boot.gradle.tasks.bundling](../org/springframework/boot/gradle/tasks/bundling/package-summary.html) A custom [`War`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/War.html "class or interface in org.gradle.api.tasks.bundling") task that produces a Spring Boot executable war. * [BootWar()](../org/springframework/boot/gradle/tasks/bundling/BootWar.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.gradle.tasks.bundling.[BootWar](../org/springframework/boot/gradle/tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling") Creates a new `BootWar` task. * [buildCache(Action)](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#buildCache\(org.gradle.api.Action\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Customizes the [`CacheSpec`](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") for the build cache using the given `action`. * [builderRegistry(Action)](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html#builderRegistry\(org.gradle.api.Action\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[DockerSpec](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Customizes the [`DockerSpec.DockerRegistrySpec`](../org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html "class in org.springframework.boot.gradle.tasks.bundling") that configures authentication to the builder registry. * [buildInfo()](../org/springframework/boot/gradle/dsl/SpringBootExtension.html#buildInfo\(\)) - Method in class org.springframework.boot.gradle.dsl.[SpringBootExtension](../org/springframework/boot/gradle/dsl/SpringBootExtension.html "class in org.springframework.boot.gradle.dsl") Creates a new [`BuildInfo`](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") task named `bootBuildInfo` and adds its output as a [`source directory`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/SourceDirectorySet.html#srcDir\(java.lang.Object\) "class or interface in org.gradle.api.file") of the main source set's [`resources`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html#getResources\(\) "class or interface in org.gradle.api.tasks"). * [buildInfo(Action)](../org/springframework/boot/gradle/dsl/SpringBootExtension.html#buildInfo\(org.gradle.api.Action\)) - Method in class org.springframework.boot.gradle.dsl.[SpringBootExtension](../org/springframework/boot/gradle/dsl/SpringBootExtension.html "class in org.springframework.boot.gradle.dsl") Creates a new [`BuildInfo`](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") task named `bootBuildInfo` and adds its output as a [`source directory`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/SourceDirectorySet.html#srcDir\(java.lang.Object\) "class or interface in org.gradle.api.file") of the main source set's [`resources`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/SourceSet.html#getResources\(\) "class or interface in org.gradle.api.tasks"). * [BuildInfo](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo") - Class in [org.springframework.boot.gradle.tasks.buildinfo](../org/springframework/boot/gradle/tasks/buildinfo/package-summary.html) [`Task`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Task.html "class or interface in org.gradle.api") for generating a build info properties file from [`BuildInfoProperties`](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo"). * [BuildInfo()](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.gradle.tasks.buildinfo.[BuildInfo](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html "class in org.springframework.boot.gradle.tasks.buildinfo")   * [BuildInfoProperties](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo") - Class in [org.springframework.boot.gradle.tasks.buildinfo](../org/springframework/boot/gradle/tasks/buildinfo/package-summary.html) The properties that are written into the `META-INF/build-info.properties` file. * [BuildInfoProperties(Project, SetProperty)](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html#%3Cinit%3E\(org.gradle.api.Project,org.gradle.api.provider.SetProperty\)) - Constructor for class org.springframework.boot.gradle.tasks.buildinfo.[BuildInfoProperties](../org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.html "class in org.springframework.boot.gradle.tasks.buildinfo")   * [buildWorkspace(Action)](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#buildWorkspace\(org.gradle.api.Action\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Customizes the [`CacheSpec`](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") for the build temporary workspace using the given `action`. [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-8.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## H * [hasTransformedResource()](../org/springframework/boot/maven/PropertiesMergingResourceTransformer.html#hasTransformedResource\(\)) - Method in class org.springframework.boot.maven.[PropertiesMergingResourceTransformer](../org/springframework/boot/maven/PropertiesMergingResourceTransformer.html "class in org.springframework.boot.maven")   * [HelpMojo](../org/springframework/boot/maven/HelpMojo.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Display help information on spring-boot-maven-plugin.\ Call `mvn spring-boot:help -Ddetail=true -Dgoal=` to display parameter details. * [HelpMojo()](../org/springframework/boot/maven/HelpMojo.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.maven.[HelpMojo](../org/springframework/boot/maven/HelpMojo.html "class in org.springframework.boot.maven")   [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/Exclude.html ---- Uses of Class\ org.springframework.boot.maven.Exclude ====================================== * ## Uses of [Exclude](../Exclude.html "class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Method parameters in [org.springframework.boot.maven](../package-summary.html) with type arguments of type [Exclude](../Exclude.html "class in org.springframework.boot.maven") Modifier and Type Method Description `protected void` AbstractDependencyFilterMojo.`setExcludes(@Nullable List excludes)`   Constructors in [org.springframework.boot.maven](../package-summary.html) with parameters of type [Exclude](../Exclude.html "class in org.springframework.boot.maven") Modifier Constructor Description ` ` `ExcludeFilter(Exclude... excludes)`   Constructor parameters in [org.springframework.boot.maven](../package-summary.html) with type arguments of type [Exclude](../Exclude.html "class in org.springframework.boot.maven") Modifier Constructor Description ` ` `ExcludeFilter(List excludes)` ---- url: https://docs.spring.io/spring-boot/reference/messaging/rsocket.html ---- # RSocket [RSocket](https://rsocket.io) is a binary protocol for use on byte stream transports. It enables symmetric interaction models through async message passing over a single connection. The `spring-messaging` module of the Spring Framework provides support for RSocket requesters and responders, both on the client and on the server side. See the [RSocket section](https://docs.spring.io/spring-framework/reference/7.0/rsocket.html#rsocket-spring) of the Spring Framework reference for more details, including an overview of the RSocket protocol. ## [](#messaging.rsocket.strategies-auto-configuration)RSocket Strategies Auto-configuration Spring Boot auto-configures an [`RSocketStrategies`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/messaging/rsocket/RSocketStrategies.html) bean that provides all the required infrastructure for encoding and decoding RSocket payloads. By default, the auto-configuration will try to configure the following (in order): 1. [CBOR](https://cbor.io/) codecs with Jackson 2. JSON codecs with Jackson The `spring-boot-starter-rsocket` starter provides both dependencies. See the [Jackson support section](../features/json.html#features.json.jackson) to know more about customization possibilities. Developers can customize the [`RSocketStrategies`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/messaging/rsocket/RSocketStrategies.html) component by creating beans that implement the [`RSocketStrategiesCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/rsocket/messaging/RSocketStrategiesCustomizer.html) interface. Note that their [`@Order`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/annotation/Order.html) is important, as it determines the order of codecs. ## [](#messaging.rsocket.server-auto-configuration)RSocket Server Auto-configuration Spring Boot provides RSocket server auto-configuration. The required dependencies are provided by the `spring-boot-starter-rsocket`. Spring Boot allows exposing RSocket over WebSocket from a WebFlux server, or standing up an independent RSocket server. This depends on the type of application and its configuration. For WebFlux application (that is of type [`WebApplicationType.REACTIVE`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/WebApplicationType.html#REACTIVE)), the RSocket server will be plugged into the Web Server only if the following properties match: * Properties * YAML ```properties spring.rsocket.server.mapping-path=/rsocket spring.rsocket.server.transport=websocket ``` ```yaml spring: rsocket: server: mapping-path: "/rsocket" transport: "websocket" ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------- | | ** | Plugging RSocket into a web server is only supported with Reactor Netty, as RSocket itself is built with that library. | Alternatively, an RSocket TCP or websocket server is started as an independent, embedded server. Besides the dependency requirements, the only required configuration is to define a port for that server: * Properties * YAML ```properties spring.rsocket.server.port=9898 ``` ```yaml spring: rsocket: server: port: 9898 ``` ## [](#messaging.rsocket.messaging)Spring Messaging RSocket Support Spring Boot will auto-configure the Spring Messaging infrastructure for RSocket. This means that Spring Boot will create a [`RSocketMessageHandler`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/messaging/rsocket/annotation/support/RSocketMessageHandler.html) bean that will handle RSocket requests to your application. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can use [`@ControllerAdvice`](https://docs.spring.io/spring-framework/reference/7.0/web/webmvc/mvc-controller/ann-advice.html) to handle exceptions. | ## [](#messaging.rsocket.requester)Calling RSocket Services with RSocketRequester Once the [`RSocket`](https://javadoc.io/doc/io.rsocket/rsocket-core/1.1.5/io/rsocket/RSocket.html) channel is established between server and client, any party can send or receive requests to the other. As a server, you can get injected with an [`RSocketRequester`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/messaging/rsocket/RSocketRequester.html) instance on any handler method of an RSocket [`@Controller`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Controller.html). As a client, you need to configure and establish an RSocket connection first. Spring Boot auto-configures an [`RSocketRequester.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/messaging/rsocket/RSocketRequester.Builder.html) for such cases with the expected codecs and applies any [`RSocketConnectorConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/messaging/rsocket/RSocketConnectorConfigurer.html) bean. The [`RSocketRequester.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/messaging/rsocket/RSocketRequester.Builder.html) instance is a prototype bean, meaning each injection point will provide you with a new instance . This is done on purpose since this builder is stateful and you should not create requesters with different setups using the same instance. The following code shows a typical example: * Java * Kotlin ```java import reactor.core.publisher.Mono; import org.springframework.messaging.rsocket.RSocketRequester; import org.springframework.stereotype.Service; @Service public class MyService { private final RSocketRequester rsocketRequester; public MyService(RSocketRequester.Builder rsocketRequesterBuilder) { this.rsocketRequester = rsocketRequesterBuilder.tcp("example.org", 9898); } public Mono someRSocketCall(String name) { return this.rsocketRequester.route("user").data(name).retrieveMono(User.class); } } ``` ```kotlin import org.springframework.messaging.rsocket.RSocketRequester import org.springframework.stereotype.Service import reactor.core.publisher.Mono @Service class MyService(rsocketRequesterBuilder: RSocketRequester.Builder) { private val rsocketRequester: RSocketRequester init { rsocketRequester = rsocketRequesterBuilder.tcp("example.org", 9898) } fun someRSocketCall(name: String): Mono { return rsocketRequester.route("user").data(name).retrieveMono( User::class.java ) } } ``` * [Spring Boot](../../index.html) * [4.1.1](rsocket.html) * [4.0.8](../../4.0/reference/messaging/rsocket.html) * [3.5.16](../../3.5/reference/messaging/rsocket.html) * [3.4.13](../../3.4/reference/messaging/rsocket.html) * [3.3.13](../../3.3/reference/messaging/rsocket.html) - [4.2.0-M2](../../4.2/reference/messaging/rsocket.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/messaging/rsocket.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/messaging/rsocket.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/messaging/rsocket.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/managing-dependencies.html ---- # Managing Dependencies To manage dependencies in your Spring Boot application, you can either apply the [`io.spring.dependency-management`](https://github.com/spring-gradle-plugins/dependency-management-plugin) plugin or use Gradle’s native bom support. The primary benefit of the former is that it offers property-based customization of managed versions, while using the latter will likely result in faster builds. ## [](#managing-dependencies.dependency-management-plugin)Managing Dependencies with the Dependency Management Plugin When you apply the [`io.spring.dependency-management`](https://github.com/spring-gradle-plugins/dependency-management-plugin) plugin, Spring Boot’s plugin will automatically [import the `spring-boot-dependencies` bom](reacting.html#reacting-to-other-plugins.dependency-management) from the version of Spring Boot that you are using. This provides a similar dependency management experience to the one that’s enjoyed by Maven users. For example, it allows you to omit version numbers when declaring dependencies that are managed in the bom. To make use of this functionality, declare dependencies in the usual way but omit the version number: * Groovy * Kotlin ```groovy dependencies { implementation('org.springframework.boot:spring-boot-starter-web') implementation('org.springframework.boot:spring-boot-starter-data-jpa') } ``` ```kotlin dependencies { implementation("org.springframework.boot:spring-boot-starter-web") implementation("org.springframework.boot:spring-boot-starter-data-jpa") } ``` ### [](#managing-dependencies.dependency-management-plugin.customizing)Customizing Managed Versions The `spring-boot-dependencies` bom that is automatically imported when the dependency management plugin is applied uses properties to control the versions of the dependencies that it manages. Browse the [Dependency Versions Properties](../appendix/dependency-versions/properties.html) section in the Spring Boot reference for a complete list of these properties. To customize a managed version you set its corresponding property. For example, to customize the version of SLF4J which is controlled by the `slf4j.version` property: * Groovy * Kotlin ```groovy ext['slf4j.version'] = '1.7.20' ``` ```kotlin extra["slf4j.version"] = "1.7.20" ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Each Spring Boot release is designed and tested against a specific set of third-party dependencies. Overriding versions may cause compatibility issues and should be done with care. | ### [](#managing-dependencies.dependency-management-plugin.using-in-isolation)Using Spring Boot’s Dependency Management in Isolation Spring Boot’s dependency management can be used in a project without applying Spring Boot’s plugin to that project. The `SpringBootPlugin` class provides a `BOM_COORDINATES` constant that can be used to import the bom without having to know its group ID, artifact ID, or version. First, configure the project to depend on the Spring Boot plugin but do not apply it: * Groovy * Kotlin ```groovy plugins { id 'org.springframework.boot' version '4.1.1' apply false } ``` ```kotlin plugins { id("org.springframework.boot") version "4.1.1" apply false } ``` The Spring Boot plugin’s dependency on the dependency management plugin means that you can use the dependency management plugin without having to declare a dependency on it. This also means that you will automatically use the same version of the dependency management plugin as Spring Boot uses. Apply the dependency management plugin and then configure it to import Spring Boot’s bom: * Groovy * Kotlin ```groovy apply plugin: 'io.spring.dependency-management' dependencyManagement { imports { mavenBom org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES } } ``` ```kotlin apply(plugin = "io.spring.dependency-management") the().apply { imports { mavenBom(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES) } } ``` The Kotlin code above is a bit awkward. That’s because we’re using the imperative way of applying the dependency management plugin. We can make the code less awkward by applying the plugin from the root parent project, or by using the `plugins` block as we’re doing for the Spring Boot plugin. A downside of this method is that it forces us to specify the version of the dependency management plugin: ```kotlin plugins { java id("org.springframework.boot") version "4.1.1" apply false id("io.spring.dependency-management") version "1.1.7" } dependencyManagement { imports { mavenBom(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES) } } ``` ### [](#managing-dependencies.dependency-management-plugin.learning-more)Learning More To learn more about the capabilities of the dependency management plugin, please refer to its [documentation](https://docs.spring.io/dependency-management-plugin/docs/1.1.7/reference/html). ## [](#managing-dependencies.gradle-bom-support)Managing Dependencies with Gradle’s Bom Support Gradle allows a bom to be used to manage a project’s versions by declaring it as a `platform` or `enforcedPlatform` dependency. A `platform` dependency treats the versions in the bom as recommendations and other versions and constraints in the dependency graph may cause a version of a dependency other than that declared in the bom to be used. An `enforcedPlatform` dependency treats the versions in the bom as requirements and they will override any other version found in the dependency graph. The `SpringBootPlugin` class provides a `BOM_COORDINATES` constant that can be used to declare a dependency upon Spring Boot’s bom without having to know its group ID, artifact ID, or version, as shown in the following example: * Groovy * Kotlin ```groovy dependencies { implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES) } ``` ```kotlin dependencies { implementation(platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)) } ``` A platform or enforced platform will only constrain the versions of the configuration in which it has been declared or that extend from the configuration in which it has been declared. As a result, in may be necessary to declare the same dependency in more than one configuration. ### [](#managing-dependencies.gradle-bom-support.customizing)Customizing Managed Versions When using Gradle’s bom support, you cannot use the properties from `spring-boot-dependencies` to control the versions of the dependencies that it manages. Instead, you must use one of the mechanisms that Gradle provides. One such mechanism is a resolution strategy. SLF4J’s modules are all in the `org.slf4j` group so their version can be controlled by configuring every dependency in that group to use a particular version, as shown in the following example: * Groovy * Kotlin ```groovy configurations.all { resolutionStrategy.eachDependency { DependencyResolveDetails details -> if (details.requested.group == 'org.slf4j') { details.useVersion '1.7.20' } } } ``` ```kotlin configurations.all { resolutionStrategy.eachDependency { if (requested.group == "org.slf4j") { useVersion("1.7.20") } } } ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Each Spring Boot release is designed and tested against a specific set of third-party dependencies. Overriding versions may cause compatibility issues and should be done with care. | * [Spring Boot](../index.html) * [4.1.1](managing-dependencies.html) * [4.0.8](../4.0/gradle-plugin/managing-dependencies.html) * [3.5.16](../3.5/gradle-plugin/managing-dependencies.html) * [3.4.13](../3.4/gradle-plugin/managing-dependencies.html) * [3.3.13](../3.3/gradle-plugin/managing-dependencies.html) - [4.2.0-M2](../4.2/gradle-plugin/managing-dependencies.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/gradle-plugin/managing-dependencies.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/gradle-plugin/managing-dependencies.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/gradle-plugin/managing-dependencies.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/DockerSpec.DockerRegistrySpec.html ---- # Class DockerSpec.DockerRegistrySpec [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.gradle.tasks.bundling.DockerSpec.DockerRegistrySpec * Enclosing class: `DockerSpec` *** public abstract static class DockerSpec.DockerRegistrySpec extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") `DockerRegistrySpec()`   - ## Method Summary Modifier and Type Method Description `abstract Property` `getEmail()` Returns the email address associated with the Docker registry username. `abstract Property` `getPassword()` Returns the password to use when authenticating to the Docker registry. `abstract Property` `getToken()` Returns the identity token to use when authenticating to the Docker registry. `abstract Property` `getUrl()` Returns the Docker registry URL. `abstract Property` `getUsername()` Returns the username to use when authenticating to the Docker registry. ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### DockerRegistrySpec public DockerRegistrySpec() * ## Method Details * ### getUsername [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getUsername() Returns the username to use when authenticating to the Docker registry. * Returns: the registry username * ### getPassword [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getPassword() Returns the password to use when authenticating to the Docker registry. * Returns: the registry password * ### getUrl [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getUrl() Returns the Docker registry URL. * Returns: the registry URL * ### getEmail [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getEmail() Returns the email address associated with the Docker registry username. * Returns: the registry email address * ### getToken [@Input](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Input.html "class or interface in org.gradle.api.tasks") [@Optional](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Optional.html "class or interface in org.gradle.api.tasks") public abstract [Property](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Property.html "class or interface in org.gradle.api.provider")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> getToken() Returns the identity token to use when authenticating to the Docker registry. * Returns: the registry identity token ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/allpackages-index.html ---- # All Packages Package Summary ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/constant-values.html ---- # Constant Field Values ## org.springframework.\* * org.springframework.boot.gradle.plugin.[SpringBootAotPlugin](org/springframework/boot/gradle/plugin/SpringBootAotPlugin.html "class in org.springframework.boot.gradle.plugin") Modifier and Type Constant Field Value `public static final String` `AOT_SOURCE_SET_NAME` `"aot"` `public static final String` `AOT_TEST_SOURCE_SET_NAME` `"aotTest"` `public static final String` `PROCESS_AOT_TASK_NAME` `"processAot"` `public static final String` `PROCESS_TEST_AOT_TASK_NAME` `"processTestAot"` * org.springframework.boot.gradle.plugin.[SpringBootPlugin](org/springframework/boot/gradle/plugin/SpringBootPlugin.html "class in org.springframework.boot.gradle.plugin") Modifier and Type Constant Field Value `public static final String` `BOOT_ARCHIVES_CONFIGURATION_NAME` `"bootArchives"` `public static final String` `BOOT_BUILD_IMAGE_TASK_NAME` `"bootBuildImage"` `public static final String` `BOOT_JAR_TASK_NAME` `"bootJar"` `public static final String` `BOOT_WAR_TASK_NAME` `"bootWar"` `public static final String` `DEVELOPMENT_ONLY_CONFIGURATION_NAME` `"developmentOnly"` `public static final String` `PRODUCTION_RUNTIME_CLASSPATH_CONFIGURATION_NAME` `"productionRuntimeClasspath"` `public static final String` `RESOLVE_MAIN_CLASS_NAME_TASK_NAME` `"resolveMainClassName"` `public static final String` `RESOLVE_TEST_MAIN_CLASS_NAME_TASK_NAME` `"resolveTestMainClassName"` `public static final String` `TEST_AND_DEVELOPMENT_ONLY_CONFIGURATION_NAME` `"testAndDevelopmentOnly"` ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/aot/ProcessTestAot.html ---- # Class ProcessTestAot [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.gradle.api.internal.AbstractTask [org.gradle.api.DefaultTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/DefaultTask.html "class or interface in org.gradle.api") org.gradle.api.internal.ConventionTask [org.gradle.api.tasks.JavaExec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") [org.springframework.boot.gradle.tasks.aot.AbstractAot](AbstractAot.html "class in org.springframework.boot.gradle.tasks.aot") org.springframework.boot.gradle.tasks.aot.ProcessTestAot * All Implemented Interfaces: `Comparable, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Task, BaseExecSpec, JavaExecSpec, JavaForkOptions, ProcessForkOptions, Configurable` *** [@CacheableTask](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/CacheableTask.html "class or interface in org.gradle.api.tasks") public abstract class ProcessTestAot extends [AbstractAot](AbstractAot.html "class in org.springframework.boot.gradle.tasks.aot") Custom [`JavaExec`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") task for ahead-of-time processing of a Spring Boot application's tests. `ProcessTestAot()`   - ## Method Summary Modifier and Type Method Description `void` `exec()`   `final @Nullable FileCollection` `getClasspathRoots()` Returns the classpath roots that should be scanned for test classes to process. `void` `setClasspathRoots(FileCollection classpathRoots)` Sets the classpath roots that should be scanned for test classes to process. * ### ProcessTestAot public ProcessTestAot() * ## Method Details * ### getClasspathRoots [@InputFiles](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/InputFiles.html "class or interface in org.gradle.api.tasks") [@PathSensitive](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/PathSensitive.html "class or interface in org.gradle.api.tasks")([RELATIVE](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/PathSensitivity.html#RELATIVE "class or interface in org.gradle.api.tasks")) public final @Nullable [FileCollection](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCollection.html "class or interface in org.gradle.api.file") getClasspathRoots() Returns the classpath roots that should be scanned for test classes to process. * Returns: the classpath roots * ### setClasspathRoots public void setClasspathRoots​([FileCollection](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCollection.html "class or interface in org.gradle.api.file") classpathRoots) Sets the classpath roots that should be scanned for test classes to process. * Parameters: `classpathRoots` - the classpath roots * ### exec public void exec() * Overrides: `exec` in class `JavaExec` ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/CacheInfo.VolumeCacheInfo.html ---- # Class CacheInfo.VolumeCacheInfo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.maven.CacheInfo.VolumeCacheInfo * Enclosing class: `CacheInfo` *** public static class CacheInfo.VolumeCacheInfo extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") Encapsulates configuration of an image building cache stored in a volume. `VolumeCacheInfo()`   - ## Method Summary Modifier and Type Method Description `@Nullable String` `getName()`   ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### VolumeCacheInfo public VolumeCacheInfo() * ## Method Details * ### getName public @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getName() ---- url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html ---- # Endpoints Actuator endpoints let you monitor and interact with your application. Spring Boot includes a number of built-in endpoints and lets you add your own. For example, the `health` endpoint provides basic application health information. You can [control access](#actuator.endpoints.controlling-access) to each individual endpoint and [expose them (make them remotely accessible) over HTTP or JMX](#actuator.endpoints.exposing). An endpoint is considered to be available when access to it is permitted and it is exposed. The built-in endpoints are auto-configured only when they are available. Most applications choose exposure over HTTP, where the ID of the endpoint and a prefix of `/actuator` is mapped to a URL. For example, by default, the `health` endpoint is mapped to `/actuator/health`. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | To learn more about the Actuator’s endpoints and their request and response formats, see the [API documentation](../../api/rest/actuator/index.html). | The following technology-agnostic endpoints are available: | ID | Description | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `auditevents` | Exposes audit events information for the current application. Requires an [`AuditEventRepository`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/audit/AuditEventRepository.html) bean. | | `beans` | Displays a complete list of all the Spring beans in your application. | | `caches` | Exposes available caches. | | `conditions` | Shows the conditions that were evaluated on configuration and auto-configuration classes and the reasons why they did or did not match. | | `configprops` | Displays a collated list of all [`@ConfigurationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationProperties.html). Subject to [sanitization](#actuator.endpoints.sanitization). | | `env` | Exposes properties from Spring’s [`ConfigurableEnvironment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/ConfigurableEnvironment.html). Subject to [sanitization](#actuator.endpoints.sanitization). | | `flyway` | Shows any Flyway database migrations that have been applied. Requires one or more [`Flyway`](https://javadoc.io/doc/org.flywaydb/flyway-core/12.4.0/org/flywaydb/core/Flyway.html) beans. | | `health` | Shows application health information. | | `httpexchanges` | Displays HTTP exchange information (by default, the last 100 HTTP request-response exchanges). Requires an [`HttpExchangeRepository`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/web/exchanges/HttpExchangeRepository.html) bean. | | `info` | Displays arbitrary application info. | | `integrationgraph` | Shows the Spring Integration graph. Requires a dependency on `spring-integration-core`. | | `loggers` | Shows and modifies the configuration of loggers in the application. | | `liquibase` | Shows any Liquibase database migrations that have been applied. Requires one or more [`Liquibase`](https://javadoc.io/doc/org.liquibase/liquibase-core/5.0.3/liquibase/Liquibase.html) beans. | | `metrics` | Shows “metrics” information for the current application to diagnose the metrics the application has recorded. | | `mappings` | Displays a collated list of all [`@RequestMapping`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/RequestMapping.html) paths. | | `quartz` | Shows information about Quartz Scheduler jobs. Subject to [sanitization](#actuator.endpoints.sanitization). | | `scheduledtasks` | Displays the scheduled tasks in your application. | | `sessions` | Allows retrieval and deletion of user sessions from a Spring Session-backed session store. Requires a servlet-based web application that uses Spring Session. | | `shutdown` | Lets the application be gracefully shutdown. Only works when using jar packaging. Disabled by default. | | `startup` | Shows the [startup steps data](../features/spring-application.html#features.spring-application.startup-tracking) collected by the [`ApplicationStartup`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/metrics/ApplicationStartup.html). Requires the [`SpringApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/SpringApplication.html) to be configured with a [`BufferingApplicationStartup`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/metrics/buffering/BufferingApplicationStartup.html). | | `threaddump` | Performs a thread dump. | If your application is a web application (Spring MVC, Spring WebFlux, or Jersey), you can use the following additional endpoints: | ID | Description | | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `heapdump` | Returns a heap dump file. On a HotSpot JVM, an `HPROF`-format file is returned. On an OpenJ9 JVM, a `PHD`-format file is returned. | | `logfile` | Returns the contents of the logfile (if the `logging.file.name` or the `logging.file.path` property has been set). Supports the use of the HTTP `Range` header to retrieve part of the log file’s content. | | `prometheus` | Exposes metrics in a format that can be scraped by a Prometheus server. Requires a dependency on `micrometer-registry-prometheus`. | ## [](#actuator.endpoints.controlling-access)Controlling Access to Endpoints By default, access to all endpoints except for `shutdown` and `heapdump` is unrestricted. To configure the permitted access to an endpoint, use its `management.endpoint..access` property. The following example allows unrestricted access to the `shutdown` endpoint: * Properties * YAML ```properties management.endpoint.shutdown.access=unrestricted ``` ```yaml management: endpoint: shutdown: access: unrestricted ``` If you prefer access to be opt-in rather than opt-out, set the `management.endpoints.access.default` property to `none` and use individual endpoint `access` properties to opt back in. The following example allows read-only access to the `loggers` endpoint and denies access to all other endpoints: * Properties * YAML ```properties management.endpoints.access.default=none management.endpoint.loggers.access=read-only ``` ```yaml management: endpoints: access: default: none endpoint: loggers: access: read-only ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Inaccessible endpoints are removed entirely from the application context. If you want to change only the technologies over which an endpoint is exposed, use the [`include` and `exclude` properties](#actuator.endpoints.exposing) instead. | ### [](#actuator.endpoints.controlling-access.limiting)Limiting Access Application-wide endpoint access can be limited using the `management.endpoints.access.max-permitted` property. This property takes precedence over the default access or an individual endpoint’s access level. Set it to `none` to make all endpoints inaccessible. Set it to `read-only` to only allow read access to endpoints. For [`@Endpoint`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/Endpoint.html), [`@JmxEndpoint`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/jmx/annotation/JmxEndpoint.html), and [`@WebEndpoint`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/web/annotation/WebEndpoint.html), read access equates to the endpoint methods annotated with [`@ReadOperation`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/ReadOperation.html). For [`@ControllerEndpoint`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/web/annotation/ControllerEndpoint.html) and [`@RestControllerEndpoint`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/web/annotation/RestControllerEndpoint.html), read access equates to request mappings that can handle `GET` and `HEAD` requests. For [`@ServletEndpoint`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/web/annotation/ServletEndpoint.html), read access equates to `GET` and `HEAD` requests. ## [](#actuator.endpoints.exposing)Exposing Endpoints By default, only the health endpoint is exposed over HTTP and JMX. Since Endpoints may contain sensitive information, you should carefully consider when to expose them. To change which endpoints are exposed, use the following technology-specific `include` and `exclude` properties: | Property | Default | | ------------------------------------------- | -------- | | `management.endpoints.jmx.exposure.exclude` | | | `management.endpoints.jmx.exposure.include` | `health` | | `management.endpoints.web.exposure.exclude` | | | `management.endpoints.web.exposure.include` | `health` | The `include` property lists the IDs of the endpoints that are exposed. The `exclude` property lists the IDs of the endpoints that should not be exposed. The `exclude` property takes precedence over the `include` property. You can configure both the `include` and the `exclude` properties with a list of endpoint IDs. For example, to only expose the `health` and `info` endpoints over JMX, use the following property: * Properties * YAML ```properties management.endpoints.jmx.exposure.include=health,info ``` ```yaml management: endpoints: jmx: exposure: include: "health,info" ``` `*` can be used to select all endpoints. For example, to expose everything over HTTP except the `env` and `beans` endpoints, use the following properties: * Properties * YAML ```properties management.endpoints.web.exposure.include=* management.endpoints.web.exposure.exclude=env,beans ``` ```yaml management: endpoints: web: exposure: include: "*" exclude: "env,beans" ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------- | | ** | `*` has a special meaning in YAML, so be sure to add quotation marks if you want to include (or exclude) all endpoints. | | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------- | | ** | If your application is exposed publicly, we strongly recommend that you also [secure your endpoints](#actuator.endpoints.security). | | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you want to implement your own strategy for when endpoints are exposed, you can register an [`EndpointFilter`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/EndpointFilter.html) bean. | ## [](#actuator.endpoints.security)Security For security purposes, only the `/health` endpoint is exposed over HTTP by default. You can use the `management.endpoints.web.exposure.include` property to configure the endpoints that are exposed. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Before setting the `management.endpoints.web.exposure.include`, ensure that the exposed actuators do not contain sensitive information, are secured by placing them behind a firewall, or are secured by something like Spring Security. | If Spring Security is on the classpath and no other [`SecurityFilterChain`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/SecurityFilterChain.html) bean is present, all actuators other than `/health` are secured by Spring Boot auto-configuration. If you define a custom [`SecurityFilterChain`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/SecurityFilterChain.html) bean, Spring Boot auto-configuration backs off and lets you fully control the actuator access rules. If you wish to configure custom security for HTTP endpoints (for example, to allow only users with a certain role to access them), Spring Boot provides some convenient [`RequestMatcher`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/util/matcher/RequestMatcher.html) objects that you can use in combination with Spring Security. A typical Spring Security configuration might look something like the following example: * Java * Kotlin ```java import org.springframework.boot.security.autoconfigure.actuate.web.servlet.EndpointRequest; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.web.SecurityFilterChain; import static org.springframework.security.config.Customizer.withDefaults; @Configuration(proxyBeanMethods = false) public class MySecurityConfiguration { @Bean public SecurityFilterChain securityFilterChain(HttpSecurity http) { http.securityMatcher(EndpointRequest.toAnyEndpoint()); http.authorizeHttpRequests((requests) -> requests.anyRequest().hasRole("ENDPOINT_ADMIN")); http.httpBasic(withDefaults()); return http.build(); } } ``` ```kotlin import org.springframework.boot.security.autoconfigure.actuate.web.servlet.EndpointRequest import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.security.config.Customizer.withDefaults import org.springframework.security.config.annotation.web.builders.HttpSecurity import org.springframework.security.web.SecurityFilterChain @Configuration(proxyBeanMethods = false) class MySecurityConfiguration { @Bean fun securityFilterChain(http: HttpSecurity): SecurityFilterChain { http.securityMatcher(EndpointRequest.toAnyEndpoint()).authorizeHttpRequests { requests -> requests.anyRequest().hasRole("ENDPOINT_ADMIN") } http.httpBasic(withDefaults()) return http.build() } } ``` The preceding example uses `EndpointRequest.toAnyEndpoint()` to match a request to any endpoint and then ensures that all have the `ENDPOINT_ADMIN` role. Several other matcher methods are also available on [`EndpointRequest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/security/autoconfigure/actuate/web/servlet/EndpointRequest.html). See the [API documentation](../../api/rest/actuator/index.html) for details. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | When matching for Actuator endpoints, `EndpointRequest.to("endpoint")` will consider the endpoint root and all its subpaths, effectively matching `"/actuator/endpoint/**"` even if the endpoint does not declare nested routes. | If you deploy applications behind a firewall, you may prefer that all your actuator endpoints can be accessed without requiring authentication. You can do so by changing the `management.endpoints.web.exposure.include` property, as follows: * Properties * YAML ```properties management.endpoints.web.exposure.include=* ``` ```yaml management: endpoints: web: exposure: include: "*" ``` Additionally, if Spring Security is present, you would need to add custom security configuration that allows unauthenticated access to the endpoints, as the following example shows: * Java * Kotlin ```java import org.springframework.boot.security.autoconfigure.actuate.web.servlet.EndpointRequest; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.web.SecurityFilterChain; @Configuration(proxyBeanMethods = false) public class MySecurityConfiguration { @Bean public SecurityFilterChain securityFilterChain(HttpSecurity http) { http.securityMatcher(EndpointRequest.toAnyEndpoint()); http.authorizeHttpRequests((requests) -> requests.anyRequest().permitAll()); return http.build(); } } ``` ```kotlin import org.springframework.boot.security.autoconfigure.actuate.web.servlet.EndpointRequest import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.security.config.annotation.web.builders.HttpSecurity import org.springframework.security.web.SecurityFilterChain @Configuration(proxyBeanMethods = false) class MySecurityConfiguration { @Bean fun securityFilterChain(http: HttpSecurity): SecurityFilterChain { http.securityMatcher(EndpointRequest.toAnyEndpoint()).authorizeHttpRequests { requests -> requests.anyRequest().permitAll() } return http.build() } } ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | In both of the preceding examples, the configuration applies only to the actuator endpoints. Since Spring Boot’s security configuration backs off completely in the presence of any [`SecurityFilterChain`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/SecurityFilterChain.html) bean, you need to configure an additional [`SecurityFilterChain`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/SecurityFilterChain.html) bean with rules that apply to the rest of the application. | ### [](#actuator.endpoints.security.csrf)Cross Site Request Forgery Protection Since Spring Boot relies on Spring Security’s defaults, CSRF protection is turned on by default. This means that the actuator endpoints that require a `POST` (shutdown and loggers endpoints), a `PUT`, or a `DELETE` get a 403 (forbidden) error when the default security configuration is in use. | | | | -- | ------------------------------------------------------------------------------------------------------------------------- | | ** | We recommend disabling CSRF protection completely only if you are creating a service that is used by non-browser clients. | You can find additional information about CSRF protection in the [Spring Security Reference Guide](https://docs.spring.io/spring-security/reference/7.1/features/exploits/csrf.html). ## [](#actuator.endpoints.caching)Configuring Endpoints Endpoints automatically cache responses to read operations that do not take any parameters. To configure the amount of time for which an endpoint caches a response, use its `cache.time-to-live` property. The following example sets the time-to-live of the `beans` endpoint’s cache to 10 seconds: * Properties * YAML ```properties management.endpoint.beans.cache.time-to-live=10s ``` ```yaml management: endpoint: beans: cache: time-to-live: "10s" ``` | | | | -- | -------------------------------------------------------------------------------------------------- | | ** | The `management.endpoint.` prefix uniquely identifies the endpoint that is being configured. | ## [](#actuator.endpoints.sanitization)Sanitize Sensitive Values Information returned by the `/env`, `/configprops` and `/quartz` endpoints can be sensitive, so by default values are always fully sanitized (replaced by `******`). Values can only be viewed in an unsanitized form when: * The `show-values` property has been set to something other than `never` * No custom [`SanitizingFunction`](../../how-to/actuator.html#howto.actuator.customizing-sanitization) beans apply The `show-values` property can be configured for sanitizable endpoints to one of the following values: * `never` - values are always fully sanitized (replaced by `******`) * `always` - values are shown to all users (as long as no [`SanitizingFunction`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/SanitizingFunction.html) bean applies) * `when-authorized` - values are shown only to authorized users (as long as no [`SanitizingFunction`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/SanitizingFunction.html) bean applies) For HTTP endpoints, a user is considered to be authorized if they have authenticated and have the roles configured by the endpoint’s roles property. By default, any authenticated user is authorized. For JMX endpoints, all users are always authorized. The following example allows all users with the `admin` role to view values from the `/env` endpoint in their original form. Unauthorized users, or users without the `admin` role, will see only sanitized values. * Properties * YAML ```properties management.endpoint.env.show-values=when-authorized management.endpoint.env.roles=admin ``` ```yaml management: endpoint: env: show-values: when-authorized roles: "admin" ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | This example assumes that no [`SanitizingFunction`](../../how-to/actuator.html#howto.actuator.customizing-sanitization) beans have been defined. | ## [](#actuator.endpoints.hypermedia)Hypermedia for Actuator Web Endpoints A “discovery page” is added with links to all the endpoints. The “discovery page” is available on `/actuator` by default. To disable the “discovery page”, add the following property to your application properties: * Properties * YAML ```properties management.endpoints.web.discovery.enabled=false ``` ```yaml management: endpoints: web: discovery: enabled: false ``` When a custom management context path is configured, the “discovery page” automatically moves from `/actuator` to the root of the management context. For example, if the management context path is `/management`, the discovery page is available from `/management`. When the management context path is set to `/`, the discovery page is disabled to prevent the possibility of a clash with other mappings. ## [](#actuator.endpoints.cors)CORS Support [Cross-origin resource sharing](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) (CORS) is a [W3C specification](https://www.w3.org/TR/cors/) that lets you specify in a flexible way what kind of cross-domain requests are authorized. If you use Spring MVC or Spring WebFlux, you can configure Actuator’s web endpoints to support such scenarios. CORS support is disabled by default and is only enabled once you have set the `management.endpoints.web.cors.allowed-origins` property. The following configuration permits `GET` and `POST` calls from the `example.com` domain: * Properties * YAML ```properties management.endpoints.web.cors.allowed-origins=https://example.com management.endpoints.web.cors.allowed-methods=GET,POST ``` ```yaml management: endpoints: web: cors: allowed-origins: "https://example.com" allowed-methods: "GET,POST" ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | See [`CorsEndpointProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/CorsEndpointProperties.html) for a complete list of options. | ## [](#actuator.endpoints.json)JSON When working with JSON, Jackson is used for serialization and deserialization. By default, an isolated [`JsonMapper`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.html) is used. This isolation means that it does not share the same configuration as the application’s `JsonMapper` and it is not affected by `spring.jackson.*` properties. To disable this behavior and configure Actuator to use the application’s `JsonMapper`, set `management.endpoints.jackson.isolated-json-mapper` to `false`. Alternatively, you can define your own [`EndpointJsonMapper`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/jackson/EndpointJsonMapper.html) bean that produces a `JsonMapper` that meets your needs. Actuator will then use it for JSON processing. ## [](#actuator.endpoints.implementing-custom)Implementing Custom Endpoints If you add a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) annotated with [`@Endpoint`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/Endpoint.html), any methods annotated with [`@ReadOperation`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/ReadOperation.html), [`@WriteOperation`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/WriteOperation.html), or [`@DeleteOperation`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/DeleteOperation.html) are automatically exposed over JMX and, in a web application, over HTTP as well. Endpoints can be exposed over HTTP by using Jersey, Spring MVC, or Spring WebFlux. If both Jersey and Spring MVC are available, Spring MVC is used. The following example exposes a read operation that returns a custom object: * Java * Kotlin ```java @ReadOperation public CustomData getData() { return new CustomData("test", 5); } ``` ```kotlin @ReadOperation fun getData(): CustomData { return CustomData("test", 5) } ``` You can also write technology-specific endpoints by using [`@JmxEndpoint`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/jmx/annotation/JmxEndpoint.html) or [`@WebEndpoint`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/web/annotation/WebEndpoint.html). These endpoints are restricted to their respective technologies. For example, [`@WebEndpoint`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/web/annotation/WebEndpoint.html) is exposed only over HTTP and not over JMX. You can write technology-specific extensions by using [`@EndpointWebExtension`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/web/annotation/EndpointWebExtension.html) and [`@EndpointJmxExtension`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/jmx/annotation/EndpointJmxExtension.html). These annotations let you provide technology-specific operations to augment an existing endpoint. An endpoint may have at most one extension of each type. Finally, if you need access to web-framework-specific functionality, you can implement servlet or Spring [`@Controller`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Controller.html) and [`@RestController`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/bind/annotation/RestController.html) endpoints at the cost of them not being available over JMX or when using a different web framework. ### [](#actuator.endpoints.implementing-custom.input)Receiving Input Operations on an endpoint receive input through their parameters. When exposed over the web, the values for these parameters are taken from the URL’s query parameters and from the JSON request body. When exposed over JMX, the parameters are mapped to the parameters of the MBean’s operations. Parameters are required by default. They can be made optional by annotating them with JSpecify’s [`@Nullable`](https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html). Kotlin null safety is also supported. You can map each root property in the JSON request body to a parameter of the endpoint. Consider the following JSON request body: ```json { "name": "test", "counter": 42 } ``` You can use this to invoke a write operation that takes `String name` and `int counter` parameters, as the following example shows: * Java * Kotlin ```java @WriteOperation public void updateData(String name, int counter) { // injects "test" and 42 } ``` ```kotlin @WriteOperation fun updateData(name: String?, counter: Int) { // injects "test" and 42 } ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Because endpoints are technology agnostic, only simple types can be specified in the method signature. In particular, declaring a single parameter with a [`CustomData`](https://javadoc.io/doc/org.liquibase/liquibase-core/5.0.3/liquibase/report/CustomData.html) type that defines a `name` and `counter` properties is not supported. | | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | To let the input be mapped to the operation method’s parameters, Java code that implements an endpoint should be compiled with `-parameters`. For Kotlin code, please review [the recommendation](https://docs.spring.io/spring-framework/reference/7.0/languages/kotlin/classes-interfaces.html) of the Spring Framework reference. This will happen automatically if you use Spring Boot’s Gradle plugin or if you use Maven and `spring-boot-starter-parent`. | #### [](#actuator.endpoints.implementing-custom.input.conversion)Input Type Conversion The parameters passed to endpoint operation methods are, if necessary, automatically converted to the required type. Before calling an operation method, the input received over JMX or HTTP is converted to the required types by using an instance of [`ApplicationConversionService`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/convert/ApplicationConversionService.html) as well as any [`Converter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/convert/converter/Converter.html) or [`GenericConverter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/convert/converter/GenericConverter.html) beans qualified with [`@EndpointConverter`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/EndpointConverter.html). ### [](#actuator.endpoints.implementing-custom.web)Custom Web Endpoints Operations on an [`@Endpoint`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/Endpoint.html), [`@WebEndpoint`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/web/annotation/WebEndpoint.html), or [`@EndpointWebExtension`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/web/annotation/EndpointWebExtension.html) are automatically exposed over HTTP using Jersey, Spring MVC, or Spring WebFlux. If both Jersey and Spring MVC are available, Spring MVC is used. #### [](#actuator.endpoints.implementing-custom.web.request-predicates)Web Endpoint Request Predicates A request predicate is automatically generated for each operation on a web-exposed endpoint. #### [](#actuator.endpoints.implementing-custom.web.path-predicates)Path The path of the predicate is determined by the ID of the endpoint and the base path of the web-exposed endpoints. The default base path is `/actuator`. For example, an endpoint with an ID of `sessions` uses `/actuator/sessions` as its path in the predicate. You can further customize the path by annotating one or more parameters of the operation method with [`@Selector`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/Selector.html). Such a parameter is added to the path predicate as a path variable. The variable’s value is passed into the operation method when the endpoint operation is invoked. If you want to capture all remaining path elements, you can add `@Selector(Match=ALL_REMAINING)` to the last parameter and make it a type that is conversion-compatible with a `String[]`. #### [](#actuator.endpoints.implementing-custom.web.method-predicates)HTTP method The HTTP method of the predicate is determined by the operation type, as shown in the following table: | Operation | HTTP method | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | | [`@ReadOperation`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/ReadOperation.html) | `GET` | | [`@WriteOperation`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/WriteOperation.html) | `POST` | | [`@DeleteOperation`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/DeleteOperation.html) | `DELETE` | #### [](#actuator.endpoints.implementing-custom.web.consumes-predicates)Consumes For a [`@WriteOperation`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/WriteOperation.html) (HTTP `POST`) that uses the request body, the `consumes` clause of the predicate is `application/vnd.spring-boot.actuator.v2+json, application/json`. For all other operations, the `consumes` clause is empty. #### [](#actuator.endpoints.implementing-custom.web.produces-predicates)Produces The `produces` clause of the predicate can be determined by the `produces` attribute of the [`@DeleteOperation`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/DeleteOperation.html), [`@ReadOperation`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/ReadOperation.html), and [`@WriteOperation`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/WriteOperation.html) annotations. The attribute is optional. If it is not used, the `produces` clause is determined automatically. If the operation method returns `void` or [`Void`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html), the `produces` clause is empty. If the operation method returns a [`Resource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/io/Resource.html), the `produces` clause is `application/octet-stream`. For all other operations, the `produces` clause is `application/vnd.spring-boot.actuator.v2+json, application/json`. #### [](#actuator.endpoints.implementing-custom.web.response-status)Web Endpoint Response Status The default response status for an endpoint operation depends on the operation type (read, write, or delete) and what, if anything, the operation returns. If a [`@ReadOperation`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/ReadOperation.html) returns a value, the response status will be 200 (OK). If it does not return a value, the response status will be 404 (Not Found). If a [`@WriteOperation`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/WriteOperation.html) or [`@DeleteOperation`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/annotation/DeleteOperation.html) returns a value, the response status will be 200 (OK). If it does not return a value, the response status will be 204 (No Content). If an operation is invoked without a required parameter or with a parameter that cannot be converted to the required type, the operation method is not called, and the response status will be 400 (Bad Request). #### [](#actuator.endpoints.implementing-custom.web.range-requests)Web Endpoint Range Requests You can use an HTTP range request to request part of an HTTP resource. When using Spring MVC or Spring Web Flux, operations that return a [`Resource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/io/Resource.html) automatically support range requests. | | | | -- | --------------------------------------------------- | | ** | Range requests are not supported when using Jersey. | #### [](#actuator.endpoints.implementing-custom.web.security)Web Endpoint Security An operation on a web endpoint or a web-specific endpoint extension can receive the current [`Principal`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/security/Principal.html) or [`SecurityContext`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/SecurityContext.html) as a method parameter. The former is typically used in conjunction with [`@Nullable`](https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html) to provide different behavior for authenticated and unauthenticated users. The latter is typically used to perform authorization checks by using its `isUserInRole(String)` method. ## [](#actuator.endpoints.health)Health Information You can use health information to check the status of your running application. It is often used by monitoring software to alert someone when a production system goes down. The information exposed by the `health` endpoint depends on the `management.endpoint.health.show-details` and `management.endpoint.health.show-components` properties, which can be configured with one of the following values: | Name | Description | | ----------------- | --------------------------------------------------------------------------------------------------------------------------- | | `never` | Details are never shown. | | `when-authorized` | Details are shown only to authorized users. Authorized roles can be configured by using `management.endpoint.health.roles`. | | `always` | Details are shown to all users. | The default value is `never`. A user is considered to be authorized when they are in one or more of the endpoint’s roles. If the endpoint has no configured roles (the default), all authenticated users are considered to be authorized. You can configure the roles by using the `management.endpoint.health.roles` property. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you have secured your application and wish to use `always`, your security configuration must permit access to the health endpoint for both authenticated and unauthenticated users. | Health information is collected from the content of a [`HealthContributorRegistry`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/registry/HealthContributorRegistry.html) (by default, all [`HealthContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthContributor.html) instances defined in your [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html)). Spring Boot includes a number of auto-configured [`HealthContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthContributor.html) beans, and you can also write your own. A [`HealthContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthContributor.html) can be either a [`HealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthIndicator.html) or a [`CompositeHealthContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/CompositeHealthContributor.html). A [`HealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthIndicator.html) provides actual health information, including a [`Status`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/Status.html). A [`CompositeHealthContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/CompositeHealthContributor.html) provides a composite of other [`HealthContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthContributor.html) instances. Taken together, contributors form a tree structure to represent the overall system health. By default, the final system health is derived by a [`StatusAggregator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/actuate/endpoint/StatusAggregator.html), which sorts the statuses from each [`HealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthIndicator.html) based on an ordered list of statuses. The first status in the sorted list is used as the overall health status. If no [`HealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthIndicator.html) returns a status that is known to the [`StatusAggregator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/actuate/endpoint/StatusAggregator.html), an `UNKNOWN` status is used. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can use the [`HealthContributorRegistry`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/registry/HealthContributorRegistry.html) to register and unregister health indicators at runtime. | ### [](#actuator.endpoints.health.auto-configured-health-indicators)Auto-configured HealthIndicators When appropriate, Spring Boot auto-configures the [`HealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthIndicator.html) beans listed in the following table. You can also enable or disable selected indicators by configuring `management.health.key.enabled`, with the `key` listed in the following table: | Key | Name | Description | | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | `cassandra` | [`CassandraDriverHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/cassandra/health/CassandraDriverHealthIndicator.html) | Checks that a Cassandra database is up. | | `couchbase` | [`CouchbaseHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/couchbase/health/CouchbaseHealthIndicator.html) | Checks that a Couchbase cluster is up. | | `db` | [`DataSourceHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/health/DataSourceHealthIndicator.html) | Checks that a connection to [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) can be obtained. | | `diskspace` | [`DiskSpaceHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/application/DiskSpaceHealthIndicator.html) | Checks for low disk space. | | `elasticsearch` | [`ElasticsearchRestClientHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/elasticsearch/health/ElasticsearchRestClientHealthIndicator.html) | Checks that an Elasticsearch cluster is up. | | `hazelcast` | [`HazelcastHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/hazelcast/health/HazelcastHealthIndicator.html) | Checks that a Hazelcast server is up. | | `jms` | [`JmsHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jms/health/JmsHealthIndicator.html) | Checks that a JMS broker is up. | | `ldap` | [`LdapHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/ldap/health/LdapHealthIndicator.html) | Checks that an LDAP server is up. | | `mail` | [`MailHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/mail/health/MailHealthIndicator.html) | Checks that a mail server is up. | | `mongodb` | [`MongoHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/mongodb/health/MongoHealthIndicator.html) | Checks that a Mongo database is up. | | `neo4j` | [`Neo4jHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/neo4j/health/Neo4jHealthIndicator.html) | Checks that a Neo4j database is up. | | `ping` | [`PingHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/PingHealthIndicator.html) | Always responds with `UP`. | | `rabbit` | [`RabbitHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/amqp/health/RabbitHealthIndicator.html) | Checks that a Rabbit server is up. | | `redis` | [`DataRedisHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/redis/health/DataRedisHealthIndicator.html) | Checks that a Redis server is up. | | `ssl` | [`SslHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/application/SslHealthIndicator.html) | Checks that SSL certificates are ok. | | | | | -- | -------------------------------------------------------------------------------------- | | ** | You can disable them all by setting the `management.health.defaults.enabled` property. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The `ssl` [`HealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthIndicator.html) has a "warning threshold" property named `management.health.ssl.certificate-validity-warning-threshold`. You can use this threshold to give yourself enough lead time to rotate the soon-to-be-expired certificate. If an SSL certificate will become invalid within the period defined by this threshold, the [`HealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthIndicator.html) will report this in the details section of its response where `details.validChains.certificates.[*].validity.status` will have the value `WILL_EXPIRE_SOON`. | Additional [`HealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthIndicator.html) beans are enabled by default: | Key | Name | Description | | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | | `livenessstate` | [`LivenessStateHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/application/LivenessStateHealthIndicator.html) | Exposes the “Liveness” application availability state. | | `readinessstate` | [`ReadinessStateHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/application/ReadinessStateHealthIndicator.html) | Exposes the “Readiness” application availability state. | These can be disabled by using the `management.endpoint.health.probes.enabled` configuration property. ### [](#actuator.endpoints.health.writing-custom-health-indicators)Writing Custom HealthIndicators To provide custom health information, you can register Spring beans that implement the [`HealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthIndicator.html) interface. You need to provide an implementation of the `health()` method and return a [`Health`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/Health.html) response. The [`Health`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/Health.html) response should include a status and can optionally include additional details to be displayed. The following code shows a sample [`HealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthIndicator.html) implementation: * Java * Kotlin ```java import org.springframework.boot.health.contributor.Health; import org.springframework.boot.health.contributor.HealthIndicator; import org.springframework.stereotype.Component; @Component public class MyHealthIndicator implements HealthIndicator { @Override public Health health() { int errorCode = check(); if (errorCode != 0) { return Health.down().withDetail("Error Code", errorCode).build(); } return Health.up().build(); } private int check() { // perform some specific health check return ... } } ``` ```kotlin import org.springframework.boot.health.contributor.Health import org.springframework.boot.health.contributor.HealthIndicator import org.springframework.stereotype.Component @Component class MyHealthIndicator : HealthIndicator { override fun health(): Health { val errorCode = check() if (errorCode != 0) { return Health.down().withDetail("Error Code", errorCode).build() } return Health.up().build() } private fun check(): Int { // perform some specific health check return ... } } ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The identifier for a given [`HealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthIndicator.html) is the name of the bean without the [`HealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthIndicator.html) suffix, if it exists. In the preceding example, the health information is available in an entry named `my`. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Health indicators are usually called over HTTP and need to respond before any connection timeouts. Spring Boot will log a warning message for any health indicator that takes longer than 10 seconds to respond. If you want to configure this threshold, you can use the `management.endpoint.health.logging.slow-indicator-threshold` property. | In addition to Spring Boot’s predefined [`Status`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/Status.html) types, [`Health`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/Health.html) can return a custom [`Status`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/Status.html) that represents a new system state. In such cases, you also need to provide a custom implementation of the [`StatusAggregator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/actuate/endpoint/StatusAggregator.html) interface, or you must configure the default implementation by using the `management.endpoint.health.status.order` configuration property. For example, assume a new [`Status`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/Status.html) with a code of `FATAL` is being used in one of your [`HealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthIndicator.html) implementations. To configure the severity order, add the following property to your application properties: * Properties * YAML ```properties management.endpoint.health.status.order=fatal,down,out-of-service,unknown,up ``` ```yaml management: endpoint: health: status: order: "fatal,down,out-of-service,unknown,up" ``` The HTTP status code in the response reflects the overall health status. By default, `OUT_OF_SERVICE` and `DOWN` map to 503. Any unmapped health statuses, including `UP`, map to 200. You might also want to register custom status mappings if you access the health endpoint over HTTP. Configuring a custom mapping disables the defaults mappings for `DOWN` and `OUT_OF_SERVICE`. If you want to retain the default mappings, you must explicitly configure them, alongside any custom mappings. For example, the following property maps `FATAL` to 503 (service unavailable) and retains the default mappings for `DOWN` and `OUT_OF_SERVICE`: * Properties * YAML ```properties management.endpoint.health.status.http-mapping.down=503 management.endpoint.health.status.http-mapping.fatal=503 management.endpoint.health.status.http-mapping.out-of-service=503 ``` ```yaml management: endpoint: health: status: http-mapping: down: 503 fatal: 503 out-of-service: 503 ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you need more control, you can define your own [`HttpCodeStatusMapper`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/actuate/endpoint/HttpCodeStatusMapper.html) bean. | The following table shows the default status mappings for the built-in statuses: | Status | Mapping | | ---------------- | ---------------------------------------------- | | `DOWN` | `SERVICE_UNAVAILABLE` (`503`) | | `OUT_OF_SERVICE` | `SERVICE_UNAVAILABLE` (`503`) | | `UP` | No mapping by default, so HTTP status is `200` | | `UNKNOWN` | No mapping by default, so HTTP status is `200` | ### [](#actuator.endpoints.health.reactive-health-indicators)Reactive Health Indicators For reactive applications, such as those that use Spring WebFlux, [`ReactiveHealthContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/ReactiveHealthContributor.html) provides a non-blocking contract for getting application health. Similar to a traditional [`HealthContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthContributor.html), health information is collected from the content of a [`ReactiveHealthContributorRegistry`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/registry/ReactiveHealthContributorRegistry.html) (by default, all [`HealthContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthContributor.html) and [`ReactiveHealthContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/ReactiveHealthContributor.html) instances defined in your [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html)). Regular [`HealthContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthContributor.html) instances that do not check against a reactive API are executed on the elastic scheduler. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | In a reactive application, you should use the [`ReactiveHealthContributorRegistry`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/registry/ReactiveHealthContributorRegistry.html) to register and unregister health indicators at runtime. If you need to register a regular [`HealthContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthContributor.html), you should wrap it with `ReactiveHealthContributor#adapt`. | To provide custom health information from a reactive API, you can register Spring beans that implement the [`ReactiveHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/ReactiveHealthIndicator.html) interface. The following code shows a sample [`ReactiveHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/ReactiveHealthIndicator.html) implementation: * Java * Kotlin ```java import reactor.core.publisher.Mono; import org.springframework.boot.health.contributor.Health; import org.springframework.boot.health.contributor.ReactiveHealthIndicator; import org.springframework.stereotype.Component; @Component public class MyReactiveHealthIndicator implements ReactiveHealthIndicator { @Override public Mono health() { return doHealthCheck().onErrorResume((exception) -> Mono.just(new Health.Builder().down(exception).build())); } private Mono doHealthCheck() { // perform some specific health check return ... } } ``` ```kotlin import org.springframework.boot.health.contributor.Health import org.springframework.boot.health.contributor.ReactiveHealthIndicator import org.springframework.stereotype.Component import reactor.core.publisher.Mono @Component class MyReactiveHealthIndicator : ReactiveHealthIndicator { override fun health(): Mono { return doHealthCheck().onErrorResume { exception: Throwable -> Mono.just(Health.Builder().down(exception).build()) } } private fun doHealthCheck(): Mono { // perform some specific health check return ... } } ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | To handle the error automatically, consider extending from [`AbstractReactiveHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/AbstractReactiveHealthIndicator.html). | ### [](#actuator.endpoints.health.auto-configured-reactive-health-indicators)Auto-configured ReactiveHealthIndicators When appropriate, Spring Boot auto-configures the following [`ReactiveHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/ReactiveHealthIndicator.html) beans: | Key | Name | Description | | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------- | | `cassandra` | [`CassandraDriverReactiveHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/cassandra/health/CassandraDriverReactiveHealthIndicator.html) | Checks that a Cassandra database is up. | | `couchbase` | [`CouchbaseReactiveHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/couchbase/health/CouchbaseReactiveHealthIndicator.html) | Checks that a Couchbase cluster is up. | | `elasticsearch` | [`DataElasticsearchReactiveHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/elasticsearch/health/DataElasticsearchReactiveHealthIndicator.html) | Checks that an Elasticsearch cluster is up. | | `mongodb` | [`MongoReactiveHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/mongodb/health/MongoReactiveHealthIndicator.html) | Checks that a Mongo database is up. | | `neo4j` | [`Neo4jReactiveHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/neo4j/health/Neo4jReactiveHealthIndicator.html) | Checks that a Neo4j database is up. | | `redis` | [`DataRedisReactiveHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/redis/health/DataRedisReactiveHealthIndicator.html) | Checks that a Redis server is up. | | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If necessary, reactive indicators replace the regular ones. Also, any [`HealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthIndicator.html) that is not handled explicitly is wrapped automatically. | ### [](#actuator.endpoints.health.groups)Health Groups It is sometimes useful to organize health indicators into groups that you can use for different purposes. To create a health indicator group, you can use the `management.endpoint.health.group.` property and specify a list of health indicator IDs to `include` or `exclude`. For example, to create a group that includes only database indicators you can define the following: * Properties * YAML ```properties management.endpoint.health.group.custom.include=db ``` ```yaml management: endpoint: health: group: custom: include: "db" ``` You can then check the result by hitting `localhost:8080/actuator/health/custom`. Similarly, to create a group that excludes the database indicators from the group and includes all the other indicators, you can define the following: * Properties * YAML ```properties management.endpoint.health.group.custom.exclude=db ``` ```yaml management: endpoint: health: group: custom: exclude: "db" ``` By default, startup will fail if a health group includes or excludes a health indicator that does not exist. To disable this behavior set `management.endpoint.health.validate-group-membership` to `false`. By default, groups inherit the same [`StatusAggregator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/actuate/endpoint/StatusAggregator.html) and [`HttpCodeStatusMapper`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/actuate/endpoint/HttpCodeStatusMapper.html) settings as the system health. However, you can also define these on a per-group basis. You can also override the `show-details` and `roles` properties if required: * Properties * YAML ```properties management.endpoint.health.group.custom.show-details=when-authorized management.endpoint.health.group.custom.roles=admin management.endpoint.health.group.custom.status.order=fatal,up management.endpoint.health.group.custom.status.http-mapping.fatal=500 management.endpoint.health.group.custom.status.http-mapping.out-of-service=500 ``` ```yaml management: endpoint: health: group: custom: show-details: "when-authorized" roles: "admin" status: order: "fatal,up" http-mapping: fatal: 500 out-of-service: 500 ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can use `@Qualifier("groupname")` if you need to register custom [`StatusAggregator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/actuate/endpoint/StatusAggregator.html) or [`HttpCodeStatusMapper`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/actuate/endpoint/HttpCodeStatusMapper.html) beans for use with the group. | A health group can also include/exclude a [`CompositeHealthContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/CompositeHealthContributor.html). You can also include/exclude only a certain component of a [`CompositeHealthContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/CompositeHealthContributor.html). This can be done using the fully qualified name of the component as follows: ```properties management.endpoint.health.group.custom.include="test/primary" management.endpoint.health.group.custom.exclude="test/primary/b" ``` In the example above, the `custom` group will include the [`HealthContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthContributor.html) with the name `primary` which is a component of the composite `test`. Here, `primary` itself is a composite and the [`HealthContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/contributor/HealthContributor.html) with the name `b` will be excluded from the `custom` group. Health groups can be made available at an additional path on either the main or management port. This is useful in cloud environments such as Kubernetes, where it is quite common to use a separate management port for the actuator endpoints for security purposes. Having a separate port could lead to unreliable health checks because the main application might not work properly even if the health check is successful. The health group can be configured with an additional path as follows: ```properties management.endpoint.health.group.live.additional-path="server:/healthz" ``` This would make the `live` health group available on the main server port at `/healthz`. The prefix is mandatory and must be either `server:` (represents the main server port) or `management:` (represents the management port, if configured.) The path must be a single path segment. ### [](#actuator.endpoints.health.datasource)DataSource Health The [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) health indicator shows the health of both standard data sources and routing data source beans. The health of a routing data source includes the health of each of its target data sources. In the health endpoint’s response, each of a routing data source’s targets is named by using its routing key. If you prefer not to include routing data sources in the indicator’s output, set `management.health.db.ignore-routing-data-sources` to `true`. ## [](#actuator.endpoints.kubernetes-probes)Kubernetes Probes Applications deployed on Kubernetes can provide information about their internal state with [Container Probes](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes). Depending on [your Kubernetes configuration](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/), the kubelet calls those probes and reacts to the result. By default, Spring Boot manages your [Application Availability](../features/spring-application.html#features.spring-application.application-availability) state. If deployed in a Kubernetes environment, actuator gathers the “Liveness” and “Readiness” information from the [`ApplicationAvailability`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/availability/ApplicationAvailability.html) interface and uses that information in dedicated [health indicators](#actuator.endpoints.health.auto-configured-health-indicators): [`LivenessStateHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/application/LivenessStateHealthIndicator.html) and [`ReadinessStateHealthIndicator`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/health/application/ReadinessStateHealthIndicator.html). These indicators are shown on the global health endpoint (`"/actuator/health"`). They are also exposed as separate HTTP Probes by using [health groups](#actuator.endpoints.health.groups): `"/actuator/health/liveness"` and `"/actuator/health/readiness"`. You can then configure your Kubernetes infrastructure with the following endpoint information: ```yaml livenessProbe: httpGet: path: "/actuator/health/liveness" port: failureThreshold: ... periodSeconds: ... readinessProbe: httpGet: path: "/actuator/health/readiness" port: failureThreshold: ... periodSeconds: ... ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | `` should be set to the port that the actuator endpoints are available on. It could be the main web server port or a separate management port if the `"management.server.port"` property has been set. | These health groups are automatically enabled. You can disable them by using the `management.endpoint.health.probes.enabled` configuration property. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If an application takes longer to start than the configured liveness period, Kubernetes [mentions the `"startupProbe"` as a possible solution](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#when-should-you-use-a-startup-probe). Generally speaking, the `"startupProbe"` is not necessarily needed here as the `"readinessProbe"` fails until all startup tasks are done. This means your application will not receive traffic until it is ready. However, if your application takes a long time to start, consider [configuring a `"startupProbe"`](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-startup-probes) that uses the liveness HTTP probe to make sure that Kubernetes won’t kill your application while it is in the process of starting. See the section that describes [how probes behave during the application lifecycle](#actuator.endpoints.kubernetes-probes.lifecycle). | If your Actuator endpoints are deployed on a separate management context, the endpoints do not use the same web infrastructure (port, connection pools, framework components) as the main application. In this case, a probe check could be successful even if the main application does not work properly (for example, it cannot accept new connections). For this reason, it is a good idea to make the `liveness` and `readiness` health groups available on the main server port. This can be done by setting the following property: ```properties management.endpoint.health.probes.add-additional-paths=true ``` This would make the `liveness` group available at `/livez` and the `readiness` group available at `/readyz` on the main server port. Paths can be customized using the `additional-path` property on each group, see [health groups](#actuator.endpoints.health.groups) for details. ### [](#actuator.endpoints.kubernetes-probes.external-state)Checking External State With Kubernetes Probes Actuator configures the “liveness” and “readiness” probes as Health Groups. This means that all the [health groups features](#actuator.endpoints.health.groups) are available for them. You can, for example, configure additional Health Indicators: * Properties * YAML ```properties management.endpoint.health.group.readiness.include=readinessState,customCheck ``` ```yaml management: endpoint: health: group: readiness: include: "readinessState,customCheck" ``` By default, Spring Boot does not add other health indicators to these groups. The “liveness” probe should not depend on health checks for external systems. If the [liveness state of an application](../features/spring-application.html#features.spring-application.application-availability.liveness) is broken, Kubernetes tries to solve that problem by restarting the application instance. This means that if an external system (such as a database, a Web API, or an external cache) fails, Kubernetes might restart all application instances and create cascading failures. As for the “readiness” probe, the choice of checking external systems must be made carefully by the application developers. For this reason, Spring Boot does not include any additional health checks in the readiness probe. If the [readiness state of an application instance](../features/spring-application.html#features.spring-application.application-availability.readiness) is unready, Kubernetes does not route traffic to that instance. Some external systems might not be shared by application instances, in which case they could be included in a readiness probe. Other external systems might not be essential to the application (the application could have circuit breakers and fallbacks), in which case they definitely should not be included. Unfortunately, an external system that is shared by all application instances is common, and you have to make a judgement call: Include it in the readiness probe and expect that the application is taken out of service when the external service is down or leave it out and deal with failures higher up the stack, perhaps by using a circuit breaker in the caller. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If all instances of an application are unready, a Kubernetes Service with `type=ClusterIP` or `NodePort` does not accept any incoming connections. There is no HTTP error response (503 and so on), since there is no connection. A service with `type=LoadBalancer` might or might not accept connections, depending on the provider. A service that has an explicit [ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) also responds in a way that depends on the implementation — the ingress service itself has to decide how to handle the “connection refused” from downstream. HTTP 503 is quite likely in the case of both load balancer and ingress. | Also, if an application uses Kubernetes [autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/), it may react differently to applications being taken out of the load-balancer, depending on its autoscaler configuration. ### [](#actuator.endpoints.kubernetes-probes.lifecycle)Application Lifecycle and Probe States An important aspect of the Kubernetes Probes support is its consistency with the application lifecycle. There is a significant difference between the [`AvailabilityState`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/availability/AvailabilityState.html) (which is the in-memory, internal state of the application) and the actual probe (which exposes that state). Depending on the phase of application lifecycle, the probe might not be available. Spring Boot publishes [application events during startup and shutdown](../features/spring-application.html#features.spring-application.application-events-and-listeners), and probes can listen to such events and expose the [`AvailabilityState`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/availability/AvailabilityState.html) information. The following tables show the [`AvailabilityState`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/availability/AvailabilityState.html) and the state of HTTP connectors at different stages. When a Spring Boot application starts: | Startup phase | LivenessState | ReadinessState | HTTP server | Notes | | ------------- | ------------- | ------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------- | | Starting | `BROKEN` | `REFUSING_TRAFFIC` | Not started | Kubernetes checks the "liveness" Probe and restarts the application if it takes too long. | | Started | `CORRECT` | `REFUSING_TRAFFIC` | Refuses requests | The application context is refreshed. The application performs startup tasks and does not receive traffic yet. | | Ready | `CORRECT` | `ACCEPTING_TRAFFIC` | Accepts requests | Startup tasks are finished. The application is receiving traffic. | When a Spring Boot application shuts down: | Shutdown phase | Liveness State | Readiness State | HTTP server | Notes | | ----------------- | -------------- | ------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Running | `CORRECT` | `ACCEPTING_TRAFFIC` | Accepts requests | Shutdown has been requested. | | Graceful shutdown | `CORRECT` | `REFUSING_TRAFFIC` | New requests are rejected | If enabled, [graceful shutdown processes in-flight requests](../web/graceful-shutdown.html). HTTP probes also stop accepting traffic, so the availability states are not readily available externally. | | Shutdown complete | N/A | N/A | Server is shut down | The application context is closed and the application is shut down. | | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | See [Kubernetes Container Lifecycle](../../how-to/deployment/cloud.html#howto.deployment.cloud.kubernetes.container-lifecycle) for more information about Kubernetes deployment. In particular, it describes how to use the `preStop` hook to give your application time to shut down gracefully before Kubernetes kills it. | ## [](#actuator.endpoints.info)Application Information Application information exposes various information collected from all [`InfoContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/info/InfoContributor.html) beans defined in your [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html). Spring Boot includes a number of auto-configured [`InfoContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/info/InfoContributor.html) beans, and you can write your own. ### [](#actuator.endpoints.info.auto-configured-info-contributors)Auto-configured InfoContributors When appropriate, Spring auto-configures the following [`InfoContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/info/InfoContributor.html) beans: | ID | Name | Description | Prerequisites | | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | | `build` | [`BuildInfoContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/info/BuildInfoContributor.html) | Exposes build information. | A `META-INF/build-info.properties` resource. | | `env` | [`EnvironmentInfoContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/info/EnvironmentInfoContributor.html) | Exposes any property from the [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) whose name starts with `info.`. | None. | | `git` | [`GitInfoContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/info/GitInfoContributor.html) | Exposes git information. | A `git.properties` resource. | | `java` | [`JavaInfoContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/info/JavaInfoContributor.html) | Exposes Java runtime information. | None. | | `os` | [`OsInfoContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/info/OsInfoContributor.html) | Exposes Operating System information. | None. | | `process` | [`ProcessInfoContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/info/ProcessInfoContributor.html) | Exposes process information. | None. | | `ssl` | [`SslInfoContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/info/SslInfoContributor.html) | Exposes SSL certificate information. | An [SSL Bundle](../features/ssl.html#features.ssl.bundles) configured. | Whether an individual contributor is enabled is controlled by its `management.info..enabled` property. Different contributors have different defaults for this property, depending on their prerequisites and the nature of the information that they expose. With no prerequisites to indicate that they should be enabled, the `env`, `java`, `os`, and `process` contributors are disabled by default. The `ssl` contributor has a prerequisite of having an [SSL Bundle](../features/ssl.html#features.ssl.bundles) configured but it is disabled by default. Each can be enabled by setting its `management.info..enabled` property to `true`. The `build` and `git` info contributors are enabled by default. Each can be disabled by setting its `management.info..enabled` property to `false`. Alternatively, to disable every contributor that is usually enabled by default, set the `management.info.defaults.enabled` property to `false`. ### [](#actuator.endpoints.info.custom-application-information)Custom Application Information When the `env` contributor is enabled, you can customize the data exposed by the `info` endpoint by setting `info.*` Spring properties. All [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) properties under the `info` key are automatically exposed. For example, you could add the following settings to your `application.properties` file: * Properties * YAML ```properties info.app.encoding=UTF-8 info.app.java.source=17 info.app.java.target=17 ``` ```yaml info: app: encoding: "UTF-8" java: source: "17" target: "17" ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Rather than hardcoding those values, you could also [expand info properties at build time](../../how-to/properties-and-configuration.html#howto.properties-and-configuration.expand-properties).Assuming you use Maven, you could rewrite the preceding example as follows:- Properties - YAML```properties [email protected]@ [email protected]@ [email protected]@ ``````yaml info: app: encoding: "@project.build.sourceEncoding@" java: source: "@java.version@" target: "@java.version@" ``` | ### [](#actuator.endpoints.info.git-commit-information)Git Commit Information Another useful feature of the `info` endpoint is its ability to publish information about the state of your `git` source code repository when the project was built. If a [`GitProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/info/GitProperties.html) bean is available, you can use the `info` endpoint to expose these properties. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | A [`GitProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/info/GitProperties.html) bean is auto-configured if a `git.properties` file is available at the root of the classpath. See [Generate Git Information](../../how-to/build.html#howto.build.generate-git-info) for more detail. | By default, the endpoint exposes `git.branch`, `git.commit.id`, and `git.commit.time` properties, if present. If you do not want any of these properties in the endpoint response, they need to be excluded from the `git.properties` file. If you want to display the full git information (that is, the full content of `git.properties`), use the `management.info.git.mode` property, as follows: * Properties * YAML ```properties management.info.git.mode=full ``` ```yaml management: info: git: mode: "full" ``` To disable the git commit information from the `info` endpoint completely, set the `management.info.git.enabled` property to `false`, as follows: * Properties * YAML ```properties management.info.git.enabled=false ``` ```yaml management: info: git: enabled: false ``` ### [](#actuator.endpoints.info.build-information)Build Information If a [`BuildProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/info/BuildProperties.html) bean is available, the `info` endpoint can also publish information about your build. This happens if a `META-INF/build-info.properties` file is available in the classpath. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The Maven and Gradle plugins can both generate that file. See [Generate Build Information](../../how-to/build.html#howto.build.generate-info) for more details. | ### [](#actuator.endpoints.info.java-information)Java Information The `info` endpoint publishes information about your Java runtime environment, see [`JavaInfo`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/info/JavaInfo.html) for more details. ### [](#actuator.endpoints.info.os-information)OS Information The `info` endpoint publishes information about your Operating System, see [`OsInfo`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/info/OsInfo.html) for more details. ### [](#actuator.endpoints.info.process-information)Process Information The `info` endpoint publishes information about your process, see [`ProcessInfo`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/info/ProcessInfo.html) for more details. ### [](#actuator.endpoints.info.ssl-information)SSL Information The `info` endpoint publishes information about your SSL certificates (that are configured through [SSL Bundles](../features/ssl.html#features.ssl.bundles)), see [`SslInfo`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/info/SslInfo.html) for more details. ### [](#actuator.endpoints.info.writing-custom-info-contributors)Writing Custom InfoContributors To provide custom application information, you can register Spring beans that implement the [`InfoContributor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/info/InfoContributor.html) interface. The following example contributes an `example` entry with a single value: * Java * Kotlin ```java import java.util.Collections; import org.springframework.boot.actuate.info.Info; import org.springframework.boot.actuate.info.InfoContributor; import org.springframework.stereotype.Component; @Component public class MyInfoContributor implements InfoContributor { @Override public void contribute(Info.Builder builder) { builder.withDetail("example", Collections.singletonMap("key", "value")); } } ``` ```kotlin import org.springframework.boot.actuate.info.Info import org.springframework.boot.actuate.info.InfoContributor import org.springframework.stereotype.Component import java.util.Collections @Component class MyInfoContributor : InfoContributor { override fun contribute(builder: Info.Builder) { builder.withDetail("example", Collections.singletonMap("key", "value")) } } ``` If you reach the `info` endpoint, you should see a response that contains the following additional entry: ```json { "example": { "key" : "value" } } ``` ## [](#actuator.endpoints.sbom)Software Bill of Materials (SBOM) The `sbom` endpoint exposes the [Software Bill of Materials](https://en.wikipedia.org/wiki/Software_supply_chain). CycloneDX SBOMs can be auto-detected, but other formats can be manually configured, too. The `sbom` actuator endpoint will then expose an SBOM called "application", which describes the contents of your application. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | To automatically generate a CycloneDX SBOM at project build time, please see the [Generate a CycloneDX SBOM](../../how-to/build.html#howto.build.generate-cyclonedx-sbom) section. | ### [](#actuator.endpoints.sbom.other-formats)Other SBOM formats If you want to publish an SBOM in a different format, there are some configuration properties which you can use. The configuration property `management.endpoint.sbom.application.location` sets the location for the application SBOM. For example, setting this to `classpath:sbom.json` will use the contents of the `/sbom.json` resource on the classpath. The media type for SBOMs in CycloneDX, SPDX and Syft format is detected automatically. To override the auto-detected media type, use the configuration property `management.endpoint.sbom.application.media-type`. ### [](#actuator.endpoints.sbom.additional)Additional SBOMs The actuator endpoint can handle multiple SBOMs. To add SBOMs, use the configuration property `management.endpoint.sbom.additional`, as shown in this example: * Properties * YAML ```properties management.endpoint.sbom.additional.system.location=optional:file:/system.spdx.json management.endpoint.sbom.additional.system.media-type=application/spdx+json ``` ```yaml management: endpoint: sbom: additional: system: location: "optional:file:/system.spdx.json" media-type: "application/spdx+json" ``` This will add an SBOM called "system", which is stored in `/system.spdx.json`. The `optional:` prefix can be used to prevent a startup failure if the file doesn’t exist. * [Spring Boot](../../index.html) * [4.1.1](endpoints.html) * [4.0.8](../../4.0/reference/actuator/endpoints.html) * [3.5.16](../../3.5/reference/actuator/endpoints.html) * [3.4.13](../../3.4/reference/actuator/endpoints.html) * [3.3.13](../../3.3/reference/actuator/endpoints.html) - [4.2.0-M2](../../4.2/reference/actuator/endpoints.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/actuator/endpoints.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/actuator/endpoints.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/actuator/endpoints.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/io/validation.html ---- # Validation The method validation feature supported by Bean Validation 1.1 is automatically enabled as long as a JSR-303 implementation (such as Hibernate Validator, typically provided by `spring-boot-starter-validation`) is on the classpath. This lets bean methods be annotated with `jakarta.validation` constraints on their parameters and/or on their return value. Target classes with such annotated methods need to be annotated with the [`@Validated`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/validation/annotation/Validated.html) annotation at the type level for their methods to be searched for inline constraint annotations. For instance, the following service triggers the validation of the first argument, making sure its size is between 8 and 10: * Java * Kotlin ```java import jakarta.validation.constraints.Size; import org.springframework.stereotype.Service; import org.springframework.validation.annotation.Validated; @Service @Validated public class MyBean { public Archive findByCodeAndAuthor(@Size(min = 8, max = 10) String code, Author author) { return ... } } ``` ```kotlin import jakarta.validation.constraints.Size import org.springframework.stereotype.Service import org.springframework.validation.annotation.Validated @Service @Validated class MyBean { fun findByCodeAndAuthor(code: @Size(min = 8, max = 10) String?, author: Author?): Archive? { return null } } ``` The application’s [`MessageSource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/MessageSource.html) is used when resolving `{parameters}` in constraint messages. This allows you to use [your application’s `messages.properties` files](../features/internationalization.html) for Bean Validation messages. Once the parameters have been resolved, message interpolation is completed using Bean Validation’s default interpolator. To customize the [`Configuration`](https://jakarta.ee/specifications/bean-validation/3.1/apidocs/jakarta/validation/Configuration.html) used to build the [`ValidatorFactory`](https://jakarta.ee/specifications/bean-validation/3.1/apidocs/jakarta/validation/ValidatorFactory.html), define a [`ValidationConfigurationCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/validation/autoconfigure/ValidationConfigurationCustomizer.html) bean. When multiple customizer beans are defined, they are called in order based on their [`@Order`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/annotation/Order.html) annotation or [`Ordered`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/Ordered.html) implementation. * [Spring Boot](../../index.html) * [4.1.1](validation.html) * [4.0.8](../../4.0/reference/io/validation.html) * [3.5.16](../../3.5/reference/io/validation.html) * [3.4.13](../../3.4/reference/io/validation.html) * [3.3.13](../../3.3/reference/io/validation.html) - [4.2.0-M2](../../4.2/reference/io/validation.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/io/validation.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/io/validation.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/io/validation.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/using/packaging-for-production.html ---- # Packaging Your Application for Production Once your Spring Boot application is ready for production deployment, there are many options for packaging and optimizing the application. See the [Packaging Spring Boot Applications](../packaging/index.html) section of the documentation to read about these features. For additional "production ready" features, such as health, auditing, and metric REST or JMX end-points, consider adding `spring-boot-actuator`. See [Actuator](../../how-to/actuator.html) for details. * [Spring Boot](../../index.html) * [4.1.1](packaging-for-production.html) * [4.0.8](../../4.0/reference/using/packaging-for-production.html) * [3.5.16](../../3.5/reference/using/packaging-for-production.html) * [3.4.13](../../3.4/reference/using/packaging-for-production.html) * [3.3.13](../../3.3/reference/using/packaging-for-production.html) - [4.2.0-M2](../../4.2/reference/using/packaging-for-production.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/using/packaging-for-production.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/using/packaging-for-production.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/using/packaging-for-production.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/data/sql.html ---- # SQL Databases The [Spring Framework](https://spring.io/projects/spring-framework) provides extensive support for working with SQL databases, from direct JDBC access using [`JdbcClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/core/simple/JdbcClient.html) or [`JdbcTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/core/JdbcTemplate.html) to complete “object relational mapping” technologies such as Hibernate. [Spring Data](https://spring.io/projects/spring-data) provides an additional level of functionality: creating [`Repository`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/Repository.html) implementations directly from interfaces and using conventions to generate queries from your method names. ## [](#data.sql.datasource)Configure a DataSource Java’s [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) interface provides a standard method of working with database connections. Traditionally, a [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) uses a `URL` along with some credentials to establish a database connection. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | See the [Configure a Custom DataSource](../../how-to/data-access.html#howto.data-access.configure-custom-datasource) section of the “How-to Guides” for more advanced examples, typically to take full control over the configuration of the DataSource. | ### [](#data.sql.datasource.embedded)Embedded Database Support It is often convenient to develop applications by using an in-memory embedded database. Obviously, in-memory databases do not provide persistent storage. You need to populate your database when your application starts and be prepared to throw away data when your application ends. | | | | -- | ------------------------------------------------------------------------------------------------------------------------ | | ** | The “How-to Guides” section includes a [section on how to initialize a database](../../how-to/data-initialization.html). | Spring Boot can auto-configure embedded [H2](https://www.h2database.com), [HSQL](https://hsqldb.org/), and [Derby](https://db.apache.org/derby/) (deprecated) databases. You need not provide any connection URLs. You need only include a build dependency to the embedded database that you want to use. If there are multiple embedded databases on the classpath, set the `spring.datasource.embedded-database-connection` configuration property to control which one is used. Setting the property to `none` disables auto-configuration of an embedded database. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | If you are using this feature in your tests, you may notice that the same database is reused by your whole test suite regardless of the number of application contexts that you use. If you want to make sure that each context has a separate embedded database, you should set `spring.datasource.generate-unique-name` to `true`. | For example, the typical POM dependencies would be as follows: ```xml org.springframework.boot spring-boot-starter-data-jpa org.hsqldb hsqldb runtime ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You need a dependency on `spring-jdbc` for an embedded database to be auto-configured. In this example, it is pulled in transitively through `spring-boot-starter-data-jpa`. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | If, for whatever reason, you do configure the connection URL for an embedded database, take care to ensure that the database’s automatic shutdown is disabled. If you use H2, you should use `DB_CLOSE_ON_EXIT=FALSE` to do so. If you use HSQLDB, you should ensure that `shutdown=true` is not used. Disabling the database’s automatic shutdown lets Spring Boot control when the database is closed, thereby ensuring that it happens once access to the database is no longer needed. | ### [](#data.sql.datasource.production)Connection to a Production Database Production database connections can also be auto-configured by using a pooling [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html). ### [](#data.sql.datasource.configuration)DataSource Configuration DataSource configuration is controlled by external configuration properties in `spring.datasource.*`. For example, you might declare the following section in `application.properties`: * Properties * YAML ```properties spring.datasource.url=jdbc:mysql://localhost/test spring.datasource.username=dbuser spring.datasource.password=dbpass ``` ```yaml spring: datasource: url: "jdbc:mysql://localhost/test" username: "dbuser" password: "dbpass" ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You should at least specify the URL by setting the `spring.datasource.url` property. Otherwise, Spring Boot tries to auto-configure an embedded database. | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Spring Boot can deduce the JDBC driver class for most databases from the URL. If you need to specify a specific class, you can use the `spring.datasource.driver-class-name` property. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | For a pooling [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) to be created, we need to be able to verify that a valid [`Driver`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/java/sql/Driver.html) class is available, so we check for that before doing anything. In other words, if you set `spring.datasource.driver-class-name=com.mysql.jdbc.Driver`, then that class has to be loadable. | See [`DataSourceProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/autoconfigure/DataSourceProperties.html) API documentation for more of the supported options. These are the standard options that work regardless of [the actual implementation](#data.sql.datasource.connection-pool). It is also possible to fine-tune implementation-specific settings by using their respective prefix (`spring.datasource.hikari.*`, `spring.datasource.tomcat.*`, `spring.datasource.dbcp2.*`, and `spring.datasource.oracleucp.*`). See the documentation of the connection pool implementation you are using for more details. For instance, if you use the [Tomcat connection pool](https://tomcat.apache.org/tomcat-11.0-doc/jdbc-pool.html#Common_Attributes), you could customize many additional settings, as shown in the following example: * Properties * YAML ```properties spring.datasource.tomcat.max-wait=10000 spring.datasource.tomcat.max-active=50 spring.datasource.tomcat.test-on-borrow=true ``` ```yaml spring: datasource: tomcat: max-wait: 10000 max-active: 50 test-on-borrow: true ``` This will set the pool to wait 10000ms before throwing an exception if no connection is available, limit the maximum number of connections to 50 and validate the connection before borrowing it from the pool. ### [](#data.sql.datasource.connection-pool)Supported Connection Pools Spring Boot uses the following algorithm for choosing a specific implementation: 1. We prefer [HikariCP](https://github.com/brettwooldridge/HikariCP) for its performance and concurrency. If HikariCP is available, we always choose it. 2. Otherwise, if the Tomcat pooling [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) is available, we use it. 3. Otherwise, if [Commons DBCP2](https://commons.apache.org/proper/commons-dbcp/) is available, we use it. 4. If none of HikariCP, Tomcat, and DBCP2 are available and if Oracle UCP is available, we use it. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you use the `spring-boot-starter-jdbc` or `spring-boot-starter-data-jpa` starters, you automatically get a dependency to HikariCP. | You can bypass that algorithm completely and specify the connection pool to use by setting the `spring.datasource.type` property. This is especially important if you run your application in a Tomcat container, as `tomcat-jdbc` is provided by default. Additional connection pools can always be configured manually, using [`DataSourceBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/DataSourceBuilder.html). If you define your own [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) bean, auto-configuration does not occur. The following connection pools are supported by [`DataSourceBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/DataSourceBuilder.html): * HikariCP * Tomcat pooling [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) * Commons DBCP2 * Oracle UCP & `OracleDataSource` * Spring Framework’s [`SimpleDriverDataSource`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/datasource/SimpleDriverDataSource.html) * H2 [`JdbcDataSource`](https://www.h2database.com/javadoc/org/h2/jdbcx/JdbcDataSource.html) * PostgreSQL [`PGSimpleDataSource`](https://jdbc.postgresql.org/documentation/publicapi/org/postgresql/ds/PGSimpleDataSource.html) * C3P0 * Vibur ### [](#data.sql.datasource.jndi)Connection to a JNDI DataSource If you deploy your Spring Boot application to an Application Server, you might want to configure and manage your DataSource by using your Application Server’s built-in features and access it by using JNDI. The `spring.datasource.jndi-name` property can be used as an alternative to the `spring.datasource.url`, `spring.datasource.username`, and `spring.datasource.password` properties to access the [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) from a specific JNDI location. For example, the following section in `application.properties` shows how you can access a JBoss AS defined [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html): * Properties * YAML ```properties spring.datasource.jndi-name=java:jboss/datasources/customers ``` ```yaml spring: datasource: jndi-name: "java:jboss/datasources/customers" ``` ### [](#data.sql.datasource.lazy-connection)Lazy Connection Proxy When a pooled `DataSource` is auto-configured, it can be wrapped in a proxy that fetches JDBC connections as late as possible by setting `spring.datasource.connection-fetch` to `lazy`, as shown in the following example: * Properties * YAML ```properties spring.datasource.connection-fetch=lazy ``` ```yaml spring: datasource: connection-fetch: "lazy" ``` With this feature enabled, JDBC Connections are only fetched from the pool when actually necessary. JDBC transaction control can happen without fetching a Connection from the pool or communicating with the database; this will be done lazily on the first creation of a JDBC Statement. To get access to the target auto-configured `DataSource`, use `DataSource.unwrap`. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | If you are wrapping the target `DataSource` in a `TransactionAwareDataSourceProxy`, make sure to do so with a `BeanPostProcessor` that has a positive order. | See [`LazyConnectionDataSourceProxy`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/datasource/LazyConnectionDataSourceProxy.html) for more details. ## [](#data.sql.jdbc-template)Using JdbcTemplate Spring’s [`JdbcTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/core/JdbcTemplate.html) and [`NamedParameterJdbcTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/core/namedparam/NamedParameterJdbcTemplate.html) classes are auto-configured, and you can autowire them directly into your own beans, as shown in the following example: * Java * Kotlin ```java import org.springframework.jdbc.core.JdbcTemplate; import org.springframework.stereotype.Component; @Component public class MyBean { private final JdbcTemplate jdbcTemplate; public MyBean(JdbcTemplate jdbcTemplate) { this.jdbcTemplate = jdbcTemplate; } public void doSomething() { this.jdbcTemplate ... } } ``` ```kotlin import org.springframework.jdbc.core.JdbcTemplate import org.springframework.stereotype.Component @Component class MyBean(private val jdbcTemplate: JdbcTemplate) { fun doSomething() { jdbcTemplate.execute("delete from customer") } } ``` You can customize some properties of the template by using the `spring.jdbc.template.*` properties, as shown in the following example: * Properties * YAML ```properties spring.jdbc.template.max-rows=500 ``` ```yaml spring: jdbc: template: max-rows: 500 ``` If tuning of SQL exceptions is required, you can define your own `SQLExceptionTranslator` bean so that it is associated with the auto-configured `JdbcTemplate`. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The [`NamedParameterJdbcTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/core/namedparam/NamedParameterJdbcTemplate.html) reuses the same [`JdbcTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/core/JdbcTemplate.html) instance behind the scenes. If more than one [`JdbcTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/core/JdbcTemplate.html) is defined and no primary candidate exists, the [`NamedParameterJdbcTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/core/namedparam/NamedParameterJdbcTemplate.html) is not auto-configured. | ## [](#data.sql.jdbc-client)Using JdbcClient Spring’s [`JdbcClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/core/simple/JdbcClient.html) is auto-configured based on the presence of a [`NamedParameterJdbcTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/core/namedparam/NamedParameterJdbcTemplate.html). You can inject it directly in your own beans as well, as shown in the following example: * Java * Kotlin ```java import org.springframework.jdbc.core.simple.JdbcClient; import org.springframework.stereotype.Component; @Component public class MyBean { private final JdbcClient jdbcClient; public MyBean(JdbcClient jdbcClient) { this.jdbcClient = jdbcClient; } public void doSomething() { this.jdbcClient ... } } ``` ```kotlin import org.springframework.jdbc.core.simple.JdbcClient import org.springframework.stereotype.Component @Component class MyBean(private val jdbcClient: JdbcClient) { fun doSomething() { jdbcClient.sql("delete from customer").update() } } ``` If you rely on auto-configuration to create the underlying [`JdbcTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/core/JdbcTemplate.html), any customization using `spring.jdbc.template.*` properties is taken into account in the client as well. ## [](#data.sql.jpa-and-spring-data)JPA and Spring Data JPA The Java Persistence API is a standard technology that lets you “map” objects to relational databases. The `spring-boot-starter-data-jpa` POM provides a quick way to get started. It provides the following key dependencies: * Hibernate: One of the most popular JPA implementations. * Spring Data JPA: Helps you to implement JPA-based repositories. * Spring ORM: Core ORM support from the Spring Framework. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | We do not go into too many details of JPA or [Spring Data](https://spring.io/projects/spring-data) here. You can follow the [Accessing Data with JPA](https://spring.io/guides/gs/accessing-data-jpa/) guide from [spring.io](https://spring.io) and read the [Spring Data JPA](https://spring.io/projects/spring-data-jpa) and [Hibernate](https://hibernate.org/orm/documentation/) reference documentation. | ### [](#data.sql.jpa-and-spring-data.entity-classes)Entity Classes Traditionally, JPA “Entity” classes are specified in a `persistence.xml` file. With Spring Boot, this file is not necessary and “Entity Scanning” is used instead. By default the [auto-configuration packages](../using/auto-configuration.html#using.auto-configuration.packages) are scanned. Any classes annotated with [`@Entity`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/Entity.html), [`@Embeddable`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/Embeddable.html), or [`@MappedSuperclass`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/MappedSuperclass.html) are considered. A typical entity class resembles the following example: * Java * Kotlin ```java import java.io.Serializable; import jakarta.persistence.Column; import jakarta.persistence.Entity; import jakarta.persistence.GeneratedValue; import jakarta.persistence.Id; @Entity public class City implements Serializable { @Id @GeneratedValue private Long id; @Column(nullable = false) private String name; @Column(nullable = false) private String state; // ... additional members, often include @OneToMany mappings protected City() { // no-args constructor required by JPA spec // this one is protected since it should not be used directly } public City(String name, String state) { this.name = name; this.state = state; } public String getName() { return this.name; } public String getState() { return this.state; } // ... etc } ``` ```kotlin import jakarta.persistence.Column import jakarta.persistence.Entity import jakarta.persistence.GeneratedValue import jakarta.persistence.Id import java.io.Serializable @Entity class City : Serializable { @Id @GeneratedValue private val id: Long? = null @Column(nullable = false) var name: String? = null private set // ... etc @Column(nullable = false) var state: String? = null private set // ... additional members, often include @OneToMany mappings protected constructor() { // no-args constructor required by JPA spec // this one is protected since it should not be used directly } constructor(name: String?, state: String?) { this.name = name this.state = state } } ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | You can customize entity scanning locations by using the [`@EntityScan`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/persistence/autoconfigure/EntityScan.html) annotation. See the [Separate @Entity Definitions from Spring Configuration](../../how-to/data-access.html#howto.data-access.separate-entity-definitions-from-spring-configuration) section of the “How-to Guides”. | ### [](#data.sql.jpa-and-spring-data.repositories)Spring Data JPA Repositories [Spring Data JPA](https://spring.io/projects/spring-data-jpa) repositories are interfaces that you can define to access data. JPA queries are created automatically from your method names. For example, a `CityRepository` interface might declare a `findAllByState(String state)` method to find all the cities in a given state. For more complex queries, you can annotate your method with Spring Data’s [`Query`](https://docs.spring.io/spring-data/jpa/docs/4.1.x/api/org/springframework/data/jpa/repository/Query.html) annotation. Spring Data repositories usually extend from the [`Repository`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/Repository.html) or [`CrudRepository`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/CrudRepository.html) interfaces. If you use auto-configuration, the [auto-configuration packages](../using/auto-configuration.html#using.auto-configuration.packages) are searched for repositories. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can customize the locations to look for repositories using [`@EnableJpaRepositories`](https://docs.spring.io/spring-data/jpa/docs/4.1.x/api/org/springframework/data/jpa/repository/config/EnableJpaRepositories.html). | The following example shows a typical Spring Data repository interface definition: * Java * Kotlin ```java import org.springframework.boot.docs.data.sql.jpaandspringdata.entityclasses.City; import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; import org.springframework.data.repository.Repository; public interface CityRepository extends Repository { Page findAll(Pageable pageable); City findByNameAndStateAllIgnoringCase(String name, String state); } ``` ```kotlin import org.springframework.boot.docs.data.sql.jpaandspringdata.entityclasses.City import org.springframework.data.domain.Page import org.springframework.data.domain.Pageable import org.springframework.data.repository.Repository interface CityRepository : Repository { fun findAll(pageable: Pageable?): Page? fun findByNameAndStateAllIgnoringCase(name: String?, state: String?): City? } ``` Spring Data JPA repositories support three different modes of bootstrapping: default, deferred, and lazy. To enable deferred or lazy bootstrapping, set the `spring.data.jpa.repositories.bootstrap-mode` property to `deferred` or `lazy` respectively. When using deferred bootstrapping, the auto-configured [`EntityManagerFactoryBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jpa/EntityManagerFactoryBuilder.html) requires a bootstrap executor and will use the context’s [`AsyncTaskExecutor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/task/AsyncTaskExecutor.html), if one can be determined. If more than one exists, the one named `applicationTaskExecutor` will be used. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | When using deferred or lazy bootstrapping, make sure to defer any access to the JPA infrastructure after the application context bootstrap phase. You can use [`SmartInitializingSingleton`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/SmartInitializingSingleton.html) to invoke any initialization that requires the JPA infrastructure. For JPA components (such as converters) that are created as Spring beans, use [`ObjectProvider`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/ObjectProvider.html) to delay the resolution of dependencies, if any. | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | We have barely scratched the surface of Spring Data JPA. For complete details, see the [Spring Data JPA reference documentation](https://docs.spring.io/spring-data/jpa/reference/4.1). | ### [](#data.sql.jpa-and-spring-data.envers-repositories)Spring Data Envers Repositories If [Spring Data Envers](https://spring.io/projects/spring-data-envers) is available, JPA repositories are auto-configured to support typical Envers queries. To use Spring Data Envers, make sure your repository extends from [`RevisionRepository`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/history/RevisionRepository.html) as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.docs.data.sql.jpaandspringdata.entityclasses.Country; import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; import org.springframework.data.repository.Repository; import org.springframework.data.repository.history.RevisionRepository; public interface CountryRepository extends RevisionRepository, Repository { Page findAll(Pageable pageable); } ``` ```kotlin import org.springframework.boot.docs.data.sql.jpaandspringdata.entityclasses.Country import org.springframework.data.domain.Page import org.springframework.data.domain.Pageable import org.springframework.data.repository.Repository import org.springframework.data.repository.history.RevisionRepository interface CountryRepository : RevisionRepository, Repository { fun findAll(pageable: Pageable?): Page? } ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------- | | ** | For more details, check the [Spring Data Envers reference documentation](https://docs.spring.io/spring-data/jpa/reference/4.1/envers.html). | ### [](#data.sql.jpa-and-spring-data.creating-and-dropping)Creating and Dropping JPA Databases By default, JPA databases are automatically created **only** if you use an embedded database, that is H2, HSQL, or Derby (deprecated). You can explicitly configure JPA settings by using `spring.jpa.*` properties. For example, to create and drop tables you can add the following line to your `application.properties`: * Properties * YAML ```properties spring.jpa.hibernate.ddl-auto=create-drop ``` ```yaml spring: jpa: hibernate.ddl-auto: "create-drop" ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Hibernate’s own internal property name for this (if you happen to remember it better) is `hibernate.hbm2ddl.auto`. You can set it, along with other Hibernate native properties, by using `spring.jpa.properties.*` (the prefix is stripped before adding them to the entity manager). The following line shows an example of setting JPA properties for Hibernate: | * Properties * YAML ```properties spring.jpa.properties.hibernate.globally_quoted_identifiers=true ``` ```yaml spring: jpa: properties: hibernate: "globally_quoted_identifiers": "true" ``` The line in the preceding example passes a value of `true` for the `hibernate.globally_quoted_identifiers` property to the Hibernate entity manager. By default, the DDL execution (or validation) is deferred until the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) has started. ### [](#data.sql.jpa-and-spring-data.open-entity-manager-in-view)Open EntityManager in View If you are running a web application, Spring Boot by default registers [`OpenEntityManagerInViewInterceptor`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/orm/jpa/support/OpenEntityManagerInViewInterceptor.html) to apply the “Open EntityManager in View” pattern, to allow for lazy loading in web views. If you do not want this behavior, you should set `spring.jpa.open-in-view` to `false` in your `application.properties`. ## [](#data.sql.jdbc)Spring Data JDBC Spring Data includes repository support for JDBC and will automatically generate SQL for the methods on [`CrudRepository`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/CrudRepository.html). For more advanced queries, a [`@Query`](https://docs.spring.io/spring-data/jdbc/docs/4.1.x/api/org/springframework/data/jdbc/repository/query/Query.html) annotation is provided. Spring Boot will auto-configure Spring Data’s JDBC repositories when the necessary dependencies are on the classpath. They can be added to your project with a single dependency on `spring-boot-starter-data-jdbc`. If necessary, you can take control of Spring Data JDBC’s configuration by adding the [`@EnableJdbcRepositories`](https://docs.spring.io/spring-data/jdbc/docs/4.1.x/api/org/springframework/data/jdbc/repository/config/EnableJdbcRepositories.html) annotation or an [`AbstractJdbcConfiguration`](https://docs.spring.io/spring-data/jdbc/docs/4.1.x/api/org/springframework/data/jdbc/repository/config/AbstractJdbcConfiguration.html) subclass to your application. If you’re using Spring Data JDBC with [ahead-of-time processing](../packaging/aot.html) (targeting either the JVM or a native image), some additional configuration is recommended. To prevent the need for a DB connection during AOT processing, define a `JdbcDialect` bean that’s appropriate for your application’s database. For example, if you’re using Postgres, define a `JdbcPostgresDialect` bean. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------- | | ** | For complete details of Spring Data JDBC, see the [reference documentation](https://docs.spring.io/spring-data/relational/reference/4.1). | ## [](#data.sql.h2-web-console)Using H2’s Web Console The [H2 database](https://www.h2database.com) provides a [browser-based console](https://www.h2database.com/html/quickstart.html#h2_console) that Spring Boot can auto-configure for you. The console is auto-configured when the following conditions are met: * You are developing a servlet-based web application. * `org.springframework.boot:spring-boot-h2console` is on the classpath. * You are using [Spring Boot’s developer tools](../using/devtools.html). | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you are not using Spring Boot’s developer tools but would still like to make use of H2’s console, you can configure the `spring.h2.console.enabled` property with a value of `true`. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | The H2 console is only intended for use during development, so you should take care to ensure that `spring.h2.console.enabled` is not set to `true` in production. | ### [](#data.sql.h2-web-console.custom-path)Changing the H2 Console’s Path By default, the console is available at `/h2-console`. You can customize the console’s path by using the `spring.h2.console.path` property. ### [](#data.sql.h2-web-console.spring-security)Accessing the H2 Console in a Secured Application H2 Console uses frames and, as it is intended for development only, does not implement CSRF protection measures. If your application uses Spring Security, you need to configure it to * disable CSRF protection for requests against the console, * set the header `X-Frame-Options` to `SAMEORIGIN` on responses from the console. More information on [CSRF](https://docs.spring.io/spring-security/reference/7.1/features/exploits/csrf.html) and the header [X-Frame-Options](https://docs.spring.io/spring-security/reference/7.1/features/exploits/headers.html#headers-frame-options) can be found in the Spring Security Reference Guide. In simple setups, a [`SecurityFilterChain`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/SecurityFilterChain.html) like the following can be used: * Java * Kotlin ```java import org.springframework.boot.security.autoconfigure.web.servlet.PathRequest; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Profile; import org.springframework.core.Ordered; import org.springframework.core.annotation.Order; import org.springframework.security.config.Customizer; import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.config.annotation.web.configurers.CsrfConfigurer; import org.springframework.security.config.annotation.web.configurers.HeadersConfigurer.FrameOptionsConfig; import org.springframework.security.web.SecurityFilterChain; @Profile("dev") @Configuration(proxyBeanMethods = false) public class DevProfileSecurityConfiguration { @Bean @Order(Ordered.HIGHEST_PRECEDENCE) SecurityFilterChain h2ConsoleSecurityFilterChain(HttpSecurity http) { http.securityMatcher(PathRequest.toH2Console()); http.authorizeHttpRequests(yourCustomAuthorization()); http.csrf(CsrfConfigurer::disable); http.headers((headers) -> headers.frameOptions(FrameOptionsConfig::sameOrigin)); return http.build(); } } ``` ```kotlin import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.context.annotation.Profile import org.springframework.core.Ordered import org.springframework.core.annotation.Order import org.springframework.security.config.Customizer import org.springframework.security.config.annotation.web.builders.HttpSecurity import org.springframework.security.web.SecurityFilterChain @Profile("dev") @Configuration(proxyBeanMethods = false) class DevProfileSecurityConfiguration { @Bean @Order(Ordered.HIGHEST_PRECEDENCE) fun h2ConsoleSecurityFilterChain(http: HttpSecurity): SecurityFilterChain { return http.authorizeHttpRequests(yourCustomAuthorization()) .csrf { csrf -> csrf.disable() } .headers { headers -> headers.frameOptions { frameOptions -> frameOptions.sameOrigin() } } .build() } } ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The H2 console is only intended for use during development. In production, disabling CSRF protection or allowing frames for a website may create severe security risks. | | | | | -- | ----------------------------------------------------------------------------------------------------------------- | | ** | `PathRequest.toH2Console()` returns the correct request matcher also when the console’s path has been customized. | ## [](#data.sql.jooq)Using jOOQ jOOQ Object Oriented Querying ([jOOQ](https://www.jooq.org/)) is a popular product from [Data Geekery](https://www.datageekery.com/) which generates Java code from your database and lets you build type-safe SQL queries through its fluent API. Both the commercial and open source editions can be used with Spring Boot. jOOQ requires Java 21 or later. ### [](#data.sql.jooq.codegen)Code Generation In order to use jOOQ type-safe queries, you need to generate Java classes from your database schema. You can follow the instructions in the [jOOQ user manual](https://www.jooq.org/doc/3.21.7/manual-single-page/#jooq-in-7-steps-step3). If you use the `jooq-codegen-maven` plugin and you also use the `spring-boot-starter-parent` “parent POM”, you can safely omit the plugin’s `` tag. You can also use Spring Boot-defined version variables (such as `h2.version`) to declare the plugin’s database dependency. The following listing shows an example: ```xml org.jooq jooq-codegen-maven ... com.h2database h2 ${h2.version} org.h2.Driver jdbc:h2:~/yourdatabase ... ``` ### [](#data.sql.jooq.dslcontext)Using DSLContext The fluent API offered by jOOQ is initiated through the [`DSLContext`](https://www.jooq.org/javadoc/3.21.7/org/jooq/DSLContext.html) interface. Spring Boot auto-configures a [`DSLContext`](https://www.jooq.org/javadoc/3.21.7/org/jooq/DSLContext.html) as a Spring Bean and connects it to your application [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html). To use the [`DSLContext`](https://www.jooq.org/javadoc/3.21.7/org/jooq/DSLContext.html), you can inject it, as shown in the following example: * Java * Kotlin ```java import java.util.GregorianCalendar; import java.util.List; import org.jooq.DSLContext; import org.springframework.stereotype.Component; import static org.springframework.boot.docs.data.sql.jooq.dslcontext.Tables.AUTHOR; @Component public class MyBean { private final DSLContext create; public MyBean(DSLContext dslContext) { this.create = dslContext; } } ``` ```kotlin import org.jooq.DSLContext import org.springframework.stereotype.Component import java.util.GregorianCalendar @Component class MyBean(private val create: DSLContext) { } ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | The jOOQ manual tends to use a variable named `create` to hold the [`DSLContext`](https://www.jooq.org/javadoc/3.21.7/org/jooq/DSLContext.html). | You can then use the [`DSLContext`](https://www.jooq.org/javadoc/3.21.7/org/jooq/DSLContext.html) to construct your queries, as shown in the following example: * Java * Kotlin ```java public List authorsBornAfter1980() { return this.create.selectFrom(AUTHOR) .where(AUTHOR.DATE_OF_BIRTH.greaterThan(new GregorianCalendar(1980, 0, 1))) .fetch(AUTHOR.DATE_OF_BIRTH); ``` ```kotlin fun authorsBornAfter1980(): List { return create.selectFrom(Tables.AUTHOR) .where(Tables.AUTHOR?.DATE_OF_BIRTH?.greaterThan(GregorianCalendar(1980, 0, 1))) .fetch(Tables.AUTHOR?.DATE_OF_BIRTH) } ``` ### [](#data.sql.jooq.sqldialect)jOOQ SQL Dialect Unless the `spring.jooq.sql-dialect` property has been configured, Spring Boot determines the SQL dialect to use for your datasource. If Spring Boot could not detect the dialect, it uses `DEFAULT`. | | | | -- | ------------------------------------------------------------------------------------------ | | ** | Spring Boot can only auto-configure dialects supported by the open source version of jOOQ. | ### [](#data.sql.jooq.customizing)Customizing jOOQ More advanced customizations can be achieved by defining your own [`DefaultConfigurationCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jooq/autoconfigure/DefaultConfigurationCustomizer.html) bean that will be invoked prior to creating the [`Configuration`](https://www.jooq.org/javadoc/3.21.7/org/jooq/Configuration.html) [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html). This takes precedence to anything that is applied by the auto-configuration. You can also create your own [`Configuration`](https://www.jooq.org/javadoc/3.21.7/org/jooq/Configuration.html) [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) if you want to take complete control of the jOOQ configuration. ## [](#data.sql.r2dbc)Using R2DBC The Reactive Relational Database Connectivity ([R2DBC](https://r2dbc.io)) project brings reactive programming APIs to relational databases. R2DBC’s [`Connection`](https://r2dbc.io/spec/1.0.0.RELEASE/api/io/r2dbc/spi/Connection.html) provides a standard method of working with non-blocking database connections. Connections are provided by using a [`ConnectionFactory`](https://r2dbc.io/spec/1.0.0.RELEASE/api/io/r2dbc/spi/ConnectionFactory.html), similar to a [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) with jdbc. [`ConnectionFactory`](https://r2dbc.io/spec/1.0.0.RELEASE/api/io/r2dbc/spi/ConnectionFactory.html) configuration is controlled by external configuration properties in `spring.r2dbc.*`. For example, you might declare the following section in `application.properties`: * Properties * YAML ```properties spring.r2dbc.url=r2dbc:postgresql://localhost/test spring.r2dbc.username=dbuser spring.r2dbc.password=dbpass ``` ```yaml spring: r2dbc: url: "r2dbc:postgresql://localhost/test" username: "dbuser" password: "dbpass" ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------- | | ** | You do not need to specify a driver class name, since Spring Boot obtains the driver from R2DBC’s Connection Factory discovery. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | At least the url should be provided. Information specified in the URL takes precedence over individual properties, that is `name`, `username`, `password` and pooling options. | | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The “How-to Guides” section includes a [section on how to initialize a database](../../how-to/data-initialization.html#howto.data-initialization.using-basic-sql-scripts). | To customize the connections created by a [`ConnectionFactory`](https://r2dbc.io/spec/1.0.0.RELEASE/api/io/r2dbc/spi/ConnectionFactory.html), that is, set specific parameters that you do not want (or cannot) configure in your central database configuration, you can use a [`ConnectionFactoryOptionsBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/r2dbc/autoconfigure/ConnectionFactoryOptionsBuilderCustomizer.html) [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html). The following example shows how to manually override the database port while the rest of the options are taken from the application configuration: * Java * Kotlin ```java import io.r2dbc.spi.ConnectionFactoryOptions; import org.springframework.boot.r2dbc.autoconfigure.ConnectionFactoryOptionsBuilderCustomizer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyR2dbcConfiguration { @Bean public ConnectionFactoryOptionsBuilderCustomizer connectionFactoryPortCustomizer() { return (builder) -> builder.option(ConnectionFactoryOptions.PORT, 5432); } } ``` ```kotlin import io.r2dbc.spi.ConnectionFactoryOptions import org.springframework.boot.r2dbc.autoconfigure.ConnectionFactoryOptionsBuilderCustomizer import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyR2dbcConfiguration { @Bean fun connectionFactoryPortCustomizer(): ConnectionFactoryOptionsBuilderCustomizer { return ConnectionFactoryOptionsBuilderCustomizer { builder -> builder.option(ConnectionFactoryOptions.PORT, 5432) } } } ``` The following examples show how to set some PostgreSQL connection options: * Java * Kotlin ```java import java.util.HashMap; import java.util.Map; import io.r2dbc.postgresql.PostgresqlConnectionFactoryProvider; import org.springframework.boot.r2dbc.autoconfigure.ConnectionFactoryOptionsBuilderCustomizer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyPostgresR2dbcConfiguration { @Bean public ConnectionFactoryOptionsBuilderCustomizer postgresCustomizer() { Map options = new HashMap<>(); options.put("lock_timeout", "30s"); options.put("statement_timeout", "60s"); return (builder) -> builder.option(PostgresqlConnectionFactoryProvider.OPTIONS, options); } } ``` ```kotlin import io.r2dbc.postgresql.PostgresqlConnectionFactoryProvider import org.springframework.boot.r2dbc.autoconfigure.ConnectionFactoryOptionsBuilderCustomizer import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyPostgresR2dbcConfiguration { @Bean fun postgresCustomizer(): ConnectionFactoryOptionsBuilderCustomizer { val options: MutableMap = HashMap() options["lock_timeout"] = "30s" options["statement_timeout"] = "60s" return ConnectionFactoryOptionsBuilderCustomizer { builder -> builder.option(PostgresqlConnectionFactoryProvider.OPTIONS, options) } } } ``` When a [`ConnectionFactory`](https://r2dbc.io/spec/1.0.0.RELEASE/api/io/r2dbc/spi/ConnectionFactory.html) bean is available, the regular JDBC [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) auto-configuration backs off. If you want to retain the JDBC [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) auto-configuration, and are comfortable with the risk of using the blocking JDBC API in a reactive application, add `@Import(DataSourceAutoConfiguration.class)` on a [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class in your application to re-enable it. ### [](#data.sql.r2dbc.embedded)Embedded Database Support Similarly to [the JDBC support](#data.sql.datasource.embedded), Spring Boot can automatically configure an embedded database for reactive usage. You need not provide any connection URLs. You need only include a build dependency to the embedded database that you want to use, as shown in the following example: ```xml io.r2dbc r2dbc-h2 runtime ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you are using this feature in your tests, you may notice that the same database is reused by your whole test suite regardless of the number of application contexts that you use. If you want to make sure that each context has a separate embedded database, you should set `spring.r2dbc.generate-unique-name` to `true`. | ### [](#data.sql.r2dbc.using-database-client)Using DatabaseClient A [`DatabaseClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/r2dbc/core/DatabaseClient.html) bean is auto-configured, and you can autowire it directly into your own beans, as shown in the following example: * Java * Kotlin ```java import java.util.Map; import reactor.core.publisher.Flux; import org.springframework.r2dbc.core.DatabaseClient; import org.springframework.stereotype.Component; @Component public class MyBean { private final DatabaseClient databaseClient; public MyBean(DatabaseClient databaseClient) { this.databaseClient = databaseClient; } // ... public Flux> someMethod() { return this.databaseClient.sql("select * from user").fetch().all(); } } ``` ```kotlin import org.springframework.r2dbc.core.DatabaseClient import org.springframework.stereotype.Component import reactor.core.publisher.Flux @Component class MyBean(private val databaseClient: DatabaseClient) { // ... fun someMethod(): Flux> { return databaseClient.sql("select * from user").fetch().all() } } ``` ### [](#data.sql.r2dbc.repositories)Spring Data R2DBC Repositories [Spring Data R2DBC](https://spring.io/projects/spring-data-r2dbc) repositories are interfaces that you can define to access data. Queries are created automatically from your method names. For example, a `CityRepository` interface might declare a `findAllByState(String state)` method to find all the cities in a given state. For more complex queries, you can annotate your method with Spring Data’s [`@Query`](https://docs.spring.io/spring-data/r2dbc/docs/4.1.x/api/org/springframework/data/r2dbc/repository/Query.html) annotation. Spring Data repositories usually extend from the [`Repository`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/Repository.html) or [`CrudRepository`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/CrudRepository.html) interfaces. If you use auto-configuration, the [auto-configuration packages](../using/auto-configuration.html#using.auto-configuration.packages) are searched for repositories. The following example shows a typical Spring Data repository interface definition: * Java * Kotlin ```java import reactor.core.publisher.Mono; import org.springframework.data.repository.Repository; public interface CityRepository extends Repository { Mono findByNameAndStateAllIgnoringCase(String name, String state); } ``` ```kotlin import org.springframework.data.repository.Repository import reactor.core.publisher.Mono interface CityRepository : Repository { fun findByNameAndStateAllIgnoringCase(name: String, state: String): Mono } ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | We have barely scratched the surface of Spring Data R2DBC. For complete details, see the [Spring Data R2DBC reference documentation](https://docs.spring.io/spring-data/relational/reference/4.1). | * [Spring Boot](../../index.html) * [4.1.1](sql.html) * [4.0.8](../../4.0/reference/data/sql.html) * [3.5.16](../../3.5/reference/data/sql.html) * [3.4.13](../../3.4/reference/data/sql.html) * [3.3.13](../../3.3/reference/data/sql.html) - [4.2.0-M2](../../4.2/reference/data/sql.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/data/sql.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/data/sql.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/data/sql.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/packaging/native-image/index.html ---- # GraalVM Native Images [GraalVM Native Images](https://www.graalvm.org/native-image/) are standalone executables that can be generated by processing compiled Java applications ahead-of-time. Native Images generally have a smaller memory footprint and start faster than their JVM counterparts. * [Spring Boot](../../../index.html) * [4.1.1](index.html) * [4.0.8](../../../4.0/reference/packaging/native-image/index.html) * [3.5.16](../../../3.5/reference/packaging/native-image/index.html) * [3.4.13](../../../3.4/reference/packaging/native-image/index.html) * [3.3.13](../../../3.3/reference/packaging/native-image/index.html) - [4.2.0-M2](../../../4.2/reference/packaging/native-image/index.html) * [4.2.0-SNAPSHOT](../../../4.2-SNAPSHOT/reference/packaging/native-image/index.html) * [4.1.3-SNAPSHOT](../../../4.1-SNAPSHOT/reference/packaging/native-image/index.html) * [4.0.10-SNAPSHOT](../../../4.0-SNAPSHOT/reference/packaging/native-image/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/packaging/container-images/cloud-native-buildpacks.html ---- # Cloud Native Buildpacks Docker images can be built directly from your Maven or Gradle plugin using [Cloud Native Buildpacks](https://buildpacks.io). If you’ve ever used an application platform such as Cloud Foundry or Heroku then you’ve probably used a buildpack. Buildpacks are the part of the platform that takes your application and converts it into something that the platform can actually run. For example, Cloud Foundry’s Java buildpack will notice that you’re pushing a `.jar` file and automatically add a relevant JRE. With Cloud Native Buildpacks, you can create Docker compatible images that you can run anywhere. Spring Boot includes buildpack support directly for both Maven and Gradle. This means you can just type a single command and quickly get a sensible image into your locally running Docker daemon. See the individual plugin documentation on how to use buildpacks with [Maven](../../../maven-plugin/build-image.html#build-image) and [Gradle](../../../gradle-plugin/packaging-oci-image.html). | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The [Paketo Spring Boot buildpack](https://github.com/paketo-buildpacks/spring-boot) supports the `layers.idx` file, so any [layer customization](efficient-images.html#packaging.container-images.efficient-images.layering) that is applied to it will be reflected in the image created by the buildpacks. | | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | In order to achieve reproducible builds and container image caching, buildpacks can manipulate the application resources metadata (such as the file "last modified" information). You should ensure that your application does not rely on that metadata at runtime. Spring Boot can use that information when serving static resources, but this can be disabled with `spring.web.resources.cache.use-last-modified`. | * [Spring Boot](../../../index.html) * [4.1.1](cloud-native-buildpacks.html) * [4.0.8](../../../4.0/reference/packaging/container-images/cloud-native-buildpacks.html) * [3.5.16](../../../3.5/reference/packaging/container-images/cloud-native-buildpacks.html) * [3.4.13](../../../3.4/reference/packaging/container-images/cloud-native-buildpacks.html) * [3.3.13](../../../3.3/reference/packaging/container-images/cloud-native-buildpacks.html) - [4.2.0-M2](../../../4.2/reference/packaging/container-images/cloud-native-buildpacks.html) * [4.2.0-SNAPSHOT](../../../4.2-SNAPSHOT/reference/packaging/container-images/cloud-native-buildpacks.html) * [4.1.3-SNAPSHOT](../../../4.1-SNAPSHOT/reference/packaging/container-images/cloud-native-buildpacks.html) * [4.0.10-SNAPSHOT](../../../4.0-SNAPSHOT/reference/packaging/container-images/cloud-native-buildpacks.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/features/index.html ---- # Core Features This section dives into the details of Spring Boot. Here you can learn about the key features that you may want to use and customize. If you have not already done so, you might want to read the [Tutorials](../../tutorial/index.html) and [Developing with Spring Boot](../using/index.html) sections, so that you have a good grounding of the basics. * [Spring Boot](../../index.html) * [4.1.1](index.html) * [4.0.8](../../4.0/reference/features/index.html) * [3.5.16](../../3.5/reference/features/index.html) * [3.4.13](../../3.4/reference/features/index.html) * [3.3.13](../../3.3/reference/features/index.html) - [4.2.0-M2](../../4.2/reference/features/index.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/features/index.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/features/index.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/features/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/testing/test-scope-dependencies.html ---- # Test Scope Dependencies The `spring-boot-starter-test` starter (in the `test` `scope`) contains the following provided libraries: * [JUnit](https://junit.org): The de-facto standard for unit testing Java applications. * [Spring Test](https://docs.spring.io/spring-framework/reference/7.0/testing/integration.html) & Spring Boot Test: Utilities and integration test support for Spring Boot applications. * [AssertJ](https://assertj.github.io/doc/): A fluent assertion library. * [Hamcrest](https://github.com/hamcrest/JavaHamcrest): A library of matcher objects (also known as constraints or predicates). * [Mockito](https://site.mockito.org/): A Java mocking framework. * [JSONassert](https://github.com/skyscreamer/JSONassert): An assertion library for JSON. * [JsonPath](https://github.com/jayway/JsonPath): XPath for JSON. * [Awaitility](https://github.com/awaitility/awaitility): A library for testing asynchronous systems. We generally find these common libraries to be useful when writing tests. If these libraries do not suit your needs, you can add additional test dependencies of your own. * [Spring Boot](../../index.html) * [4.1.1](test-scope-dependencies.html) * [4.0.8](../../4.0/reference/testing/test-scope-dependencies.html) * [3.5.16](../../3.5/reference/testing/test-scope-dependencies.html) * [3.4.13](../../3.4/reference/testing/test-scope-dependencies.html) * [3.3.13](../../3.3/reference/testing/test-scope-dependencies.html) - [4.2.0-M2](../../4.2/reference/testing/test-scope-dependencies.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/testing/test-scope-dependencies.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/testing/test-scope-dependencies.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/testing/test-scope-dependencies.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/data/nosql.html ---- # Working with NoSQL Technologies Spring Data provides additional projects that help you access a variety of NoSQL technologies, including: * [Cassandra](https://spring.io/projects/spring-data-cassandra) * [Couchbase](https://spring.io/projects/spring-data-couchbase) * [Elasticsearch](https://spring.io/projects/spring-data-elasticsearch) * [Geode](https://spring.io/projects/spring-data-geode) * [LDAP](https://spring.io/projects/spring-data-ldap) * [MongoDB](https://spring.io/projects/spring-data-mongodb) * [Neo4J](https://spring.io/projects/spring-data-neo4j) * [Redis](https://spring.io/projects/spring-data-redis) Of these, Spring Boot provides auto-configuration for Cassandra, Couchbase, Elasticsearch, LDAP, MongoDB, Neo4J and Redis. Additionally, [Spring Boot for Apache Geode](https://github.com/spring-projects/spring-boot-data-geode) provides [auto-configuration for Apache Geode](https://docs.spring.io/spring-boot-data-geode-build/2.0.x/reference/html5#geode-repositories). You can make use of the other projects, but you must configure them yourself. See the appropriate reference documentation at [spring.io/projects/spring-data](https://spring.io/projects/spring-data). ## [](#data.nosql.redis)Redis [Redis](https://redis.io/) is a cache, message broker, and richly-featured key-value store. Spring Boot offers basic auto-configuration for the [Lettuce](https://github.com/redis/lettuce/) and [Jedis](https://github.com/redis/jedis/) client libraries and the abstractions on top of them provided by [Spring Data Redis](https://github.com/spring-projects/spring-data-redis). There is a `spring-boot-starter-data-redis` starter for collecting the dependencies in a convenient way. By default, it uses [Lettuce](https://github.com/redis/lettuce/). That starter handles both traditional and reactive applications. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------- | | ** | We also provide a `spring-boot-starter-data-redis-reactive` starter for consistency with the other stores with reactive support. | ### [](#data.nosql.redis.connecting)Connecting to Redis You can inject an auto-configured [`RedisConnectionFactory`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/connection/RedisConnectionFactory.html), [`StringRedisTemplate`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/core/StringRedisTemplate.html), or vanilla [`RedisTemplate`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/core/RedisTemplate.html) instance as you would any other Spring Bean. The following listing shows an example of such a bean: * Java * Kotlin ```java import org.springframework.data.redis.core.StringRedisTemplate; import org.springframework.stereotype.Component; @Component public class MyBean { private final StringRedisTemplate template; public MyBean(StringRedisTemplate template) { this.template = template; } // ... public Boolean someMethod() { return this.template.hasKey("spring"); } } ``` ```kotlin import org.springframework.data.redis.core.StringRedisTemplate import org.springframework.stereotype.Component @Component class MyBean(private val template: StringRedisTemplate) { // ... fun someMethod(): Boolean { return template.hasKey("spring") } } ``` By default, the instance tries to connect to a Redis server at `localhost:6379`. You can specify custom connection details using `spring.data.redis.*` properties, as shown in the following example: * Properties * YAML ```properties spring.data.redis.host=localhost spring.data.redis.port=6379 spring.data.redis.database=0 spring.data.redis.username=user spring.data.redis.password=secret ``` ```yaml spring: data: redis: host: "localhost" port: 6379 database: 0 username: "user" password: "secret" ``` You can also specify the url of the Redis server directly. When setting the url, the host, port, username and password properties are ignored. This is shown in the following example: * Properties * YAML ```properties spring.data.redis.url=redis://user:secret@localhost:6379 spring.data.redis.database=0 ``` ```yaml spring: data: redis: url: "redis://user:secret@localhost:6379" database: 0 ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You can also register an arbitrary number of beans that implement [`LettuceClientConfigurationBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/redis/autoconfigure/LettuceClientConfigurationBuilderCustomizer.html) for more advanced customizations. [`ClientResources`](https://javadoc.io/doc/io.lettuce/lettuce-core/7.5.2.RELEASE/io/lettuce/core/resource/ClientResources.html) can also be customized using [`ClientResourcesBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/redis/autoconfigure/ClientResourcesBuilderCustomizer.html). If you use Jedis, [`JedisClientConfigurationBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/redis/autoconfigure/JedisClientConfigurationBuilderCustomizer.html) is also available. | Alternatively, you can register a bean of type [`RedisStandaloneConfiguration`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/connection/RedisStandaloneConfiguration.html), [`RedisSentinelConfiguration`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/connection/RedisSentinelConfiguration.html), [`RedisClusterConfiguration`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/connection/RedisClusterConfiguration.html), or [`RedisStaticMasterReplicaConfiguration`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/connection/RedisStaticMasterReplicaConfiguration.html) to take full control over the configuration. | | | | -- | ----------------------------------------- | | ** | master/replica is not supported by Jedis. | If you add your own [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) of any of the auto-configured types, it replaces the default (except in the case of [`RedisTemplate`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/core/RedisTemplate.html), when the exclusion is based on the bean name, `redisTemplate`, not its type). By default, a pooled connection factory is auto-configured if `commons-pool2` is on the classpath. The auto-configured [`RedisConnectionFactory`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/connection/RedisConnectionFactory.html) can be configured to use SSL for communication with the server by setting the properties as shown in this example: * Properties * YAML ```properties spring.data.redis.ssl.enabled=true ``` ```yaml spring: data: redis: ssl: enabled: true ``` Custom SSL trust material can be configured in an [SSL bundle](../features/ssl.html) and applied to the [`RedisConnectionFactory`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/connection/RedisConnectionFactory.html) as shown in this example: * Properties * YAML ```properties spring.data.redis.ssl.bundle=example ``` ```yaml spring: data: redis: ssl: bundle: "example" ``` ### [](#data.nosql.redis.receiving)Receiving a Message When the Redis infrastructure is present, any bean can be annotated with [`@RedisListener`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/annotation/RedisListener.html) to create a listener endpoint. If no [`RedisMessageListenerContainer`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/listener/RedisMessageListenerContainer.html) has been defined, a default one is configured automatically. The following component creates a listener endpoint on the `someChannel` channel: * Java * Kotlin ```java import org.springframework.data.redis.annotation.RedisListener; import org.springframework.stereotype.Component; @Component public class MyBean { @RedisListener("someChannel") public void processMessage(String content) { // ... } } ``` ```kotlin import org.springframework.data.redis.annotation.RedisListener import org.springframework.stereotype.Component @Component class MyBean { @RedisListener("someChannel") fun processMessage(content: String) { // ... } } ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | See the [`@EnableRedisListeners`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/annotation/EnableRedisListeners.html) API documentation for more details. | If you need to create more [`RedisMessageListenerContainer`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/listener/RedisMessageListenerContainer.html) instances or if you want to override the default, Spring Boot provides a [`RedisMessageListenerContainerConfigurer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/data/redis/autoconfigure/RedisMessageListenerContainerConfigurer.html) that you can use to initialize a [`RedisMessageListenerContainer`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/listener/RedisMessageListenerContainer.html) with the same settings as the one that is auto-configured. For instance, the following example exposes another container that uses a specific [`RedisConnectionFactory`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/connection/RedisConnectionFactory.html): * Java * Kotlin ```java import org.springframework.boot.data.redis.autoconfigure.RedisMessageListenerContainerConfigurer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.data.redis.connection.RedisConnectionFactory; import org.springframework.data.redis.listener.RedisMessageListenerContainer; @Configuration(proxyBeanMethods = false) public class MyRedisConfiguration { @Bean public RedisMessageListenerContainer myRedisMessageListenerContainer( RedisMessageListenerContainerConfigurer configurer, RedisConnectionFactory connectionFactory) { RedisMessageListenerContainer container = new RedisMessageListenerContainer(); configurer.configure(container, connectionFactory); // ... custom configuration return container; } } ``` ```kotlin import org.springframework.boot.data.redis.autoconfigure.RedisMessageListenerContainerConfigurer import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.data.redis.connection.RedisConnectionFactory import org.springframework.data.redis.listener.RedisMessageListenerContainer @Configuration(proxyBeanMethods = false) class MyRedisConfiguration { @Bean fun myRedisMessageListenerContainer( configurer: RedisMessageListenerContainerConfigurer, connectionFactory: RedisConnectionFactory ): RedisMessageListenerContainer { val container = RedisMessageListenerContainer() configurer.configure(container, connectionFactory) // ... custom configuration return container } } ``` Then you can use the container in any [`@RedisListener`](https://docs.spring.io/spring-data/redis/docs/4.1.x/api/org/springframework/data/redis/annotation/RedisListener.html)-annotated method as follows: * Java * Kotlin ```java import org.springframework.data.redis.annotation.RedisListener; import org.springframework.stereotype.Component; @Component public class MyBean { @RedisListener(topic = "someChannel", container = "myRedisMessageListenerContainer") public void processMessage(String content) { // ... } } ``` ```kotlin import org.springframework.data.redis.annotation.RedisListener import org.springframework.stereotype.Component @Component class MyBean { @RedisListener(topic = "someChannel", container = "myRedisMessageListenerContainer") fun processMessage(content: String) { // ... } } ``` ## [](#data.nosql.mongodb)MongoDB [MongoDB](https://www.mongodb.com/) is an open-source NoSQL document database that uses a JSON-like schema instead of traditional table-based relational data. Spring Boot offers several conveniences for working with MongoDB, including the `spring-boot-starter-data-mongodb` and `spring-boot-starter-data-mongodb-reactive` starters. ### [](#data.nosql.mongodb.connecting)Connecting to a MongoDB Database To access MongoDB databases, you can inject an auto-configured [`MongoDatabaseFactory`](https://docs.spring.io/spring-data/mongodb/docs/5.1.x/api/org/springframework/data/mongodb/MongoDatabaseFactory.html). By default, the instance tries to connect to a MongoDB server at `mongodb://localhost/test`. The following example shows how to connect to a MongoDB database: * Java * Kotlin ```java import com.mongodb.client.MongoCollection; import com.mongodb.client.MongoDatabase; import org.bson.Document; import org.springframework.data.mongodb.MongoDatabaseFactory; import org.springframework.stereotype.Component; @Component public class MyBean { private final MongoDatabaseFactory mongo; public MyBean(MongoDatabaseFactory mongo) { this.mongo = mongo; } // ... public MongoCollection someMethod() { MongoDatabase db = this.mongo.getMongoDatabase(); return db.getCollection("users"); } } ``` ```kotlin import com.mongodb.client.MongoCollection import org.bson.Document import org.springframework.data.mongodb.MongoDatabaseFactory import org.springframework.stereotype.Component @Component class MyBean(private val mongo: MongoDatabaseFactory) { // ... fun someMethod(): MongoCollection { val db = mongo.mongoDatabase return db.getCollection("users") } } ``` If you have defined your own [`MongoClient`](https://mongodb.github.io/mongo-java-driver/5.8/apidocs/mongodb-driver-sync/com/mongodb/client/MongoClient.html), it will be used to auto-configure a suitable [`MongoDatabaseFactory`](https://docs.spring.io/spring-data/mongodb/docs/5.1.x/api/org/springframework/data/mongodb/MongoDatabaseFactory.html). The auto-configured [`MongoClient`](https://mongodb.github.io/mongo-java-driver/5.8/apidocs/mongodb-driver-sync/com/mongodb/client/MongoClient.html) is created using a [`MongoClientSettings`](https://mongodb.github.io/mongo-java-driver/5.8/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.html) bean. If you have defined your own [`MongoClientSettings`](https://mongodb.github.io/mongo-java-driver/5.8/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.html), it will be used without modification and the `spring.data.mongodb` properties will be ignored. Otherwise a [`MongoClientSettings`](https://mongodb.github.io/mongo-java-driver/5.8/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.html) will be auto-configured and will have the `spring.data.mongodb` properties applied to it. In either case, you can declare one or more [`MongoClientSettingsBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/mongodb/autoconfigure/MongoClientSettingsBuilderCustomizer.html) beans to fine-tune the [`MongoClientSettings`](https://mongodb.github.io/mongo-java-driver/5.8/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.html) configuration. Each will be called in order with the [`MongoClientSettings.Builder`](https://mongodb.github.io/mongo-java-driver/5.8/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html) that is used to build the [`MongoClientSettings`](https://mongodb.github.io/mongo-java-driver/5.8/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.html). You can set the `spring.mongodb.uri` property to change the URL and configure additional settings such as the *replica set*, as shown in the following example: * Properties * YAML ```properties spring.mongodb.uri=mongodb://user:[email protected]:27017,mongoserver2.example.com:23456/test ``` ```yaml spring: mongodb: uri: "mongodb://user:[email protected]:27017,mongoserver2.example.com:23456/test" ``` Alternatively, you can specify connection details using discrete properties. For example, you might declare the following settings in your `application.properties`: * Properties * YAML ```properties spring.mongodb.host=mongoserver1.example.com spring.mongodb.port=27017 spring.mongodb.additional-hosts[0]=mongoserver2.example.com:23456 spring.mongodb.database=test spring.mongodb.username=user spring.mongodb.password=secret ``` ```yaml spring: mongodb: host: "mongoserver1.example.com" port: 27017 additional-hosts: - "mongoserver2.example.com:23456" database: "test" username: "user" password: "secret" ``` The auto-configured [`MongoClient`](https://mongodb.github.io/mongo-java-driver/5.8/apidocs/mongodb-driver-sync/com/mongodb/client/MongoClient.html) can be configured to use SSL for communication with the server by setting the properties as shown in this example: * Properties * YAML ```properties spring.mongodb.uri=mongodb://user:[email protected]:27017,mongoserver2.example.com:23456/test spring.mongodb.ssl.enabled=true ``` ```yaml spring: mongodb: uri: "mongodb://user:[email protected]:27017,mongoserver2.example.com:23456/test" ssl: enabled: true ``` Custom SSL trust material can be configured in an [SSL bundle](../features/ssl.html) and applied to the [`MongoClient`](https://mongodb.github.io/mongo-java-driver/5.8/apidocs/mongodb-driver-sync/com/mongodb/client/MongoClient.html) as shown in this example: * Properties * YAML ```properties spring.mongodb.uri=mongodb://user:[email protected]:27017,mongoserver2.example.com:23456/test spring.mongodb.ssl.bundle=example ``` ```yaml spring: mongodb: uri: "mongodb://user:[email protected]:27017,mongoserver2.example.com:23456/test" ssl: bundle: "example" ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If `spring.mongodb.port` is not specified, the default of `27017` is used. You could delete this line from the example shown earlier.You can also specify the port as part of the host address by using the `host:port` syntax. This format should be used if you need to change the port of an `additional-hosts` entry. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | If you do not use Spring Data MongoDB, you can inject a [`MongoClient`](https://mongodb.github.io/mongo-java-driver/5.8/apidocs/mongodb-driver-sync/com/mongodb/client/MongoClient.html) bean instead of using [`MongoDatabaseFactory`](https://docs.spring.io/spring-data/mongodb/docs/5.1.x/api/org/springframework/data/mongodb/MongoDatabaseFactory.html). If you want to take complete control of establishing the MongoDB connection, you can also declare your own [`MongoDatabaseFactory`](https://docs.spring.io/spring-data/mongodb/docs/5.1.x/api/org/springframework/data/mongodb/MongoDatabaseFactory.html) or [`MongoClient`](https://mongodb.github.io/mongo-java-driver/5.8/apidocs/mongodb-driver-sync/com/mongodb/client/MongoClient.html) bean. | | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you are using the reactive driver, Netty is required for SSL. The auto-configuration configures this factory automatically if Netty is available and the factory to use has not been customized already. | ### [](#data.nosql.mongodb.template)MongoTemplate [Spring Data MongoDB](https://spring.io/projects/spring-data-mongodb) provides a [`MongoTemplate`](https://docs.spring.io/spring-data/mongodb/docs/5.1.x/api/org/springframework/data/mongodb/core/MongoTemplate.html) class that is very similar in its design to Spring’s [`JdbcTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/core/JdbcTemplate.html). As with [`JdbcTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jdbc/core/JdbcTemplate.html), Spring Boot auto-configures a bean for you to inject the template, as follows: * Java * Kotlin ```java import com.mongodb.client.MongoCollection; import org.bson.Document; import org.springframework.data.mongodb.core.MongoTemplate; import org.springframework.stereotype.Component; @Component public class MyBean { private final MongoTemplate mongoTemplate; public MyBean(MongoTemplate mongoTemplate) { this.mongoTemplate = mongoTemplate; } // ... public MongoCollection someMethod() { return this.mongoTemplate.getCollection("users"); } } ``` ```kotlin import com.mongodb.client.MongoCollection import org.bson.Document import org.springframework.data.mongodb.core.MongoTemplate import org.springframework.stereotype.Component @Component class MyBean(private val mongoTemplate: MongoTemplate) { // ... fun someMethod(): MongoCollection { return mongoTemplate.getCollection("users") } } ``` See the [`MongoOperations`](https://docs.spring.io/spring-data/mongodb/docs/5.1.x/api/org/springframework/data/mongodb/core/MongoOperations.html) API documentation for complete details. ### [](#data.nosql.mongodb.repositories)Spring Data MongoDB Repositories Spring Data includes repository support for MongoDB. As with the JPA repositories discussed earlier, the basic principle is that queries are constructed automatically, based on method names. In fact, both Spring Data JPA and Spring Data MongoDB share the same common infrastructure. You could take the JPA example from earlier and, assuming that `City` is now a MongoDB data class rather than a JPA [`@Entity`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/Entity.html), it works in the same way, as shown in the following example: * Java * Kotlin ```java import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; import org.springframework.data.repository.Repository; public interface CityRepository extends Repository { Page findAll(Pageable pageable); City findByNameAndStateAllIgnoringCase(String name, String state); } ``` ```kotlin import org.springframework.data.domain.Page import org.springframework.data.domain.Pageable import org.springframework.data.repository.Repository interface CityRepository : Repository { fun findAll(pageable: Pageable?): Page fun findByNameAndStateAllIgnoringCase(name: String, state: String): City? } ``` Repositories and documents are found through scanning. By default, the [auto-configuration packages](../using/auto-configuration.html#using.auto-configuration.packages) are scanned. You can customize the locations to look for repositories and documents by using [`@EnableMongoRepositories`](https://docs.spring.io/spring-data/mongodb/docs/5.1.x/api/org/springframework/data/mongodb/repository/config/EnableMongoRepositories.html) and [`@EntityScan`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/persistence/autoconfigure/EntityScan.html) respectively. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | For complete details of Spring Data MongoDB, including its rich object mapping technologies, see its [reference documentation](https://docs.spring.io/spring-data/mongodb/reference/5.1). | ## [](#data.nosql.neo4j)Neo4j [Neo4j](https://neo4j.com/) is an open-source NoSQL graph database that uses a rich data model of nodes connected by first class relationships, which is better suited for connected big data than traditional RDBMS approaches. Spring Boot offers several conveniences for working with Neo4j, including the `spring-boot-starter-data-neo4j` starter. ### [](#data.nosql.neo4j.connecting)Connecting to a Neo4j Database To access a Neo4j server, you can inject an auto-configured [`Driver`](https://javadoc.io/doc/org.neo4j.driver/neo4j-java-driver/6.1.0/org/neo4j/driver/Driver.html). By default, the instance tries to connect to a Neo4j server at `localhost:7687` using the Bolt protocol. The following example shows how to inject a Neo4j [`Driver`](https://javadoc.io/doc/org.neo4j.driver/neo4j-java-driver/6.1.0/org/neo4j/driver/Driver.html) that gives you access, amongst other things, to a [`Session`](https://javadoc.io/doc/org.neo4j.driver/neo4j-java-driver/6.1.0/org/neo4j/driver/Session.html): * Java * Kotlin ```java import org.neo4j.driver.Driver; import org.neo4j.driver.Session; import org.neo4j.driver.Values; import org.springframework.stereotype.Component; @Component public class MyBean { private final Driver driver; public MyBean(Driver driver) { this.driver = driver; } // ... public String someMethod(String message) { try (Session session = this.driver.session()) { return session.executeWrite( (transaction) -> transaction .run("CREATE (a:Greeting) SET a.message = $message RETURN a.message + ', from node ' + id(a)", Values.parameters("message", message)) .single() .get(0) .asString()); } } } ``` ```kotlin import org.neo4j.driver.Driver import org.neo4j.driver.TransactionContext import org.neo4j.driver.Values import org.springframework.stereotype.Component @Component class MyBean(private val driver: Driver) { // ... fun someMethod(message: String?): String { driver.session().use { session -> return@someMethod session.executeWrite { transaction: TransactionContext -> transaction .run( "CREATE (a:Greeting) SET a.message = \$message RETURN a.message + ', from node ' + id(a)", Values.parameters("message", message) ) .single()[0].asString() } } } } ``` You can configure various aspects of the driver using `spring.neo4j.*` properties. The following example shows how to configure the uri and credentials to use: * Properties * YAML ```properties spring.neo4j.uri=bolt://my-server:7687 spring.neo4j.authentication.username=neo4j spring.neo4j.authentication.password=secret ``` ```yaml spring: neo4j: uri: "bolt://my-server:7687" authentication: username: "neo4j" password: "secret" ``` The auto-configured [`Driver`](https://javadoc.io/doc/org.neo4j.driver/neo4j-java-driver/6.1.0/org/neo4j/driver/Driver.html) is created using `org.neo4j.driver.Config$ConfigBuilder`. To fine-tune its configuration, declare one or more [`ConfigBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/neo4j/autoconfigure/ConfigBuilderCustomizer.html) beans. Each will be called in order with the `org.neo4j.driver.Config$ConfigBuilder` that is used to build the [`Driver`](https://javadoc.io/doc/org.neo4j.driver/neo4j-java-driver/6.1.0/org/neo4j/driver/Driver.html). ### [](#data.nosql.neo4j.repositories)Spring Data Neo4j Repositories Spring Data includes repository support for Neo4j. For complete details of Spring Data Neo4j, see the [reference documentation](https://docs.spring.io/spring-data/neo4j/reference/8.1). Spring Data Neo4j shares the common infrastructure with Spring Data JPA as many other Spring Data modules do. You could take the JPA example from earlier and define `City` as Spring Data Neo4j [`@Node`](https://docs.spring.io/spring-data/neo4j/docs/8.1.x/api/org/springframework/data/neo4j/core/schema/Node.html) rather than JPA [`@Entity`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/Entity.html) and the repository abstraction works in the same way, as shown in the following example: * Java * Kotlin ```java import org.springframework.data.neo4j.repository.Neo4jRepository; public interface CityRepository extends Neo4jRepository { City findOneByNameAndState(String name, String state); } ``` ```kotlin import org.springframework.data.neo4j.repository.Neo4jRepository interface CityRepository : Neo4jRepository { fun findOneByNameAndState(name: String?, state: String?): City? } ``` The `spring-boot-starter-data-neo4j` starter enables the repository support as well as transaction management. Spring Boot supports both classic and reactive Neo4j repositories, using the [`Neo4jTemplate`](https://docs.spring.io/spring-data/neo4j/docs/8.1.x/api/org/springframework/data/neo4j/core/Neo4jTemplate.html) or [`ReactiveNeo4jTemplate`](https://docs.spring.io/spring-data/neo4j/docs/8.1.x/api/org/springframework/data/neo4j/core/ReactiveNeo4jTemplate.html) beans. When Project Reactor is available on the classpath, the reactive style is also auto-configured. Repositories and entities are found through scanning. By default, the [auto-configuration packages](../using/auto-configuration.html#using.auto-configuration.packages) are scanned. You can customize the locations to look for repositories and entities by using [`@EnableNeo4jRepositories`](https://docs.spring.io/spring-data/neo4j/docs/8.1.x/api/org/springframework/data/neo4j/repository/config/EnableNeo4jRepositories.html) and [`@EntityScan`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/persistence/autoconfigure/EntityScan.html) respectively. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | In an application using the reactive style, a [`ReactiveTransactionManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/transaction/ReactiveTransactionManager.html) is not auto-configured. To enable transaction management, the following bean must be defined in your configuration:- Java - Kotlin```java import org.neo4j.driver.Driver; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.data.neo4j.core.ReactiveDatabaseSelectionProvider; import org.springframework.data.neo4j.core.transaction.ReactiveNeo4jTransactionManager; @Configuration(proxyBeanMethods = false) public class MyNeo4jConfiguration { @Bean public ReactiveNeo4jTransactionManager reactiveTransactionManager(Driver driver, ReactiveDatabaseSelectionProvider databaseNameProvider) { return new ReactiveNeo4jTransactionManager(driver, databaseNameProvider); } } ``````kotlin import org.neo4j.driver.Driver import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.data.neo4j.core.ReactiveDatabaseSelectionProvider import org.springframework.data.neo4j.core.transaction.ReactiveNeo4jTransactionManager @Configuration(proxyBeanMethods = false) class MyNeo4jConfiguration { @Bean fun reactiveTransactionManager(driver: Driver, databaseNameProvider: ReactiveDatabaseSelectionProvider): ReactiveNeo4jTransactionManager { return ReactiveNeo4jTransactionManager(driver, databaseNameProvider) } } ``` | ## [](#data.nosql.elasticsearch)Elasticsearch [Elasticsearch](https://www.elastic.co/products/elasticsearch) is an open source, distributed, RESTful search and analytics engine. Spring Boot offers basic auto-configuration for Elasticsearch clients. Spring Boot supports several clients: * The official low-level REST client * The official Java API client * The [`ReactiveElasticsearchClient`](https://docs.spring.io/spring-data/elasticsearch/docs/6.1.x/api/org/springframework/data/elasticsearch/client/elc/ReactiveElasticsearchClient.html) provided by Spring Data Elasticsearch Spring Boot provides a dedicated starter, `spring-boot-starter-data-elasticsearch`. ### [](#data.nosql.elasticsearch.connecting-using-rest)Connecting to Elasticsearch Using REST clients Elasticsearch ships two different REST clients that you can use to query a cluster: the [low-level client](https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest5-client/) and the [Java API client](https://www.elastic.co/docs/reference/elasticsearch/clients/java). The Java API client is provided by the `co.elastic.clients:elasticsearch-java` module and the low-level client is provided by the `co.elastic.clients:elasticsearch-rest5-client` module. Additionally, Spring Boot provides support for a reactive client from the `org.springframework.data:spring-data-elasticsearch` module. By default, the clients will target `localhost:9200`. You can use `spring.elasticsearch.*` properties to further tune how the clients are configured, as shown in the following example: * Properties * YAML ```properties spring.elasticsearch.uris=https://search.example.com:9200 spring.elasticsearch.socket-timeout=10s spring.elasticsearch.username=user spring.elasticsearch.password=secret ``` ```yaml spring: elasticsearch: uris: "https://search.example.com:9200" socket-timeout: "10s" username: "user" password: "secret" ``` #### [](#data.nosql.elasticsearch.connecting-using-rest.restclient)Connecting to Elasticsearch Using Rest5Client If you have `co.elastic.clients:elasticsearch-rest5-client` on the classpath, Spring Boot will auto-configure and register a [`Rest5Client`](https://javadoc.io/doc/co.elastic.clients/elasticsearch-java/9.4.5/index.html/co/elastic/clients/transport/rest5_client/low_level/Rest5Client.html) bean. In addition to the properties described previously, to fine-tune the [`Rest5Client`](https://javadoc.io/doc/co.elastic.clients/elasticsearch-java/9.4.5/index.html/co/elastic/clients/transport/rest5_client/low_level/Rest5Client.html) you can register an arbitrary number of beans that implement [`Rest5ClientBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/elasticsearch/autoconfigure/Rest5ClientBuilderCustomizer.html) for more advanced customizations. To take full control over the client’s configuration, define a [`Rest5ClientBuilder`](https://javadoc.io/doc/co.elastic.clients/elasticsearch-java/9.4.5/index.html/co/elastic/clients/transport/rest5_client/low_level/Rest5ClientBuilder.html) bean. Additionally, a [`Sniffer`](https://javadoc.io/doc/co.elastic.clients/elasticsearch-java/9.4.5/index.html/co/elastic/clients/transport/rest5_client/low_level/sniffer/Sniffer.html) can be auto-configured to automatically discover nodes from a running Elasticsearch cluster and set them on the [`Rest5Client`](https://javadoc.io/doc/co.elastic.clients/elasticsearch-java/9.4.5/index.html/co/elastic/clients/transport/rest5_client/low_level/Rest5Client.html) bean. You can further tune how [`Sniffer`](https://javadoc.io/doc/co.elastic.clients/elasticsearch-java/9.4.5/index.html/co/elastic/clients/transport/rest5_client/low_level/sniffer/Sniffer.html) is configured, as shown in the following example: * Properties * YAML ```properties spring.elasticsearch.restclient.sniffer.enabled=true spring.elasticsearch.restclient.sniffer.interval=10m spring.elasticsearch.restclient.sniffer.delay-after-failure=30s ``` ```yaml spring: elasticsearch: restclient: sniffer: enabled: true interval: "10m" delay-after-failure: "30s" ``` #### [](#data.nosql.elasticsearch.connecting-using-rest.javaapiclient)Connecting to Elasticsearch Using ElasticsearchClient If you use the `spring-boot-starter-elasticsearch` or have added `co.elastic.clients:elasticsearch-java` to the classpath, Spring Boot will auto-configure and register an [`ElasticsearchClient`](https://javadoc.io/doc/co.elastic.clients/elasticsearch-java/9.4.5/index.html/co/elastic/clients/elasticsearch/ElasticsearchClient.html) bean. The [`ElasticsearchClient`](https://javadoc.io/doc/co.elastic.clients/elasticsearch-java/9.4.5/index.html/co/elastic/clients/elasticsearch/ElasticsearchClient.html) uses a transport that depends upon the previously described [`Rest5Client`](https://javadoc.io/doc/co.elastic.clients/elasticsearch-java/9.4.5/index.html/co/elastic/clients/transport/rest5_client/low_level/Rest5Client.html). Therefore, the properties described previously can be used to configure the [`ElasticsearchClient`](https://javadoc.io/doc/co.elastic.clients/elasticsearch-java/9.4.5/index.html/co/elastic/clients/elasticsearch/ElasticsearchClient.html). Furthermore, you can define a [`Rest5ClientOptions`](https://javadoc.io/doc/co.elastic.clients/elasticsearch-java/9.4.5/index.html/co/elastic/clients/transport/rest5_client/Rest5ClientOptions.html) bean to take further control of the behavior of the transport. #### [](#data.nosql.elasticsearch.connecting-using-rest.reactiveclient)Connecting to Elasticsearch using ReactiveElasticsearchClient [Spring Data Elasticsearch](https://spring.io/projects/spring-data-elasticsearch) ships [`ReactiveElasticsearchClient`](https://docs.spring.io/spring-data/elasticsearch/docs/6.1.x/api/org/springframework/data/elasticsearch/client/elc/ReactiveElasticsearchClient.html) for querying Elasticsearch instances in a reactive fashion. If you have Spring Data Elasticsearch and Reactor on the classpath, Spring Boot will auto-configure and register a [`ReactiveElasticsearchClient`](https://docs.spring.io/spring-data/elasticsearch/docs/6.1.x/api/org/springframework/data/elasticsearch/client/elc/ReactiveElasticsearchClient.html). The [`ReactiveElasticsearchClient`](https://docs.spring.io/spring-data/elasticsearch/docs/6.1.x/api/org/springframework/data/elasticsearch/client/elc/ReactiveElasticsearchClient.html) uses a transport that depends upon the previously described [`Rest5Client`](https://javadoc.io/doc/co.elastic.clients/elasticsearch-java/9.4.5/index.html/co/elastic/clients/transport/rest5_client/low_level/Rest5Client.html). Therefore, the properties described previously can be used to configure the [`ReactiveElasticsearchClient`](https://docs.spring.io/spring-data/elasticsearch/docs/6.1.x/api/org/springframework/data/elasticsearch/client/elc/ReactiveElasticsearchClient.html). Furthermore, you can define a [`Rest5ClientOptions`](https://javadoc.io/doc/co.elastic.clients/elasticsearch-java/9.4.5/index.html/co/elastic/clients/transport/rest5_client/Rest5ClientOptions.html) bean to take further control of the behavior of the transport. ### [](#data.nosql.elasticsearch.connecting-using-spring-data)Connecting to Elasticsearch by Using Spring Data To connect to Elasticsearch, an [`ElasticsearchClient`](https://javadoc.io/doc/co.elastic.clients/elasticsearch-java/9.4.5/index.html/co/elastic/clients/elasticsearch/ElasticsearchClient.html) bean must be defined, auto-configured by Spring Boot or manually provided by the application (see previous sections). With this configuration in place, an [`ElasticsearchTemplate`](https://docs.spring.io/spring-data/elasticsearch/docs/6.1.x/api/org/springframework/data/elasticsearch/client/elc/ElasticsearchTemplate.html) can be injected like any other Spring bean, as shown in the following example: * Java * Kotlin ```java import org.springframework.data.elasticsearch.client.elc.ElasticsearchTemplate; import org.springframework.stereotype.Component; @Component public class MyBean { private final ElasticsearchTemplate template; public MyBean(ElasticsearchTemplate template) { this.template = template; } // ... public boolean someMethod(String id) { return this.template.exists(id, User.class); } } ``` ```kotlin import org.springframework.stereotype.Component @Component class MyBean(private val template: org.springframework.data.elasticsearch.client.elc.ElasticsearchTemplate ) { // ... fun someMethod(id: String): Boolean { return template.exists(id, User::class.java) } } ``` In the presence of `spring-data-elasticsearch` and Reactor, Spring Boot can also auto-configure a [`ReactiveElasticsearchClient`](#data.nosql.elasticsearch.connecting-using-rest.reactiveclient) and a [`ReactiveElasticsearchTemplate`](https://docs.spring.io/spring-data/elasticsearch/docs/6.1.x/api/org/springframework/data/elasticsearch/client/elc/ReactiveElasticsearchTemplate.html) as beans. They are the reactive equivalent of the other REST clients. ### [](#data.nosql.elasticsearch.repositories)Spring Data Elasticsearch Repositories Spring Data includes repository support for Elasticsearch. As with the JPA repositories discussed earlier, the basic principle is that queries are constructed for you automatically based on method names. In fact, both Spring Data JPA and Spring Data Elasticsearch share the same common infrastructure. You could take the JPA example from earlier and, assuming that `City` is now an Elasticsearch [`@Document`](https://docs.spring.io/spring-data/elasticsearch/docs/6.1.x/api/org/springframework/data/elasticsearch/annotations/Document.html) class rather than a JPA [`@Entity`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/Entity.html), it works in the same way. Repositories and documents are found through scanning. By default, the [auto-configuration packages](../using/auto-configuration.html#using.auto-configuration.packages) are scanned. You can customize the locations to look for repositories and documents by using [`@EnableElasticsearchRepositories`](https://docs.spring.io/spring-data/elasticsearch/docs/6.1.x/api/org/springframework/data/elasticsearch/repository/config/EnableElasticsearchRepositories.html) and [`@EntityScan`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/persistence/autoconfigure/EntityScan.html) respectively. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | For complete details of Spring Data Elasticsearch, see the [reference documentation](https://docs.spring.io/spring-data/elasticsearch/reference/6.1). | Spring Boot supports both classic and reactive Elasticsearch repositories, using the [`ElasticsearchTemplate`](https://docs.spring.io/spring-data/elasticsearch/docs/6.1.x/api/org/springframework/data/elasticsearch/client/elc/ElasticsearchTemplate.html) or [`ReactiveElasticsearchTemplate`](https://docs.spring.io/spring-data/elasticsearch/docs/6.1.x/api/org/springframework/data/elasticsearch/client/elc/ReactiveElasticsearchTemplate.html) beans. Most likely those beans are auto-configured by Spring Boot given the required dependencies are present. If you wish to use your own template for backing the Elasticsearch repositories, you can add your own [`ElasticsearchTemplate`](https://docs.spring.io/spring-data/elasticsearch/docs/6.1.x/api/org/springframework/data/elasticsearch/client/elc/ElasticsearchTemplate.html) or [`ElasticsearchOperations`](https://docs.spring.io/spring-data/elasticsearch/docs/6.1.x/api/org/springframework/data/elasticsearch/core/ElasticsearchOperations.html) [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html), as long as it is named `"elasticsearchTemplate"`. Same applies to [`ReactiveElasticsearchTemplate`](https://docs.spring.io/spring-data/elasticsearch/docs/6.1.x/api/org/springframework/data/elasticsearch/client/elc/ReactiveElasticsearchTemplate.html) and [`ReactiveElasticsearchOperations`](https://docs.spring.io/spring-data/elasticsearch/docs/6.1.x/api/org/springframework/data/elasticsearch/core/ReactiveElasticsearchOperations.html), with the bean name `"reactiveElasticsearchTemplate"`. You can choose to disable the repositories support with the following property: * Properties * YAML ```properties spring.data.elasticsearch.repositories.enabled=false ``` ```yaml spring: data: elasticsearch: repositories: enabled: false ``` ## [](#data.nosql.cassandra)Cassandra [Cassandra](https://cassandra.apache.org/) is an open source, distributed database management system designed to handle large amounts of data across many commodity servers. Spring Boot offers auto-configuration for Cassandra and the abstractions on top of it provided by [Spring Data Cassandra](https://spring.io/projects/spring-data-cassandra). There is a `spring-boot-starter-data-cassandra` starter for collecting the dependencies in a convenient way. ### [](#data.nosql.cassandra.connecting)Connecting to Cassandra You can inject an auto-configured [`CqlTemplate`](https://docs.spring.io/spring-data/cassandra/docs/5.1.x/api/org/springframework/data/cassandra/core/cql/CqlTemplate.html), [`CassandraTemplate`](https://docs.spring.io/spring-data/cassandra/docs/5.1.x/api/org/springframework/data/cassandra/core/CassandraTemplate.html), or a Cassandra `CqlSession` instance as you would with any other Spring Bean. The `spring.cassandra.*` properties can be used to customize the connection. Generally, you provide `keyspace-name` and `contact-points` as well the local datacenter name, as shown in the following example: * Properties * YAML ```properties spring.cassandra.keyspace-name=mykeyspace spring.cassandra.contact-points=cassandrahost1:9042,cassandrahost2:9042 spring.cassandra.local-datacenter=datacenter1 ``` ```yaml spring: cassandra: keyspace-name: "mykeyspace" contact-points: "cassandrahost1:9042,cassandrahost2:9042" local-datacenter: "datacenter1" ``` If the port is the same for all your contact points you can use a shortcut and only specify the host names, as shown in the following example: * Properties * YAML ```properties spring.cassandra.keyspace-name=mykeyspace spring.cassandra.contact-points=cassandrahost1,cassandrahost2 spring.cassandra.local-datacenter=datacenter1 ``` ```yaml spring: cassandra: keyspace-name: "mykeyspace" contact-points: "cassandrahost1,cassandrahost2" local-datacenter: "datacenter1" ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------- | | ** | Those two examples are identical as the port default to `9042`. If you need to configure the port, use `spring.cassandra.port`. | The auto-configured `CqlSession` can be configured to use SSL for communication with the server by setting the properties as shown in this example: * Properties * YAML ```properties spring.cassandra.keyspace-name=mykeyspace spring.cassandra.contact-points=cassandrahost1,cassandrahost2 spring.cassandra.local-datacenter=datacenter1 spring.cassandra.ssl.enabled=true ``` ```yaml spring: cassandra: keyspace-name: "mykeyspace" contact-points: "cassandrahost1,cassandrahost2" local-datacenter: "datacenter1" ssl: enabled: true ``` Custom SSL trust material can be configured in an [SSL bundle](../features/ssl.html) and applied to the `CqlSession` as shown in this example: * Properties * YAML ```properties spring.cassandra.keyspace-name=mykeyspace spring.cassandra.contact-points=cassandrahost1,cassandrahost2 spring.cassandra.local-datacenter=datacenter1 spring.cassandra.ssl.bundle=example ``` ```yaml spring: cassandra: keyspace-name: "mykeyspace" contact-points: "cassandrahost1,cassandrahost2" local-datacenter: "datacenter1" ssl: bundle: "example" ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | The Cassandra driver has its own configuration infrastructure that loads an `application.conf` at the root of the classpath.Spring Boot does not look for such a file by default but can load one using `spring.cassandra.config`. If a property is both present in `spring.cassandra.*` and the configuration file, the value in `spring.cassandra.*` takes precedence.For more advanced driver customizations, you can register an arbitrary number of beans that implement [`DriverConfigLoaderBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/cassandra/autoconfigure/DriverConfigLoaderBuilderCustomizer.html). The `CqlSession` can be customized with a bean of type [`CqlSessionBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/cassandra/autoconfigure/CqlSessionBuilderCustomizer.html). | | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you use `CqlSessionBuilder` to create multiple `CqlSession` beans, keep in mind the builder is mutable so make sure to inject a fresh copy for each session. | The following code listing shows how to inject a Cassandra bean: * Java * Kotlin ```java import org.springframework.data.cassandra.core.CassandraTemplate; import org.springframework.stereotype.Component; @Component public class MyBean { private final CassandraTemplate template; public MyBean(CassandraTemplate template) { this.template = template; } // ... public long someMethod() { return this.template.count(User.class); } } ``` ```kotlin import org.springframework.data.cassandra.core.CassandraTemplate import org.springframework.stereotype.Component @Component class MyBean(private val template: CassandraTemplate) { // ... fun someMethod(): Long { return template.count(User::class.java) } } ``` If you add your own [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) of type [`CassandraTemplate`](https://docs.spring.io/spring-data/cassandra/docs/5.1.x/api/org/springframework/data/cassandra/core/CassandraTemplate.html), it replaces the default. ### [](#data.nosql.cassandra.repositories)Spring Data Cassandra Repositories Spring Data includes basic repository support for Cassandra. Currently, this is more limited than the JPA repositories discussed earlier and needs [`@Query`](https://docs.spring.io/spring-data/cassandra/docs/5.1.x/api/org/springframework/data/cassandra/repository/Query.html) annotated finder methods. Repositories and entities are found through scanning. By default, the [auto-configuration packages](../using/auto-configuration.html#using.auto-configuration.packages) are scanned. You can customize the locations to look for repositories and entities by using [`@EnableCassandraRepositories`](https://docs.spring.io/spring-data/cassandra/docs/5.1.x/api/org/springframework/data/cassandra/repository/config/EnableCassandraRepositories.html) and [`@EntityScan`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/persistence/autoconfigure/EntityScan.html) respectively. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------- | | ** | For complete details of Spring Data Cassandra, see the [reference documentation](https://docs.spring.io/spring-data/cassandra/reference/5.1). | ## [](#data.nosql.couchbase)Couchbase [Couchbase](https://www.couchbase.com/) is an open-source, distributed, multi-model NoSQL document-oriented database that is optimized for interactive applications. Spring Boot offers auto-configuration for Couchbase and the abstractions on top of it provided by [Spring Data Couchbase](https://github.com/spring-projects/spring-data-couchbase). There are `spring-boot-starter-data-couchbase` and `spring-boot-starter-data-couchbase-reactive` starters for collecting the dependencies in a convenient way. ### [](#data.nosql.couchbase.connecting)Connecting to Couchbase You can get a [`Cluster`](https://javadoc.io/doc/com.couchbase.client/java-client/3.11.3/com/couchbase/client/java/Cluster.html) by adding the Couchbase SDK and some configuration. The `spring.couchbase.*` properties can be used to customize the connection. Generally, you provide the [connection string](https://docs.couchbase.com/dotnet-sdk/current/howtos/managing-connections.html) and credentials for authentication. Basic authentication with username and password can be configured as shown in the following example: * Properties * YAML ```properties spring.couchbase.connection-string=couchbase://192.168.1.123 spring.couchbase.username=user spring.couchbase.password=secret ``` ```yaml spring: couchbase: connection-string: "couchbase://192.168.1.123" username: "user" password: "secret" ``` [Client certificates](https://docs.couchbase.com/server/current/manage/manage-security/configure-client-certificates.html) can be used for authentication instead of username and password. The location and password for a Java KeyStore containing client certificates can be configured as shown in the following example: * Properties * YAML ```properties spring.couchbase.connection-string=couchbase://192.168.1.123 spring.couchbase.env.ssl.enabled=true spring.couchbase.authentication.jks.location=classpath:client.p12 spring.couchbase.authentication.jks.password=secret ``` ```yaml spring: couchbase: connection-string: "couchbase://192.168.1.123" env: ssl: enabled: true authentication: jks: location: "classpath:client.p12" password: "secret" ``` PEM-encoded certificates and a private key can be configured as shown in the following example: * Properties * YAML ```properties spring.couchbase.connection-string=couchbase://192.168.1.123 spring.couchbase.env.ssl.enabled=true spring.couchbase.authentication.pem.certificates=classpath:client.crt spring.couchbase.authentication.pem.private-key=classpath:client.key ``` ```yaml spring: couchbase: connection-string: "couchbase://192.168.1.123" env: ssl: enabled: true authentication: pem: certificates: "classpath:client.crt" private-key: "classpath:client.key" ``` It is also possible to customize some of the [`ClusterEnvironment`](https://javadoc.io/doc/com.couchbase.client/java-client/3.11.3/com/couchbase/client/java/env/ClusterEnvironment.html) settings. For instance, the following configuration changes the timeout to open a new [`Bucket`](https://javadoc.io/doc/com.couchbase.client/java-client/3.11.3/com/couchbase/client/java/Bucket.html) and enables SSL support with a reference to a configured [SSL bundle](../features/ssl.html): * Properties * YAML ```properties spring.couchbase.env.timeouts.connect=3s spring.couchbase.env.ssl.bundle=example ``` ```yaml spring: couchbase: env: timeouts: connect: "3s" ssl: bundle: "example" ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Check the `spring.couchbase.env.*` properties for more details. To take more control, one or more [`ClusterEnvironmentBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/couchbase/autoconfigure/ClusterEnvironmentBuilderCustomizer.html) beans can be used. | ### [](#data.nosql.couchbase.repositories)Spring Data Couchbase Repositories Spring Data includes repository support for Couchbase. Repositories and documents are found through scanning. By default, the [auto-configuration packages](../using/auto-configuration.html#using.auto-configuration.packages) are scanned. You can customize the locations to look for repositories and documents by using [`@EnableCouchbaseRepositories`](https://docs.spring.io/spring-data/couchbase/docs/6.1.x/api/org/springframework/data/couchbase/repository/config/EnableCouchbaseRepositories.html) and [`@EntityScan`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/persistence/autoconfigure/EntityScan.html) respectively. For complete details of Spring Data Couchbase, see the [reference documentation](https://docs.spring.io/spring-data/couchbase/reference/6.1). You can inject an auto-configured [`CouchbaseTemplate`](https://docs.spring.io/spring-data/couchbase/docs/6.1.x/api/org/springframework/data/couchbase/core/CouchbaseTemplate.html) instance as you would with any other Spring Bean, provided a [`CouchbaseClientFactory`](https://docs.spring.io/spring-data/couchbase/docs/6.1.x/api/org/springframework/data/couchbase/CouchbaseClientFactory.html) bean is available. This happens when a [`Cluster`](https://javadoc.io/doc/com.couchbase.client/java-client/3.11.3/com/couchbase/client/java/Cluster.html) is available, as described above, and a bucket name has been specified: * Properties * YAML ```properties spring.data.couchbase.bucket-name=my-bucket ``` ```yaml spring: data: couchbase: bucket-name: "my-bucket" ``` The following examples shows how to inject a [`CouchbaseTemplate`](https://docs.spring.io/spring-data/couchbase/docs/6.1.x/api/org/springframework/data/couchbase/core/CouchbaseTemplate.html) bean: * Java * Kotlin ```java import org.springframework.data.couchbase.core.CouchbaseTemplate; import org.springframework.stereotype.Component; @Component public class MyBean { private final CouchbaseTemplate template; public MyBean(CouchbaseTemplate template) { this.template = template; } // ... public String someMethod() { return this.template.getBucketName(); } } ``` ```kotlin import org.springframework.data.couchbase.core.CouchbaseTemplate import org.springframework.stereotype.Component @Component class MyBean(private val template: CouchbaseTemplate) { // ... fun someMethod(): String { return template.bucketName } } ``` There are a few beans that you can define in your own configuration to override those provided by the auto-configuration: * A [`CouchbaseMappingContext`](https://docs.spring.io/spring-data/couchbase/docs/6.1.x/api/org/springframework/data/couchbase/core/mapping/CouchbaseMappingContext.html) [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) with a name of `couchbaseMappingContext`. * A [`CustomConversions`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/convert/CustomConversions.html) [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) with a name of `couchbaseCustomConversions`. * A [`CouchbaseTemplate`](https://docs.spring.io/spring-data/couchbase/docs/6.1.x/api/org/springframework/data/couchbase/core/CouchbaseTemplate.html) [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) with a name of `couchbaseTemplate`. To avoid hard-coding those names in your own config, you can reuse [`BeanNames`](https://docs.spring.io/spring-data/couchbase/docs/6.1.x/api/org/springframework/data/couchbase/config/BeanNames.html) provided by Spring Data Couchbase. For instance, you can customize the converters to use, as follows: * Java * Kotlin ```java import org.assertj.core.util.Arrays; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.data.couchbase.config.BeanNames; import org.springframework.data.couchbase.core.convert.CouchbaseCustomConversions; @Configuration(proxyBeanMethods = false) public class MyCouchbaseConfiguration { @Bean(BeanNames.COUCHBASE_CUSTOM_CONVERSIONS) public CouchbaseCustomConversions myCustomConversions() { return new CouchbaseCustomConversions(Arrays.asList(new MyConverter())); } } ``` ```kotlin import org.assertj.core.util.Arrays import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.data.couchbase.config.BeanNames import org.springframework.data.couchbase.core.convert.CouchbaseCustomConversions @Configuration(proxyBeanMethods = false) class MyCouchbaseConfiguration { @Bean(BeanNames.COUCHBASE_CUSTOM_CONVERSIONS) fun myCustomConversions(): CouchbaseCustomConversions { return CouchbaseCustomConversions(Arrays.asList(MyConverter())) } } ``` ## [](#data.nosql.ldap)LDAP [LDAP](https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol) (Lightweight Directory Access Protocol) is an open, vendor-neutral, industry standard application protocol for accessing and maintaining distributed directory information services over an IP network. Spring Boot offers auto-configuration for any compliant LDAP server as well as support for the embedded in-memory LDAP server from [UnboundID](https://ldap.com/unboundid-ldap-sdk-for-java/). LDAP abstractions are provided by [Spring Data LDAP](https://github.com/spring-projects/spring-data-ldap). There is a `spring-boot-starter-data-ldap` starter for collecting the dependencies in a convenient way. ### [](#data.nosql.ldap.connecting)Connecting to an LDAP Server To connect to an LDAP server, make sure you declare a dependency on the `spring-boot-starter-data-ldap` starter or `spring-ldap-core` and then declare the URLs of your server in your application.properties, as shown in the following example: * Properties * YAML ```properties spring.ldap.urls=ldap://myserver:1235 spring.ldap.username=admin spring.ldap.password=secret ``` ```yaml spring: ldap: urls: "ldap://myserver:1235" username: "admin" password: "secret" ``` If you need to customize connection settings, you can use the `spring.ldap.base` and `spring.ldap.base-environment` properties. An [`LdapContextSource`](https://docs.spring.io/spring-ldap/docs/4.1.x/api/org/springframework/ldap/core/support/LdapContextSource.html) is auto-configured based on these settings. If a [`DirContextAuthenticationStrategy`](https://docs.spring.io/spring-ldap/docs/4.1.x/api/org/springframework/ldap/core/support/DirContextAuthenticationStrategy.html) bean is available, it is associated to the auto-configured [`LdapContextSource`](https://docs.spring.io/spring-ldap/docs/4.1.x/api/org/springframework/ldap/core/support/LdapContextSource.html). If you need to customize it, for instance to use a [`PooledContextSource`](https://docs.spring.io/spring-ldap/docs/4.1.x/api/org/springframework/ldap/pool2/factory/PooledContextSource.html), you can still inject the auto-configured [`LdapContextSource`](https://docs.spring.io/spring-ldap/docs/4.1.x/api/org/springframework/ldap/core/support/LdapContextSource.html). Make sure to flag your customized [`ContextSource`](https://docs.spring.io/spring-ldap/docs/4.1.x/api/org/springframework/ldap/core/ContextSource.html) as [`@Primary`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Primary.html) so that the auto-configured [`LdapTemplate`](https://docs.spring.io/spring-ldap/docs/4.1.x/api/org/springframework/ldap/core/LdapTemplate.html) uses it. ### [](#data.nosql.ldap.repositories)Spring Data LDAP Repositories Spring Data includes repository support for LDAP. Repositories and documents are found through scanning. By default, the [auto-configuration packages](../using/auto-configuration.html#using.auto-configuration.packages) are scanned. You can customize the locations to look for repositories and documents by using [`@EnableLdapRepositories`](https://docs.spring.io/spring-data/ldap/docs/4.1.x/api/org/springframework/data/ldap/repository/config/EnableLdapRepositories.html) and [`@EntityScan`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/persistence/autoconfigure/EntityScan.html) respectively. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------- | | ** | For complete details of Spring Data LDAP, see the [reference documentation](https://docs.spring.io/spring-data/ldap/reference/4.1). | You can also inject an auto-configured [`LdapTemplate`](https://docs.spring.io/spring-ldap/docs/4.1.x/api/org/springframework/ldap/core/LdapTemplate.html) instance as you would with any other Spring Bean, as shown in the following example: * Java * Kotlin ```java import java.util.List; import org.springframework.ldap.core.LdapTemplate; import org.springframework.stereotype.Component; @Component public class MyBean { private final LdapTemplate template; public MyBean(LdapTemplate template) { this.template = template; } // ... public List someMethod() { return this.template.findAll(User.class); } } ``` ```kotlin import org.springframework.ldap.core.LdapTemplate import org.springframework.stereotype.Component @Component class MyBean(private val template: LdapTemplate) { // ... fun someMethod(): List { return template.findAll(User::class.java) } } ``` ### [](#data.nosql.ldap.embedded)Embedded In-memory LDAP Server For testing purposes, Spring Boot supports auto-configuration of an in-memory LDAP server from [UnboundID](https://ldap.com/unboundid-ldap-sdk-for-java/). To configure the server, add a dependency to `com.unboundid:unboundid-ldapsdk` and declare a `spring.ldap.embedded.base-dn` property, as follows: * Properties * YAML ```properties spring.ldap.embedded.base-dn=dc=spring,dc=io ``` ```yaml spring: ldap: embedded: base-dn: "dc=spring,dc=io" ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | It is possible to define multiple base-dn values, however, since distinguished names usually contain commas, they must be defined using the correct notation.In yaml files, you can use the yaml list notation. In properties files, you must include the index as part of the property name:- Properties - YAML```properties spring.ldap.embedded.base-dn[0]=dc=spring,dc=io spring.ldap.embedded.base-dn[1]=dc=vmware,dc=com ``````yaml spring.ldap.embedded.base-dn: - "dc=spring,dc=io" - "dc=vmware,dc=com" ``` | By default, the server starts on a random port and triggers the regular LDAP support. There is no need to specify a `spring.ldap.urls` property. If there is a `schema.ldif` file on your classpath, it is used to initialize the server. If you want to load the initialization script from a different resource, you can also use the `spring.ldap.embedded.ldif` property. By default, a standard schema is used to validate `LDIF` files. You can turn off validation altogether by setting the `spring.ldap.embedded.validation.enabled` property. If you have custom attributes, you can use `spring.ldap.embedded.validation.schema` to define your custom attribute types or object classes. #### [](#data.nosql.ldap.embedded.ssl)SSL The in-memory LDAP server supports SSL (LDAPS). To enable SSL, configure the [SSL bundle](../features/ssl.html) to use by setting the `spring.ldap.embedded.ssl.bundle` property, as shown in the following example: * Properties * YAML ```properties spring.ldap.embedded.ssl.bundle=example ``` ```yaml spring: ldap: embedded: ssl: bundle: "example" ``` * [Spring Boot](../../index.html) * [4.1.1](nosql.html) * [4.0.8](../../4.0/reference/data/nosql.html) * [3.5.16](../../3.5/reference/data/nosql.html) * [3.4.13](../../3.4/reference/data/nosql.html) * [3.3.13](../../3.3/reference/data/nosql.html) - [4.2.0-M2](../../4.2/reference/data/nosql.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/data/nosql.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/data/nosql.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/data/nosql.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/security/saml2.html ---- # SAML 2.0 [SAML v2.0](https://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html) is a widely adopted framework for exchanging security information between online business partners. ## [](#security.saml2.build)Build Configuration SAML 2.0 support builds off of the OpenSAML library that [requires an extra repository](https://shibboleth.atlassian.net/wiki/spaces/DEV/pages/1123844333/Use+of+Maven+Central#Publishing-to-Maven-Central) configuration. ### [](#security.saml2.build.maven)Using Maven With Maven, you need to add an extra `repository` element to your POM as follows: ```xml shibboleth-releases Shibboleth Releases Repository https://build.shibboleth.net/maven/releases false ``` ### [](#security.saml2.build.gradle)Using Gradle With Gradle, a repository element should be added to your build script: ```gradle repositories { maven { url "https://build.shibboleth.net/maven/releases" } } ``` ## [](#security.saml2.relying-party)Relying Party If you have `spring-security-saml2-service-provider` on your classpath, you can take advantage of some auto-configuration to set up a SAML 2.0 Relying Party. This configuration makes use of the properties under [`Saml2RelyingPartyProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/security/saml2/autoconfigure/Saml2RelyingPartyProperties.html). A relying party registration represents a paired configuration between an Identity Provider, IDP, and a Service Provider, SP. You can register multiple relying parties under the `spring.security.saml2.relyingparty` prefix, as shown in the following example: * Properties * YAML ```properties spring.security.saml2.relyingparty.registration.my-relying-party1.signing.credentials[0].private-key-location=path-to-private-key spring.security.saml2.relyingparty.registration.my-relying-party1.signing.credentials[0].certificate-location=path-to-certificate spring.security.saml2.relyingparty.registration.my-relying-party1.decryption.credentials[0].private-key-location=path-to-private-key spring.security.saml2.relyingparty.registration.my-relying-party1.decryption.credentials[0].certificate-location=path-to-certificate spring.security.saml2.relyingparty.registration.my-relying-party1.singlelogout.url=https://myapp/logout/saml2/slo spring.security.saml2.relyingparty.registration.my-relying-party1.singlelogout.response-url=https://remoteidp2.slo.url spring.security.saml2.relyingparty.registration.my-relying-party1.singlelogout.binding=POST spring.security.saml2.relyingparty.registration.my-relying-party1.assertingparty.verification.credentials[0].certificate-location=path-to-verification-cert spring.security.saml2.relyingparty.registration.my-relying-party1.assertingparty.entity-id=remote-idp-entity-id1 spring.security.saml2.relyingparty.registration.my-relying-party1.assertingparty.sso-url=https://remoteidp1.sso.url spring.security.saml2.relyingparty.registration.my-relying-party2.signing.credentials[0].private-key-location=path-to-private-key spring.security.saml2.relyingparty.registration.my-relying-party2.signing.credentials[0].certificate-location=path-to-certificate spring.security.saml2.relyingparty.registration.my-relying-party2.decryption.credentials[0].private-key-location=path-to-private-key spring.security.saml2.relyingparty.registration.my-relying-party2.decryption.credentials[0].certificate-location=path-to-certificate spring.security.saml2.relyingparty.registration.my-relying-party2.assertingparty.verification.credentials[0].certificate-location=path-to-other-verification-cert spring.security.saml2.relyingparty.registration.my-relying-party2.assertingparty.entity-id=remote-idp-entity-id2 spring.security.saml2.relyingparty.registration.my-relying-party2.assertingparty.sso-url=https://remoteidp2.sso.url spring.security.saml2.relyingparty.registration.my-relying-party2.assertingparty.singlelogout.url=https://remoteidp2.slo.url spring.security.saml2.relyingparty.registration.my-relying-party2.assertingparty.singlelogout.response-url=https://myapp/logout/saml2/slo spring.security.saml2.relyingparty.registration.my-relying-party2.assertingparty.singlelogout.binding=POST ``` ```yaml spring: security: saml2: relyingparty: registration: my-relying-party1: signing: credentials: - private-key-location: "path-to-private-key" certificate-location: "path-to-certificate" decryption: credentials: - private-key-location: "path-to-private-key" certificate-location: "path-to-certificate" singlelogout: url: "https://myapp/logout/saml2/slo" response-url: "https://remoteidp2.slo.url" binding: "POST" assertingparty: verification: credentials: - certificate-location: "path-to-verification-cert" entity-id: "remote-idp-entity-id1" sso-url: "https://remoteidp1.sso.url" my-relying-party2: signing: credentials: - private-key-location: "path-to-private-key" certificate-location: "path-to-certificate" decryption: credentials: - private-key-location: "path-to-private-key" certificate-location: "path-to-certificate" assertingparty: verification: credentials: - certificate-location: "path-to-other-verification-cert" entity-id: "remote-idp-entity-id2" sso-url: "https://remoteidp2.sso.url" singlelogout: url: "https://remoteidp2.slo.url" response-url: "https://myapp/logout/saml2/slo" binding: "POST" ``` For SAML2 logout, by default, Spring Security’s [`Saml2LogoutRequestFilter`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/saml2/provider/service/web/authentication/logout/Saml2LogoutRequestFilter.html) and [`Saml2LogoutResponseFilter`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/saml2/provider/service/web/authentication/logout/Saml2LogoutResponseFilter.html) only process URLs matching `/logout/saml2/slo`. If you want to customize the `url` to which AP-initiated logout requests get sent to or the `response-url` to which an AP sends logout responses to, to use a different pattern, you need to provide configuration to process that custom pattern. For example, for servlet applications, you can add your own [`SecurityFilterChain`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/SecurityFilterChain.html) that resembles the following: ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.web.SecurityFilterChain; import static org.springframework.security.config.Customizer.withDefaults; @Configuration(proxyBeanMethods = false) public class MySamlRelyingPartyConfiguration { @Bean public SecurityFilterChain securityFilterChain(HttpSecurity http) { http.authorizeHttpRequests((requests) -> requests.anyRequest().authenticated()); http.saml2Login(withDefaults()); http.saml2Logout((saml2) -> { saml2.logoutRequest((request) -> request.logoutUrl("/SLOService.saml2")); saml2.logoutResponse((response) -> response.logoutUrl("/SLOService.saml2")); }); return http.build(); } } ``` * [Spring Boot](../../index.html) * [4.1.1](saml2.html) * [4.0.8](../../4.0/index.html) * [3.5.16](../../3.5/index.html) * [3.4.13](../../3.4/index.html) * [3.3.13](../../3.3/index.html) - [4.2.0-M2](../../4.2/reference/security/saml2.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/security/saml2.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/security/saml2.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/LayeredSpec.ApplicationSpec.html ---- # Class LayeredSpec.ApplicationSpec [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") [org.springframework.boot.gradle.tasks.bundling.LayeredSpec.IntoLayersSpec](LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling")<[LayeredSpec.IntoLayerSpec](LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling")> org.springframework.boot.gradle.tasks.bundling.LayeredSpec.ApplicationSpec * All Implemented Interfaces: `Serializable` - Enclosing class: `LayeredSpec` *** public static class LayeredSpec.ApplicationSpec extends [LayeredSpec.IntoLayersSpec](LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling")<[LayeredSpec.IntoLayerSpec](LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling")> An [`LayeredSpec.IntoLayersSpec`](LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which application classes and resources belong. * Since: 2.3.0 * Author: Madhura Bhave, Scott Frederick, Phillip Webb * See Also: * [Serialized Form](../../../../../../serialized-form.html#org.springframework.boot.gradle.tasks.bundling.LayeredSpec.ApplicationSpec) - ## Constructor Summary Constructors Constructor Description `ApplicationSpec()`   `ApplicationSpec(LayeredSpec.IntoLayerSpec... contents)` Creates a new `ApplicationSpec` with the given `contents`. - ## Method Summary ### Methods inherited from class [LayeredSpec.IntoLayersSpec](LayeredSpec.IntoLayersSpec.html#method-summary "class in org.springframework.boot.gradle.tasks.bundling") `intoLayer, intoLayer` ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### ApplicationSpec @Inject public ApplicationSpec() * ### ApplicationSpec public ApplicationSpec​([LayeredSpec.IntoLayerSpec](LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling")... contents) Creates a new `ApplicationSpec` with the given `contents`. * Parameters: `contents` - specs for the layers in which application content should be included ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/CacheInfo.BindCacheInfo.html ---- # Class CacheInfo.BindCacheInfo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.maven.CacheInfo.BindCacheInfo * Enclosing class: `CacheInfo` *** public static class CacheInfo.BindCacheInfo extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") Encapsulates configuration of an image building cache stored in a bind mount. `BindCacheInfo()`   - ## Method Summary Modifier and Type Method Description `@Nullable String` `getSource()`   ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### BindCacheInfo public BindCacheInfo() * ## Method Details * ### getSource public @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getSource() ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/StartMojo.html ---- # Class StartMojo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.plugin.AbstractMojo [org.springframework.boot.maven.AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") [org.springframework.boot.maven.AbstractRunMojo](AbstractRunMojo.html "class in org.springframework.boot.maven") org.springframework.boot.maven.StartMojo * All Implemented Interfaces: `org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo` *** @Mojo(name="start", requiresProject=true, defaultPhase=PRE\_INTEGRATION\_TEST, requiresDependencyResolution=TEST) public class StartMojo extends [AbstractRunMojo](AbstractRunMojo.html "class in org.springframework.boot.maven") Start a spring application. Contrary to the `run` goal, this does not block and allows other goals to operate on the application. This goal is typically used in integration test scenario where the application is started before a test suite and stopped after. * Since: 1.3.0 * Author: Stephane Nicoll * See Also: * [`StopMojo`](StopMojo.html "class in org.springframework.boot.maven") Constructor Description `StartMojo(org.apache.maven.toolchain.ToolchainManager toolchainManager)`   - ## Method Summary Modifier and Type Method Description ` T` `execute(long wait, int maxAttempts, Callable<@Nullable T> callback)` Execute a task, retrying it on failure. `protected boolean` `isUseTestClasspath()`   `protected org.springframework.boot.maven.RunArguments` `resolveApplicationArguments()` Resolve the application arguments to use. `protected org.springframework.boot.maven.RunArguments` `resolveJvmArguments()` Resolve the JVM arguments to use. `protected void` `run(org.springframework.boot.maven.JavaProcessExecutor processExecutor, File workingDirectory, List args, Map environmentVariables)` Run the application. ### Methods inherited from class [AbstractRunMojo](AbstractRunMojo.html#method-summary "class in org.springframework.boot.maven") `execute, getClassesDirectories, getClassPathUrls, resolveEnvVariables` * ### StartMojo @Inject public StartMojo​(org.apache.maven.toolchain.ToolchainManager toolchainManager) * ## Method Details * ### run protected void run​(org.springframework.boot.maven.JavaProcessExecutor processExecutor, [File](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html "class or interface in java.io") workingDirectory, [List](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html "class or interface in java.util")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> args, [Map](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html "class or interface in java.util")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang"),​[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> environmentVariables) throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException Description copied from class: `AbstractRunMojo` Run the application. * Specified by: `run` in class `AbstractRunMojo` * Parameters: * `processExecutor` - the `JavaProcessExecutor` to use * `workingDirectory` - the working directory of the forked JVM * `args` - the arguments (JVM arguments and application arguments) * `environmentVariables` - the environment variables * Throws: * `org.apache.maven.plugin.MojoExecutionException` - in case of MOJO execution errors * `org.apache.maven.plugin.MojoFailureException` - in case of MOJO failures * ### resolveApplicationArguments protected org.springframework.boot.maven.RunArguments resolveApplicationArguments() Description copied from class: `AbstractRunMojo` Resolve the application arguments to use. * Overrides: `resolveApplicationArguments` in class `AbstractRunMojo` * Returns: a `RunArguments` defining the application arguments * ### resolveJvmArguments protected org.springframework.boot.maven.RunArguments resolveJvmArguments() Description copied from class: `AbstractRunMojo` Resolve the JVM arguments to use. * Overrides: `resolveJvmArguments` in class `AbstractRunMojo` * Returns: a `RunArguments` defining the JVM arguments * ### execute public \ T execute​(long wait, int maxAttempts, [Callable](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Callable.html "class or interface in java.util.concurrent")<@Nullable T> callback) throws [Exception](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html "class or interface in java.lang") Execute a task, retrying it on failure. * Type Parameters: `T` - the result type * Parameters: * `wait` - the wait time * `maxAttempts` - the maximum number of attempts * `callback` - the task to execute (possibly multiple times). The callback should return `null` to indicate that another attempt should be made * Returns: the result * Throws: `Exception` - in case of execution errors * ### isUseTestClasspath protected boolean isUseTestClasspath() * Specified by: `isUseTestClasspath` in class `AbstractRunMojo` ---- url: https://docs.spring.io/spring-boot/reference/packaging/container-images/efficient-images.html ---- # Efficient Container Images It is easily possible to package a Spring Boot uber jar as a Docker image. However, there are various downsides to copying and running the uber jar as-is in the Docker image. There’s always a certain amount of overhead when running an uber jar without unpacking it, and in a containerized environment this can be noticeable. The other issue is that putting your application’s code and all its dependencies in one layer in the Docker image is not optimal. Since you probably recompile your code more often than you upgrade the version of Spring Boot you use, it’s often better to separate things a bit more. If you put jar files in the layer before your application classes, Docker often only needs to change the very bottom layer and can pick others up from its cache. ## [](#packaging.container-images.efficient-images.layering)Layering Docker Images To make it easier to create optimized Docker images, Spring Boot supports adding a layer index file to the jar. It provides a list of layers and the parts of the jar that should be contained within them. The list of layers in the index is ordered based on the order in which the layers should be added to the Docker/OCI image. Out-of-the-box, the following layers are supported: * `dependencies` (for regular released dependencies) * `spring-boot-loader` (for everything under `org/springframework/boot/loader`) * `snapshot-dependencies` (for snapshot dependencies) * `application` (for application classes and resources) The following shows an example of a `layers.idx` file: ```yaml - "dependencies": - BOOT-INF/lib/library1.jar - BOOT-INF/lib/library2.jar - "spring-boot-loader": - org/springframework/boot/loader/launch/JarLauncher.class - ... - "snapshot-dependencies": - BOOT-INF/lib/library3-SNAPSHOT.jar - "application": - META-INF/MANIFEST.MF - BOOT-INF/classes/a/b/C.class ``` This layering is designed to separate code based on how likely it is to change between application builds. Library code is less likely to change between builds, so it is placed in its own layers to allow tooling to re-use the layers from cache. Application code is more likely to change between builds so it is isolated in a separate layer. Spring Boot also supports layering for war files with the help of a `layers.idx`. For Maven, see the [packaging layered jar or war section](../../../maven-plugin/packaging.html#packaging.layers) for more details on adding a layer index to the archive. For Gradle, see the [packaging layered jar or war section](../../../gradle-plugin/packaging.html#packaging-executable.configuring.layered-archives) of the Gradle plugin documentation. * [Spring Boot](../../../index.html) * [4.1.1](efficient-images.html) * [4.0.8](../../../4.0/reference/packaging/container-images/efficient-images.html) * [3.5.16](../../../3.5/reference/packaging/container-images/efficient-images.html) * [3.4.13](../../../3.4/reference/packaging/container-images/efficient-images.html) * [3.3.13](../../../3.3/reference/packaging/container-images/efficient-images.html) - [4.2.0-M2](../../../4.2/reference/packaging/container-images/efficient-images.html) * [4.2.0-SNAPSHOT](../../../4.2-SNAPSHOT/reference/packaging/container-images/efficient-images.html) * [4.1.3-SNAPSHOT](../../../4.1-SNAPSHOT/reference/packaging/container-images/efficient-images.html) * [4.0.10-SNAPSHOT](../../../4.0-SNAPSHOT/reference/packaging/container-images/efficient-images.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/build-image.html ---- # Packaging OCI Images The plugin can create an [OCI image](https://github.com/opencontainers/image-spec) from a jar or war file using [Cloud Native Buildpacks](https://buildpacks.io/) (CNB). Images can be built on the command-line using the `build-image` goal. This makes sure that the package lifecycle has run before the image is created. | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | For security reasons, images build and run as non-root users. See the [CNB specification](https://buildpacks.io/docs/reference/spec/platform-api/#users) for more details. | The easiest way to get started is to invoke `mvn spring-boot:build-image` on a project. It is possible to automate the creation of an image whenever the `package` phase is invoked, as shown in the following example: ```xml org.springframework.boot spring-boot-maven-plugin build-image-no-fork ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Use `build-image-no-fork` when binding the goal to the package lifecycle. This goal is similar to `build-image` but does not fork the lifecycle to make sure `package` has run. In the rest of this section, `build-image` is used to refer to either the `build-image` or `build-image-no-fork` goals. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | While the buildpack runs from an [executable archive](packaging.html), it is not necessary to execute the `repackage` goal first as the executable archive is created automatically if necessary. When the `build-image` repackages the application, it applies the same settings as the `repackage` goal would, that is dependencies can be excluded using one of the exclude options. The `spring-boot-devtools` and `spring-boot-docker-compose` modules are automatically excluded by default (you can control this using the `excludeDevtools` and `excludeDockerCompose` properties). Pay also attention that optional dependencies are not included by default. If you have defined those modules as optional, you also need to set the `includeOptional` property to `true`. | ## [](#build-image.docker-daemon)Docker Daemon The `build-image` goal requires access to a Docker daemon. The goal will inspect local Docker CLI [configuration files](https://docs.docker.com/engine/reference/commandline/cli/#configuration-files) to determine the current [context](https://docs.docker.com/engine/context/working-with-contexts/) and use the context connection information to communicate with a Docker daemon. If the current context can not be determined or the context does not have connection information, then the goal will use a default local connection. This works with [Docker Engine](https://docs.docker.com/install/) on all supported platforms without configuration. Environment variables can be set to configure the `build-image` goal to use an alternative local or remote connection. The following table shows the environment variables and their values: | Environment variable | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | DOCKER\_CONFIG | Location of Docker CLI [configuration files](https://docs.docker.com/engine/reference/commandline/cli/#configuration-files) used to determine the current context (defaults to `$HOME/.docker`) | | DOCKER\_CONTEXT | Name of a [context](https://docs.docker.com/engine/context/working-with-contexts/) that should be used to retrieve host information from Docker CLI configuration files (overrides `DOCKER_HOST`) | | DOCKER\_HOST | URL containing the host and port for the Docker daemon - for example `tcp://192.168.99.100:2376` | | DOCKER\_TLS\_VERIFY | Enable secure HTTPS protocol when set to `1` (optional) | | DOCKER\_CERT\_PATH | Path to certificate and key files for HTTPS (required if `DOCKER_TLS_VERIFY=1`, ignored otherwise) | Docker daemon connection information can also be provided using `docker` parameters in the plugin configuration. The following table summarizes the available parameters: | Parameter | Description | | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `context` | Name of a [context](https://docs.docker.com/engine/context/working-with-contexts/) that should be used to retrieve host information from Docker CLI [configuration files](https://docs.docker.com/engine/reference/commandline/cli/#configuration-files) | | `host` | URL containing the host and port for the Docker daemon - for example `tcp://192.168.99.100:2376` | | `tlsVerify` | Enable secure HTTPS protocol when set to `true` (optional) | | `certPath` | Path to certificate and key files for HTTPS (required if `tlsVerify` is `true`, ignored otherwise) | | `bindHostToBuilder` | When `true`, the value of the `host` property will be provided to the container that is created for the CNB builder (optional) | For more details, see also [examples](#build-image.examples.docker). ## [](#build-image.docker-registry)Docker Registry If the Docker images specified by the `builder` or `runImage` parameters are stored in a private Docker image registry that requires authentication, the authentication credentials can be provided using `docker.builderRegistry` parameters. If the generated Docker image is to be published to a Docker image registry, the authentication credentials can be provided using `docker.publishRegistry` parameters. Parameters are provided for user authentication or identity token authentication. Consult the documentation for the Docker registry being used to store images for further information on supported authentication methods. The following table summarizes the available parameters for `docker.builderRegistry` and `docker.publishRegistry`: | Parameter | Description | | ---------- | ------------------------------------------------------------------------------------- | | `username` | Username for the Docker image registry user. Required for user authentication. | | `password` | Password for the Docker image registry user. Required for user authentication. | | `url` | Address of the Docker image registry. Optional for user authentication. | | `email` | E-mail address for the Docker image registry user. Optional for user authentication. | | `token` | Identity token for the Docker image registry user. Required for token authentication. | For more details, see also [examples](#build-image.examples.docker). | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If credentials are not provided, the plugin reads the user’s existing Docker configuration file (typically located at `$HOME/.docker/config.json`) to determine authentication methods. Using these methods, the plugin attempts to provide authentication credentials for the requested image.The plugin supports the following authentication methods:- **Credential Helpers**: External tools configured in the Docker configuration file to provide credentials for specific registries. For example, tools like `osxkeychain` or `ecr-login` handle authentication for certain registries. - **Credential Store**: A default fallback mechanism that securely stores and retrieves credentials (e.g., `desktop` for Docker Desktop). - **Static Credentials**: Credentials that are stored directly in the Docker configuration file under the `auths` section. | ## [](#build-image.customization)Image Customizations The plugin invokes a [builder](https://buildpacks.io/docs/for-app-developers/concepts/builder/) to orchestrate the generation of an image. The builder includes multiple [buildpacks](https://buildpacks.io/docs/for-app-developers/concepts/buildpack/) that can inspect the application to influence the generated image. By default, the plugin chooses a builder image. The name of the generated image is deduced from project properties. The `image` parameter allows configuration of the builder and how it should operate on the project. The following table summarizes the available parameters and their default values: | Parameter / (User Property) | Description | Default value | | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `builder` (`spring-boot.build-image.builder`) | Name of the builder image to use. | `paketobuildpacks/builder-noble-java-tiny:latest` | | `trustBuilder` (`spring-boot.build-image.trustBuilder`) | Whether to treat the builder as [trusted](https://buildpacks.io/docs/for-platform-operators/how-to/integrate-ci/pack/concepts/trusted_builders/#what-is-a-trusted-builder). | `true` if the builder is one of `paketobuildpacks/builder-noble-java-tiny`, `paketobuildpacks/builder-jammy-java-tiny`, `paketobuildpacks/builder-jammy-tiny`, `paketobuildpacks/builder-jammy-base`, `paketobuildpacks/builder-jammy-full`, `paketobuildpacks/builder-jammy-buildpackless-tiny`, `paketobuildpacks/builder-jammy-buildpackless-base`, `paketobuildpacks/builder-jammy-buildpackless-full`, `gcr.io/buildpacks/builder`, `heroku/builder`; `false` otherwise. | | `imagePlatform` (`spring-boot.build-image.imagePlatform`) | The platform (operating system and architecture) of any builder, run, and buildpack images that are pulled. Must be in the form of `OS[/architecture[/variant]]`, such as `linux/amd64`, `linux/arm64`, or `linux/arm/v5`. Refer to documentation of the builder being used to determine the image OS and architecture options available. | No default value, indicating that the platform of the host machine should be used. | | `runImage` (`spring-boot.build-image.runImage`) | Name of the run image to use. | No default value, indicating the run image specified in Builder metadata should be used. | | `name` (`spring-boot.build-image.imageName`) | [Image name](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/buildpack/platform/docker/type/ImageName.html#of\(java.lang.String\)) for the generated image. | `docker.io/library/` `${project.artifactId}:${project.version}` | | `pullPolicy` (`spring-boot.build-image.pullPolicy`) | [Policy](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/buildpack/platform/build/PullPolicy.html) used to determine when to pull the builder and run images from the registry. Acceptable values are `ALWAYS`, `NEVER`, and `IF_NOT_PRESENT`. | `ALWAYS` | | `env` | Environment variables that should be passed to the builder. | | | `buildpacks` | Buildpacks that the builder should use when building the image. Only the specified buildpacks will be used, overriding the default buildpacks included in the builder. Buildpack references must be in one of the following forms:- Buildpack in the builder - `[urn:cnb:builder:][@]` - Buildpack in a directory on the file system - `[file://]` - Buildpack in a gzipped tar (.tgz) file on the file system - `[file://]/` - Buildpack in an OCI image - `[docker://]/[:][@]` | None, indicating the builder should use the buildpacks included in it. | | `bindings` | [Volume bind mounts](https://docs.docker.com/storage/bind-mounts/) that should be mounted to the builder container when building the image. The bindings will be passed unparsed and unvalidated to Docker when creating the builder container. Bindings must be in one of the following forms:- `:[:]` - `:[:]`Where `` can contain:- `ro` to mount the volume as read-only in the container - `rw` to mount the volume as readable and writable in the container - `volume-opt=key=value` to specify key-value pairs consisting of an option name and its value | | | `network` + (`spring-boot.build-image.network`) | The [network driver](https://docs.docker.com/network/#network-drivers) the builder container will be configured to use. The value supplied will be passed unvalidated to Docker when creating the builder container. | | | `cleanCache` + (`spring-boot.build-image.cleanCache`) | Whether to clean the cache before building. | `false` | | `verboseLogging` | Enables verbose logging of builder operations. | `false` | | `publish` + (`spring-boot.build-image.publish`) | Whether to publish the generated image to a Docker registry. | `false` | | `tags` | One or more additional tags to apply to the generated image. The values provided to the `tags` option should be **full** image references. See [the tags section](#build-image.customization.tags) for more details. | | | `buildWorkspace` | A temporary workspace that will be used by the builder and buildpacks to store files during image building. The value can be a named volume or a bind mount location. | A named volume in the Docker daemon, with a name derived from the image name. | | `buildCache` | A cache containing layers created by buildpacks and used by the image building process. The value can be a named volume or a bind mount location. | A named volume in the Docker daemon, with a name derived from the image name. | | `launchCache` | A cache containing layers created by buildpacks and used by the image launching process. The value can be a named volume or a bind mount location. | A named volume in the Docker daemon, with a name derived from the image name. | | `createdDate` (`spring-boot.build-image.createdDate`) | A date that will be used to set the `Created` field in the generated image’s metadata. The value must be a string in the ISO 8601 instant format, or `now` to use the current date and time. | A fixed date that enables [build reproducibility](https://buildpacks.io/docs/for-app-developers/concepts/reproducibility/). | | `applicationDirectory` (`spring-boot.build-image.applicationDirectory`) | The path to a directory that application contents will be uploaded to in the builder image. Application contents will also be in this location in the generated image. | `/workspace` | | `securityOptions` | [Security options](https://docs.docker.com/reference/cli/docker/container/run/#security-opt) that will be applied to the builder container, provided as an array of string values | `["label=disable"]` on Linux and macOS, `[]` on Windows | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The plugin detects the target Java compatibility of the project using the compiler’s plugin configuration or the `maven.compiler.target` property. When using the default Paketo builder and buildpacks, the plugin instructs the buildpacks to install the same Java version. You can override this behaviour as shown in the [builder configuration](#build-image.examples.builder-configuration) examples. | For more details, see also [examples](#build-image.examples). ## [](#build-image.build-image-goal)`spring-boot:build-image` `org.springframework.boot:spring-boot-maven-plugin:4.1.1` Package an application into an OCI image using a buildpack, forking the lifecycle to make sure that `package` ran. This goal is suitable for command-line invocation. If you need to configure a goal `execution` in your build, use `build-image-no-fork` instead. ### [](#build-image.build-image-goal.required-parameters)Required parameters | Name | Type | Default | | ----------------------------------------------------------------------------------- | ------ | ---------------------------- | | [sourceDirectory](#build-image.build-image-goal.parameter-details.source-directory) | `File` | `${project.build.directory}` | ### [](#build-image.build-image-goal.optional-parameters)Optional parameters | Name | Type | Default | | ---------------------------------------------------------------------------------------------- | --------------- | ------- | | [applicationDirectory](#build-image.build-image-goal.parameter-details.application-directory) | `String` | | | [classifier](#build-image.build-image-goal.parameter-details.classifier) | `String` | | | [cleanCache](#build-image.build-image-goal.parameter-details.clean-cache) | `Boolean` | | | [createdDate](#build-image.build-image-goal.parameter-details.created-date) | `String` | | | [docker](#build-image.build-image-goal.parameter-details.docker) | `Docker` | | | [excludeDevtools](#build-image.build-image-goal.parameter-details.exclude-devtools) | `boolean` | `true` | | [excludeDockerCompose](#build-image.build-image-goal.parameter-details.exclude-docker-compose) | `boolean` | `true` | | [excludeGroupIds](#build-image.build-image-goal.parameter-details.exclude-group-ids) | `String` | | | [excludes](#build-image.build-image-goal.parameter-details.excludes) | `List` | | | [image](#build-image.build-image-goal.parameter-details.image) | `Image` | | | [imageBuilder](#build-image.build-image-goal.parameter-details.image-builder) | `String` | | | [imageName](#build-image.build-image-goal.parameter-details.image-name) | `String` | | | [imagePlatform](#build-image.build-image-goal.parameter-details.image-platform) | `String` | | | [includeOptional](#build-image.build-image-goal.parameter-details.include-optional) | `boolean` | `false` | | [includeSystemScope](#build-image.build-image-goal.parameter-details.include-system-scope) | `boolean` | `false` | | [includeTools](#build-image.build-image-goal.parameter-details.include-tools) | `boolean` | `true` | | [includes](#build-image.build-image-goal.parameter-details.includes) | `List` | | | [layers](#build-image.build-image-goal.parameter-details.layers) | `Layers` | | | [layout](#build-image.build-image-goal.parameter-details.layout) | `LayoutType` | | | [layoutFactory](#build-image.build-image-goal.parameter-details.layout-factory) | `LayoutFactory` | | | [mainClass](#build-image.build-image-goal.parameter-details.main-class) | `String` | | | [network](#build-image.build-image-goal.parameter-details.network) | `String` | | | [publish](#build-image.build-image-goal.parameter-details.publish) | `Boolean` | | | [pullPolicy](#build-image.build-image-goal.parameter-details.pull-policy) | `PullPolicy` | | | [runImage](#build-image.build-image-goal.parameter-details.run-image) | `String` | | | [skip](#build-image.build-image-goal.parameter-details.skip) | `boolean` | `false` | | [trustBuilder](#build-image.build-image-goal.parameter-details.trust-builder) | `Boolean` | | ### [](#build-image.build-image-goal.parameter-details)Parameter details #### [](#build-image.build-image-goal.parameter-details.application-directory)`applicationDirectory` Alias for `Image#applicationDirectory` to support configuration through command-line property. | Name | `applicationDirectory` | | ------------- | ---------------------------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.build-image.applicationDirectory` | | Since | `3.1.0` | #### [](#build-image.build-image-goal.parameter-details.classifier)`classifier` Classifier used when finding the source archive. | Name | `classifier` | | ------------- | ------------------ | | Type | `java.lang.String` | | Default value | | | User property | | | Since | `2.3.0` | #### [](#build-image.build-image-goal.parameter-details.clean-cache)`cleanCache` Alias for `Image#cleanCache` to support configuration through command-line property. | Name | `cleanCache` | | ------------- | ------------------------------------ | | Type | `java.lang.Boolean` | | Default value | | | User property | `spring-boot.build-image.cleanCache` | | Since | `2.4.0` | #### [](#build-image.build-image-goal.parameter-details.created-date)`createdDate` Alias for `Image#createdDate` to support configuration through command-line property. | Name | `createdDate` | | ------------- | ------------------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.build-image.createdDate` | | Since | `3.1.0` | #### [](#build-image.build-image-goal.parameter-details.docker)`docker` Docker configuration options. | Name | `docker` | | ------------- | --------------------------------------- | | Type | `org.springframework.boot.maven.Docker` | | Default value | | | User property | | | Since | `2.4.0` | #### [](#build-image.build-image-goal.parameter-details.exclude-devtools)`excludeDevtools` Exclude Spring Boot devtools from the repackaged archive. | Name | `excludeDevtools` | | ------------- | --------------------------------------- | | Type | `boolean` | | Default value | `true` | | User property | `spring-boot.repackage.excludeDevtools` | | Since | `1.3.0` | #### [](#build-image.build-image-goal.parameter-details.exclude-docker-compose)`excludeDockerCompose` Exclude Spring Boot dev services from the repackaged archive. | Name | `excludeDockerCompose` | | ------------- | -------------------------------------------- | | Type | `boolean` | | Default value | `true` | | User property | `spring-boot.repackage.excludeDockerCompose` | | Since | `3.1.0` | #### [](#build-image.build-image-goal.parameter-details.exclude-group-ids)`excludeGroupIds` Comma separated list of groupId names to exclude (exact match). | Name | `excludeGroupIds` | | ------------- | ----------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.excludeGroupIds` | | Since | `1.1.0` | #### [](#build-image.build-image-goal.parameter-details.excludes)`excludes` Collection of artifact definitions to exclude. The `Exclude` element defines mandatory `groupId` and `artifactId` components and an optional `classifier` component. When configured as a property, values should be comma-separated with colon-separated components: `groupId:artifactId,groupId:artifactId:classifier` | Name | `excludes` | | ------------- | ---------------------- | | Type | `java.util.List` | | Default value | | | User property | `spring-boot.excludes` | | Since | `1.1.0` | #### [](#build-image.build-image-goal.parameter-details.image)`image` Image configuration, with `builder`, `runImage`, `name`, `env`, `cleanCache`, `verboseLogging`, `pullPolicy`, and `publish` options. | Name | `image` | | ------------- | -------------------------------------- | | Type | `org.springframework.boot.maven.Image` | | Default value | | | User property | | | Since | `2.3.0` | #### [](#build-image.build-image-goal.parameter-details.image-builder)`imageBuilder` Alias for `Image#builder` to support configuration through command-line property. | Name | `imageBuilder` | | ------------- | --------------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.build-image.builder` | | Since | `2.3.0` | #### [](#build-image.build-image-goal.parameter-details.image-name)`imageName` Alias for `Image#name` to support configuration through command-line property. | Name | `imageName` | | ------------- | ----------------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.build-image.imageName` | | Since | `2.3.0` | #### [](#build-image.build-image-goal.parameter-details.image-platform)`imagePlatform` Alias for `Image#imagePlatform` to support configuration through command-line property. | Name | `imagePlatform` | | ------------- | --------------------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.build-image.imagePlatform` | | Since | `3.4.0` | #### [](#build-image.build-image-goal.parameter-details.include-optional)`includeOptional` Include optional dependencies. | Name | `includeOptional` | | ------------- | ----------------- | | Type | `boolean` | | Default value | `false` | | User property | | | Since | `3.5.7` | #### [](#build-image.build-image-goal.parameter-details.include-system-scope)`includeSystemScope` Include system scoped dependencies. | Name | `includeSystemScope` | | ------------- | -------------------- | | Type | `boolean` | | Default value | `false` | | User property | | | Since | `1.4.0` | #### [](#build-image.build-image-goal.parameter-details.include-tools)`includeTools` Include JAR tools. | Name | `includeTools` | | ------------- | -------------- | | Type | `boolean` | | Default value | `true` | | User property | | | Since | `3.3.0` | #### [](#build-image.build-image-goal.parameter-details.includes)`includes` Collection of artifact definitions to include. The `Include` element defines mandatory `groupId` and `artifactId` components and an optional `classifier` component. When configured as a property, values should be comma-separated with colon-separated components: `groupId:artifactId,groupId:artifactId:classifier` | Name | `includes` | | ------------- | ---------------------- | | Type | `java.util.List` | | Default value | | | User property | `spring-boot.includes` | | Since | `1.2.0` | #### [](#build-image.build-image-goal.parameter-details.layers)`layers` Layer configuration with options to disable layer creation, exclude layer tools jar, and provide a custom layers configuration file. | Name | `layers` | | ------------- | --------------------------------------- | | Type | `org.springframework.boot.maven.Layers` | | Default value | | | User property | | | Since | `2.3.0` | #### [](#build-image.build-image-goal.parameter-details.layout)`layout` The type of archive (which corresponds to how the dependencies are laid out inside it). Possible values are `JAR`, `WAR`, `ZIP`, `DIR`, `NONE`. Defaults to a guess based on the archive type. | Name | `layout` | | ------------- | ---------------------------------------------------------------- | | Type | `org.springframework.boot.maven.AbstractPackagerMojo$LayoutType` | | Default value | | | User property | | | Since | `2.3.11` | #### [](#build-image.build-image-goal.parameter-details.layout-factory)`layoutFactory` The layout factory that will be used to create the executable archive if no explicit layout is set. Alternative layouts implementations can be provided by 3rd parties. | Name | `layoutFactory` | | ------------- | ----------------------------------------------------- | | Type | `org.springframework.boot.loader.tools.LayoutFactory` | | Default value | | | User property | | | Since | `2.3.11` | #### [](#build-image.build-image-goal.parameter-details.main-class)`mainClass` The name of the main class. If not specified the first compiled class found that contains a `main` method will be used. | Name | `mainClass` | | ------------- | ------------------ | | Type | `java.lang.String` | | Default value | | | User property | | | Since | `1.0.0` | #### [](#build-image.build-image-goal.parameter-details.network)`network` Alias for `Image#network` to support configuration through command-line property. | Name | `network` | | ------------- | --------------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.build-image.network` | | Since | `2.6.0` | #### [](#build-image.build-image-goal.parameter-details.publish)`publish` Alias for `Image#publish` to support configuration through command-line property. | Name | `publish` | | ------------- | --------------------------------- | | Type | `java.lang.Boolean` | | Default value | | | User property | `spring-boot.build-image.publish` | | Since | | #### [](#build-image.build-image-goal.parameter-details.pull-policy)`pullPolicy` Alias for `Image#pullPolicy` to support configuration through command-line property. | Name | `pullPolicy` | | ------------- | -------------------------------------------------------------- | | Type | `org.springframework.boot.buildpack.platform.build.PullPolicy` | | Default value | | | User property | `spring-boot.build-image.pullPolicy` | | Since | | #### [](#build-image.build-image-goal.parameter-details.run-image)`runImage` Alias for `Image#runImage` to support configuration through command-line property. | Name | `runImage` | | ------------- | ---------------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.build-image.runImage` | | Since | `2.3.1` | #### [](#build-image.build-image-goal.parameter-details.skip)`skip` Skip the execution. | Name | `skip` | | ------------- | ------------------------------ | | Type | `boolean` | | Default value | `false` | | User property | `spring-boot.build-image.skip` | | Since | `2.3.0` | #### [](#build-image.build-image-goal.parameter-details.source-directory)`sourceDirectory` Directory containing the source archive. | Name | `sourceDirectory` | | ------------- | ---------------------------- | | Type | `java.io.File` | | Default value | `${project.build.directory}` | | User property | | | Since | `2.3.0` | #### [](#build-image.build-image-goal.parameter-details.trust-builder)`trustBuilder` Alias for `Image#trustBuilder` to support configuration through command-line property. | Name | `trustBuilder` | | ------------- | -------------------------------------- | | Type | `java.lang.Boolean` | | Default value | | | User property | `spring-boot.build-image.trustBuilder` | | Since | | ## [](#build-image.build-image-no-fork-goal)`spring-boot:build-image-no-fork` `org.springframework.boot:spring-boot-maven-plugin:4.1.1` Package an application into an OCI image using a buildpack, but without forking the lifecycle. This goal should be used when configuring a goal `execution` in your build. To invoke the goal on the command-line, use `build-image` instead. ### [](#build-image.build-image-no-fork-goal.required-parameters)Required parameters | Name | Type | Default | | ------------------------------------------------------------------------------------------- | ------ | ---------------------------- | | [sourceDirectory](#build-image.build-image-no-fork-goal.parameter-details.source-directory) | `File` | `${project.build.directory}` | ### [](#build-image.build-image-no-fork-goal.optional-parameters)Optional parameters | Name | Type | Default | | ------------------------------------------------------------------------------------------------------ | --------------- | ------- | | [applicationDirectory](#build-image.build-image-no-fork-goal.parameter-details.application-directory) | `String` | | | [classifier](#build-image.build-image-no-fork-goal.parameter-details.classifier) | `String` | | | [cleanCache](#build-image.build-image-no-fork-goal.parameter-details.clean-cache) | `Boolean` | | | [createdDate](#build-image.build-image-no-fork-goal.parameter-details.created-date) | `String` | | | [docker](#build-image.build-image-no-fork-goal.parameter-details.docker) | `Docker` | | | [excludeDevtools](#build-image.build-image-no-fork-goal.parameter-details.exclude-devtools) | `boolean` | `true` | | [excludeDockerCompose](#build-image.build-image-no-fork-goal.parameter-details.exclude-docker-compose) | `boolean` | `true` | | [excludeGroupIds](#build-image.build-image-no-fork-goal.parameter-details.exclude-group-ids) | `String` | | | [excludes](#build-image.build-image-no-fork-goal.parameter-details.excludes) | `List` | | | [image](#build-image.build-image-no-fork-goal.parameter-details.image) | `Image` | | | [imageBuilder](#build-image.build-image-no-fork-goal.parameter-details.image-builder) | `String` | | | [imageName](#build-image.build-image-no-fork-goal.parameter-details.image-name) | `String` | | | [imagePlatform](#build-image.build-image-no-fork-goal.parameter-details.image-platform) | `String` | | | [includeOptional](#build-image.build-image-no-fork-goal.parameter-details.include-optional) | `boolean` | `false` | | [includeSystemScope](#build-image.build-image-no-fork-goal.parameter-details.include-system-scope) | `boolean` | `false` | | [includeTools](#build-image.build-image-no-fork-goal.parameter-details.include-tools) | `boolean` | `true` | | [includes](#build-image.build-image-no-fork-goal.parameter-details.includes) | `List` | | | [layers](#build-image.build-image-no-fork-goal.parameter-details.layers) | `Layers` | | | [layout](#build-image.build-image-no-fork-goal.parameter-details.layout) | `LayoutType` | | | [layoutFactory](#build-image.build-image-no-fork-goal.parameter-details.layout-factory) | `LayoutFactory` | | | [mainClass](#build-image.build-image-no-fork-goal.parameter-details.main-class) | `String` | | | [network](#build-image.build-image-no-fork-goal.parameter-details.network) | `String` | | | [publish](#build-image.build-image-no-fork-goal.parameter-details.publish) | `Boolean` | | | [pullPolicy](#build-image.build-image-no-fork-goal.parameter-details.pull-policy) | `PullPolicy` | | | [runImage](#build-image.build-image-no-fork-goal.parameter-details.run-image) | `String` | | | [skip](#build-image.build-image-no-fork-goal.parameter-details.skip) | `boolean` | `false` | | [trustBuilder](#build-image.build-image-no-fork-goal.parameter-details.trust-builder) | `Boolean` | | ### [](#build-image.build-image-no-fork-goal.parameter-details)Parameter details #### [](#build-image.build-image-no-fork-goal.parameter-details.application-directory)`applicationDirectory` Alias for `Image#applicationDirectory` to support configuration through command-line property. | Name | `applicationDirectory` | | ------------- | ---------------------------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.build-image.applicationDirectory` | | Since | `3.1.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.classifier)`classifier` Classifier used when finding the source archive. | Name | `classifier` | | ------------- | ------------------ | | Type | `java.lang.String` | | Default value | | | User property | | | Since | `2.3.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.clean-cache)`cleanCache` Alias for `Image#cleanCache` to support configuration through command-line property. | Name | `cleanCache` | | ------------- | ------------------------------------ | | Type | `java.lang.Boolean` | | Default value | | | User property | `spring-boot.build-image.cleanCache` | | Since | `2.4.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.created-date)`createdDate` Alias for `Image#createdDate` to support configuration through command-line property. | Name | `createdDate` | | ------------- | ------------------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.build-image.createdDate` | | Since | `3.1.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.docker)`docker` Docker configuration options. | Name | `docker` | | ------------- | --------------------------------------- | | Type | `org.springframework.boot.maven.Docker` | | Default value | | | User property | | | Since | `2.4.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.exclude-devtools)`excludeDevtools` Exclude Spring Boot devtools from the repackaged archive. | Name | `excludeDevtools` | | ------------- | --------------------------------------- | | Type | `boolean` | | Default value | `true` | | User property | `spring-boot.repackage.excludeDevtools` | | Since | `1.3.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.exclude-docker-compose)`excludeDockerCompose` Exclude Spring Boot dev services from the repackaged archive. | Name | `excludeDockerCompose` | | ------------- | -------------------------------------------- | | Type | `boolean` | | Default value | `true` | | User property | `spring-boot.repackage.excludeDockerCompose` | | Since | `3.1.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.exclude-group-ids)`excludeGroupIds` Comma separated list of groupId names to exclude (exact match). | Name | `excludeGroupIds` | | ------------- | ----------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.excludeGroupIds` | | Since | `1.1.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.excludes)`excludes` Collection of artifact definitions to exclude. The `Exclude` element defines mandatory `groupId` and `artifactId` components and an optional `classifier` component. When configured as a property, values should be comma-separated with colon-separated components: `groupId:artifactId,groupId:artifactId:classifier` | Name | `excludes` | | ------------- | ---------------------- | | Type | `java.util.List` | | Default value | | | User property | `spring-boot.excludes` | | Since | `1.1.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.image)`image` Image configuration, with `builder`, `runImage`, `name`, `env`, `cleanCache`, `verboseLogging`, `pullPolicy`, and `publish` options. | Name | `image` | | ------------- | -------------------------------------- | | Type | `org.springframework.boot.maven.Image` | | Default value | | | User property | | | Since | `2.3.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.image-builder)`imageBuilder` Alias for `Image#builder` to support configuration through command-line property. | Name | `imageBuilder` | | ------------- | --------------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.build-image.builder` | | Since | `2.3.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.image-name)`imageName` Alias for `Image#name` to support configuration through command-line property. | Name | `imageName` | | ------------- | ----------------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.build-image.imageName` | | Since | `2.3.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.image-platform)`imagePlatform` Alias for `Image#imagePlatform` to support configuration through command-line property. | Name | `imagePlatform` | | ------------- | --------------------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.build-image.imagePlatform` | | Since | `3.4.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.include-optional)`includeOptional` Include optional dependencies. | Name | `includeOptional` | | ------------- | ----------------- | | Type | `boolean` | | Default value | `false` | | User property | | | Since | `3.5.7` | #### [](#build-image.build-image-no-fork-goal.parameter-details.include-system-scope)`includeSystemScope` Include system scoped dependencies. | Name | `includeSystemScope` | | ------------- | -------------------- | | Type | `boolean` | | Default value | `false` | | User property | | | Since | `1.4.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.include-tools)`includeTools` Include JAR tools. | Name | `includeTools` | | ------------- | -------------- | | Type | `boolean` | | Default value | `true` | | User property | | | Since | `3.3.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.includes)`includes` Collection of artifact definitions to include. The `Include` element defines mandatory `groupId` and `artifactId` components and an optional `classifier` component. When configured as a property, values should be comma-separated with colon-separated components: `groupId:artifactId,groupId:artifactId:classifier` | Name | `includes` | | ------------- | ---------------------- | | Type | `java.util.List` | | Default value | | | User property | `spring-boot.includes` | | Since | `1.2.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.layers)`layers` Layer configuration with options to disable layer creation, exclude layer tools jar, and provide a custom layers configuration file. | Name | `layers` | | ------------- | --------------------------------------- | | Type | `org.springframework.boot.maven.Layers` | | Default value | | | User property | | | Since | `2.3.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.layout)`layout` The type of archive (which corresponds to how the dependencies are laid out inside it). Possible values are `JAR`, `WAR`, `ZIP`, `DIR`, `NONE`. Defaults to a guess based on the archive type. | Name | `layout` | | ------------- | ---------------------------------------------------------------- | | Type | `org.springframework.boot.maven.AbstractPackagerMojo$LayoutType` | | Default value | | | User property | | | Since | `2.3.11` | #### [](#build-image.build-image-no-fork-goal.parameter-details.layout-factory)`layoutFactory` The layout factory that will be used to create the executable archive if no explicit layout is set. Alternative layouts implementations can be provided by 3rd parties. | Name | `layoutFactory` | | ------------- | ----------------------------------------------------- | | Type | `org.springframework.boot.loader.tools.LayoutFactory` | | Default value | | | User property | | | Since | `2.3.11` | #### [](#build-image.build-image-no-fork-goal.parameter-details.main-class)`mainClass` The name of the main class. If not specified the first compiled class found that contains a `main` method will be used. | Name | `mainClass` | | ------------- | ------------------ | | Type | `java.lang.String` | | Default value | | | User property | | | Since | `1.0.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.network)`network` Alias for `Image#network` to support configuration through command-line property. | Name | `network` | | ------------- | --------------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.build-image.network` | | Since | `2.6.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.publish)`publish` Alias for `Image#publish` to support configuration through command-line property. | Name | `publish` | | ------------- | --------------------------------- | | Type | `java.lang.Boolean` | | Default value | | | User property | `spring-boot.build-image.publish` | | Since | | #### [](#build-image.build-image-no-fork-goal.parameter-details.pull-policy)`pullPolicy` Alias for `Image#pullPolicy` to support configuration through command-line property. | Name | `pullPolicy` | | ------------- | -------------------------------------------------------------- | | Type | `org.springframework.boot.buildpack.platform.build.PullPolicy` | | Default value | | | User property | `spring-boot.build-image.pullPolicy` | | Since | | #### [](#build-image.build-image-no-fork-goal.parameter-details.run-image)`runImage` Alias for `Image#runImage` to support configuration through command-line property. | Name | `runImage` | | ------------- | ---------------------------------- | | Type | `java.lang.String` | | Default value | | | User property | `spring-boot.build-image.runImage` | | Since | `2.3.1` | #### [](#build-image.build-image-no-fork-goal.parameter-details.skip)`skip` Skip the execution. | Name | `skip` | | ------------- | ------------------------------ | | Type | `boolean` | | Default value | `false` | | User property | `spring-boot.build-image.skip` | | Since | `2.3.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.source-directory)`sourceDirectory` Directory containing the source archive. | Name | `sourceDirectory` | | ------------- | ---------------------------- | | Type | `java.io.File` | | Default value | `${project.build.directory}` | | User property | | | Since | `2.3.0` | #### [](#build-image.build-image-no-fork-goal.parameter-details.trust-builder)`trustBuilder` Alias for `Image#trustBuilder` to support configuration through command-line property. | Name | `trustBuilder` | | ------------- | -------------------------------------- | | Type | `java.lang.Boolean` | | Default value | | | User property | `spring-boot.build-image.trustBuilder` | | Since | | ## [](#build-image.examples)Examples ### [](#build-image.examples.custom-image-builder)Custom Image Builder If you need to customize the builder used to create the image or the run image used to launch the built image, configure the plugin as shown in the following example: ```xml org.springframework.boot spring-boot-maven-plugin mine/java-cnb-builder mine/java-cnb-run ``` This configuration will use a builder image with the name `mine/java-cnb-builder` and the tag `latest`, and the run image named `mine/java-cnb-run` and the tag `latest`. The builder and run image can be specified on the command line as well, as shown in this example: ```shell $ mvn spring-boot:build-image -Dspring-boot.build-image.builder=mine/java-cnb-builder -Dspring-boot.build-image.runImage=mine/java-cnb-run ``` ### [](#build-image.examples.builder-configuration)Builder Configuration If the builder exposes configuration options using environment variables, those can be set using the `env` attributes. The following is an example of [configuring the JVM version](https://paketo.io/docs/buildpacks/language-family-buildpacks/java/#configuring-the-jvm-version) used by the Paketo Java buildpacks at build time: ```xml org.springframework.boot spring-boot-maven-plugin 17 ``` If there is a network proxy between the Docker daemon the builder runs in and network locations that buildpacks download artifacts from, you will need to configure the builder to use the proxy. When using the Paketo builder, this can be accomplished by setting the `HTTPS_PROXY` and/or `HTTP_PROXY` environment variables as show in the following example: ```xml org.springframework.boot spring-boot-maven-plugin http://proxy.example.com https://proxy.example.com ``` ### [](#build-image.examples.runtime-jvm-configuration)Runtime JVM Configuration Paketo Java buildpacks [configure the JVM runtime environment](https://paketo.io/docs/buildpacks/language-family-buildpacks/java/#runtime-jvm-configuration) by setting the `JAVA_TOOL_OPTIONS` environment variable. The buildpack-provided `JAVA_TOOL_OPTIONS` value can be modified to customize JVM runtime behavior when the application image is launched in a container. Environment variable modifications that should be stored in the image and applied to every deployment can be set as described in the [Paketo documentation](https://paketo.io/docs/buildpacks/configuration/#environment-variables) and shown in the following example: ```xml org.springframework.boot spring-boot-maven-plugin -XX:+HeapDumpOnOutOfMemoryError ``` ### [](#build-image.examples.custom-image-name)Custom Image Name By default, the image name is inferred from the `artifactId` and the `version` of the project, something like `docker.io/library/${project.artifactId}:${project.version}`. You can take control over the name, as shown in the following example: ```xml org.springframework.boot spring-boot-maven-plugin example.com/library/${project.artifactId} ``` | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | This configuration does not provide an explicit tag so `latest` is used. It is possible to specify a tag as well, either using `${project.version}`, any property available in the build or a hardcoded version. | The image name can be specified on the command line as well, as shown in this example: ```shell $ mvn spring-boot:build-image -Dspring-boot.build-image.imageName=example.com/library/my-app:v1 ``` ### [](#build-image.examples.buildpacks)Buildpacks By default, the builder will use buildpacks included in the builder image and apply them in a pre-defined order. An alternative set of buildpacks can be provided to apply buildpacks that are not included in the builder, or to change the order of included buildpacks. When one or more buildpacks are provided, only the specified buildpacks will be applied. The following example instructs the builder to use a custom buildpack packaged in a `.tgz` file, followed by a buildpack included in the builder. ```xml org.springframework.boot spring-boot-maven-plugin file:///path/to/example-buildpack.tgz urn:cnb:builder:paketo-buildpacks/java ``` If the Docker registry requires authentication, the credentials can be configured using `docker.publishRegistry` parameters. If the Docker registry does not require authentication, the `docker.publishRegistry` configuration can be omitted. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The registry that the image will be published to is determined by the registry part of the image name (`docker.example.com` in these examples). If `docker.publishRegistry` credentials are configured and include a `url` parameter, this value is passed to the registry but is not used to determine the publishing registry location. | ```xml org.springframework.boot spring-boot-maven-plugin docker.example.com/library/${project.artifactId} true user secret ``` The `publish` option can be specified on the command line as well, as shown in this example: ```shell $ mvn spring-boot:build-image -Dspring-boot.build-image.imageName=docker.example.com/library/my-app:v1 -Dspring-boot.build-image.publish=true ``` When using the `publish` option on the command line with authentication, you can provide credentials using properties as in this example: ```shell $ mvn spring-boot:build-image \ -Ddocker.publishRegistry.username=user \ -Ddocker.publishRegistry.password=secret \ -Ddocker.publishRegistry.url=docker.example.com \ -Dspring-boot.build-image.publish=true \ -Dspring-boot.build-image.imageName=docker.example.com/library/my-app:v1 ``` and reference the properties in the XML configuration: ```xml org.springframework.boot spring-boot-maven-plugin ${docker.publishRegistry.url} ${docker.publishRegistry.username} ${docker.publishRegistry.password} ``` ### [](#build-image.examples.caches)Builder Cache and Workspace Configuration The CNB builder caches layers that are used when building and launching an image. By default, these caches are stored as named volumes in the Docker daemon with names that are derived from the full name of the target image. If the image name changes frequently, for example when the project version is used as a tag in the image name, then the caches can be invalidated frequently. The cache volumes can be configured to use alternative names to give more control over cache lifecycle as shown in the following example: ```xml org.springframework.boot spring-boot-maven-plugin cache-${project.artifactId}.build cache-${project.artifactId}.launch ``` Builders and buildpacks need a location to store temporary files during image building. By default, this temporary build workspace is stored in a named volume. The caches and the build workspace can be configured to use bind mounts instead of named volumes, as shown in the following example: ```xml org.springframework.boot spring-boot-maven-plugin /tmp/cache-${project.artifactId}.work /tmp/cache-${project.artifactId}.build /tmp/cache-${project.artifactId}.launch ``` ### [](#build-image.examples.docker)Docker Configuration #### [](#build-image.examples.docker.minikube)Docker Configuration for minikube The plugin can communicate with the [Docker daemon provided by minikube](https://minikube.sigs.k8s.io/docs/tasks/docker_daemon/) instead of the default local connection. On Linux and macOS, environment variables can be set using the command `eval $(minikube docker-env)` after minikube has been started. The plugin can also be configured to use the minikube daemon by providing connection details similar to those shown in the following example: ```xml org.springframework.boot spring-boot-maven-plugin tcp://192.168.99.100:2376 true /home/user/.minikube/certs ``` #### [](#build-image.examples.docker.podman)Docker Configuration for podman The plugin can communicate with a [podman container engine](https://podman.io/). The plugin can be configured to use podman local connection by providing connection details similar to those shown in the following example: ```xml org.springframework.boot spring-boot-maven-plugin unix:///run/user/1000/podman/podman.sock true ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | With the `colima` CLI installed, the command `podman info --format='{{.Host.RemoteSocket.Path}}'` can be used to get the value for the `docker.host` configuration property shown in this example. | #### [](#build-image.examples.docker.colima)Docker Configuration for Colima The plugin can communicate with the Docker daemon provided by [Colima](https://github.com/abiosoft/colima). The `DOCKER_HOST` environment variable can be set by using the following command: ```shell $ export DOCKER_HOST=$(docker context inspect colima -f '{{.Endpoints.docker.Host}}') ``` The plugin can also be configured to use Colima daemon by providing connection details similar to those shown in the following example: ```xml org.springframework.boot spring-boot-maven-plugin unix:///${user.home}/.colima/docker.sock ``` #### [](#build-image.examples.docker.auth)Docker Configuration for Authentication If the builder or run image are stored in a private Docker registry that supports user authentication, authentication details can be provided using `docker.builderRegistry` parameters as shown in the following example: ```xml org.springframework.boot spring-boot-maven-plugin user secret https://docker.example.com/v1/ [email protected] ``` If the builder or run image is stored in a private Docker registry that supports token authentication, the token value can be provided using `docker.builderRegistry` parameters as shown in the following example: ```xml org.springframework.boot spring-boot-maven-plugin 9cbaf023786cd7... ``` * [Spring Boot](../index.html) * [4.1.1](build-image.html) * [4.0.8](../4.0/maven-plugin/build-image.html) * [3.5.16](../3.5/maven-plugin/build-image.html) * [3.4.13](../3.4/maven-plugin/build-image.html) * [3.3.13](../3.3/maven-plugin/build-image.html) - [4.2.0-M2](../4.2/maven-plugin/build-image.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/maven-plugin/build-image.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/maven-plugin/build-image.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/maven-plugin/build-image.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/index-files/index-6.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ## F * [forClass(Class)](../org/springframework/boot/gradle/util/VersionExtractor.html#forClass\(java.lang.Class\)) - Static method in class org.springframework.boot.gradle.util.[VersionExtractor](../org/springframework/boot/gradle/util/VersionExtractor.html "class in org.springframework.boot.gradle.util") Return the version information for the provided [`Class`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html "class or interface in java.lang"). [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-20.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## W * [WAR](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html#WAR) - Enum constant in enum class org.springframework.boot.maven.[AbstractPackagerMojo.LayoutType](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") War Layout. [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/plugin/class-use/ResolveMainClassName.html ---- Uses of Class\ org.springframework.boot.gradle.plugin.ResolveMainClassName =========================================================== No usage of org.springframework.boot.gradle.plugin.ResolveMainClassName ---- url: https://docs.spring.io/spring-boot/how-to/deployment/cloud.html ---- # Deploying to the Cloud Spring Boot’s executable jars are ready-made for most popular cloud PaaS (Platform-as-a-Service) providers. These providers tend to require that you “bring your own container”. They manage application processes (not Java applications specifically), so they need an intermediary layer that adapts *your* application to the *cloud’s* notion of a running process. Two popular cloud providers, Heroku and Cloud Foundry, employ a “buildpack” approach. The buildpack wraps your deployed code in whatever is needed to *start* your application. It might be a JDK and a call to `java`, an embedded web server, or a full-fledged application server. A buildpack is pluggable, but ideally you should be able to get by with as few customizations to it as possible. This reduces the footprint of functionality that is not under your control. It minimizes divergence between development and production environments. Ideally, your application, like a Spring Boot executable jar, has everything that it needs to run packaged within it. In this section, we look at what it takes to get the [application that we developed](../../tutorial/first-application/index.html) in the “Getting Started” section up and running in the Cloud. ## [](#howto.deployment.cloud.security)Security considerations Support for [forwarded headers](../webserver.html#howto.webserver.use-behind-a-proxy-server) should only be enabled when the application receives traffic from a trusted HTTP proxy, and is only directly accessible from a trusted network. When running on a cloud platform, forward headers are enabled automatically. This builds on the assumption that the platform will ensure that individual application instances will only be directly accessible from a trusted network. If that is not the case for your specific platform, set `server.forward-headers-strategy` to `none`. ## [](#howto.deployment.cloud.cloud-foundry)Cloud Foundry Cloud Foundry provides default buildpacks that come into play if no other buildpack is specified. The Cloud Foundry [Java buildpack](https://github.com/cloudfoundry/java-buildpack) has excellent support for Spring applications, including Spring Boot. You can deploy stand-alone executable jar applications as well as traditional `.war` packaged applications. Once you have built your application (by using, for example, `mvn clean package`) and have [installed the `cf` command line tool](https://docs.cloudfoundry.org/cf-cli/install-go-cli.html), deploy your application by using the `cf push` command, substituting the path to your compiled `.jar`. Be sure to have [logged in with your `cf` command line client](https://docs.cloudfoundry.org/cf-cli/getting-started.html#login) before pushing an application. The following line shows using the `cf push` command to deploy an application: ```shell $ cf push acloudyspringtime -p target/demo-0.0.1-SNAPSHOT.jar ``` | | | | -- | ----------------------------------------------------------------------------------------------------------------------------- | | ** | In the preceding example, we substitute `acloudyspringtime` for whatever value you give `cf` as the name of your application. | See the [`cf push` documentation](https://docs.cloudfoundry.org/cf-cli/getting-started.html#push) for more options. If there is a Cloud Foundry [`manifest.yml`](https://docs.cloudfoundry.org/devguide/deploy-apps/manifest.html) file present in the same directory, it is considered. At this point, `cf` starts uploading your application, producing output similar to the following example: ```none Uploading acloudyspringtime... OK Preparing to start acloudyspringtime... OK -----> Downloaded app package (8.9M) -----> Java Buildpack Version: v3.12 (offline) | https://github.com/cloudfoundry/java-buildpack.git#6f25b7e -----> Downloading Open Jdk JRE Expanding Open Jdk JRE to .java-buildpack/open_jdk_jre (1.6s) -----> Downloading Open JDK Like Memory Calculator 2.0.2_RELEASE from https://java-buildpack.cloudfoundry.org/memory-calculator/trusty/x86_64/memory-calculator-2.0.2_RELEASE.tar.gz (found in cache) Memory Settings: -Xss349K -Xmx681574K -XX:MaxMetaspaceSize=104857K -Xms681574K -XX:MetaspaceSize=104857K -----> Downloading Container Certificate Trust Store 1.0.0_RELEASE from https://java-buildpack.cloudfoundry.org/container-certificate-trust-store/container-certificate-trust-store-1.0.0_RELEASE.jar (found in cache) Adding certificates to .java-buildpack/container_certificate_trust_store/truststore.jks (0.6s) -----> Downloading Spring Auto Reconfiguration 1.10.0_RELEASE from https://java-buildpack.cloudfoundry.org/auto-reconfiguration/auto-reconfiguration-1.10.0_RELEASE.jar (found in cache) Checking status of app 'acloudyspringtime'... 0 of 1 instances running (1 starting) ... 0 of 1 instances running (1 starting) ... 0 of 1 instances running (1 starting) ... 1 of 1 instances running (1 running) App started ``` Congratulations! The application is now live! Once your application is live, you can verify the status of the deployed application by using the `cf apps` command, as shown in the following example: ```shell $ cf apps Getting applications in ... OK name requested state instances memory disk urls ... acloudyspringtime started 1/1 512M 1G acloudyspringtime.cfapps.io ... ``` Once Cloud Foundry acknowledges that your application has been deployed, you should be able to find the application at the URI given. In the preceding example, you could find it at `https://acloudyspringtime.cfapps.io/`. ### [](#howto.deployment.cloud.cloud-foundry.binding-to-services)Binding to Services By default, metadata about the running application as well as service connection information is exposed to the application as environment variables (for example: `$VCAP_SERVICES`). This architecture decision is due to Cloud Foundry’s polyglot (any language and platform can be supported as a buildpack) nature. Process-scoped environment variables are language agnostic. Environment variables do not always make for the easiest API, so Spring Boot automatically extracts them and flattens the data into properties that can be accessed through Spring’s [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) abstraction, as shown in the following example: * Java * Kotlin ```java import org.springframework.context.EnvironmentAware; import org.springframework.core.env.Environment; import org.springframework.stereotype.Component; @Component public class MyBean implements EnvironmentAware { private String instanceId; @Override public void setEnvironment(Environment environment) { this.instanceId = environment.getProperty("vcap.application.instance_id"); } // ... } ``` ```kotlin import org.springframework.context.EnvironmentAware import org.springframework.core.env.Environment import org.springframework.stereotype.Component @Component class MyBean : EnvironmentAware { private var instanceId: String? = null override fun setEnvironment(environment: Environment) { instanceId = environment.getProperty("vcap.application.instance_id") } // ... } ``` All Cloud Foundry properties are prefixed with `vcap`. You can use `vcap` properties to access application information (such as the public URL of the application) and service information (such as database credentials). See the [`CloudFoundryVcapEnvironmentPostProcessor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/cloud/CloudFoundryVcapEnvironmentPostProcessor.html) API documentation for complete details. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------- | | ** | The [Java CFEnv](https://github.com/pivotal-cf/java-cfenv/) project is a better fit for tasks such as configuring a DataSource. | ## [](#howto.deployment.cloud.kubernetes)Kubernetes Spring Boot auto-detects Kubernetes deployment environments by checking the environment for `"*_SERVICE_HOST"` and `"*_SERVICE_PORT"` variables. You can override this detection with the `spring.main.cloud-platform` configuration property. Spring Boot helps you to [manage the state of your application](../../reference/features/spring-application.html#features.spring-application.application-availability) and export it with [HTTP Kubernetes Probes using Actuator](../../reference/actuator/endpoints.html#actuator.endpoints.kubernetes-probes). ### [](#howto.deployment.cloud.kubernetes.container-lifecycle)Kubernetes Container Lifecycle When Kubernetes deletes an application instance, the shutdown process involves several subsystems concurrently: shutdown hooks, unregistering the service, removing the instance from the load-balancer…​ Because this shutdown processing happens in parallel (and due to the nature of distributed systems), there is a window during which traffic can be routed to a pod that has also begun its shutdown processing. You can configure a sleep execution in a preStop handler to avoid requests being routed to a pod that has already begun shutting down. This sleep should be long enough for new requests to stop being routed to the pod and its duration will vary from deployment to deployment. The delay should be at least as long as the longest time it takes to process an in-flight request. You should not rely on the Spring Boot graceful shutdown period alone, as the platform will not be getting any liveness data in the period that the app is shutting down. If you’re using Kubernetes 1.32 or up, the preStop handler can be configured by using the PodSpec in the pod’s configuration file as follows: ```yaml spec: containers: - name: "example-container" image: "example-image" lifecycle: preStop: sleep: seconds: 10 ``` If you’re not on Kubernetes 1.32 yet, you can use an `exec` command to invoke `sleep`. ```yaml spec: containers: - name: "example-container" image: "example-image" lifecycle: preStop: exec: command: ["sh", "-c", "sleep 10"] ``` | | | | -- | ----------------------------------------------------- | | ** | The container needs to have a shell for this to work. | Once the pre-stop hook has completed, SIGTERM will be sent to the container and [graceful shutdown](../../reference/web/graceful-shutdown.html) will begin, allowing any remaining in-flight requests to complete. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | When Kubernetes sends a SIGTERM signal to the pod, it waits for a specified time called the termination grace period (the default for which is 30 seconds). If the containers are still running after the grace period, they are sent the SIGKILL signal and forcibly removed. If the pod takes longer than 30 seconds to shut down, which could be because you have increased `spring.lifecycle.timeout-per-shutdown-phase`, make sure to increase the termination grace period by setting the `terminationGracePeriodSeconds` option in the Pod YAML. | ## [](#howto.deployment.cloud.heroku)Heroku Heroku is another popular PaaS platform. To customize Heroku builds, you provide a `Procfile`, which provides the incantation required to deploy an application. Heroku assigns a `port` for the Java application to use and then ensures that routing to the external URI works. You must configure your application to listen on the correct port. The following example shows the `Procfile` for our starter REST application: ```none web: java -Dserver.port=$PORT -jar target/demo-0.0.1-SNAPSHOT.jar ``` Spring Boot makes `-D` arguments available as properties accessible from a Spring [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html) instance. The `server.port` configuration property is fed to the embedded Tomcat or Jetty instance, which then uses the port when it starts up. The `$PORT` environment variable is assigned to us by the Heroku PaaS. This should be everything you need. The most common deployment workflow for Heroku deployments is to `git push` the code to production, as shown in the following example: ```shell $ git push heroku main ``` Which will result in the following: ```none Initializing repository, done. Counting objects: 95, done. Delta compression using up to 8 threads. Compressing objects: 100% (78/78), done. Writing objects: 100% (95/95), 8.66 MiB | 606.00 KiB/s, done. Total 95 (delta 31), reused 0 (delta 0) -----> Java app detected -----> Installing OpenJDK... done -----> Installing Maven... done -----> Installing settings.xml... done -----> Executing: mvn -B -DskipTests=true clean install [INFO] Scanning for projects... Downloading: https://repo.spring.io/... Downloaded: https://repo.spring.io/... (818 B at 1.8 KB/sec) .... Downloaded: https://s3pository.heroku.com/jvm/... (152 KB at 595.3 KB/sec) [INFO] Installing /tmp/build_0c35a5d2-a067-4abc-a232-14b1fb7a8229/target/... [INFO] Installing /tmp/build_0c35a5d2-a067-4abc-a232-14b1fb7a8229/pom.xml ... [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ [INFO] Total time: 59.358s [INFO] Finished at: Fri Mar 07 07:28:25 UTC 2014 [INFO] Final Memory: 20M/493M [INFO] ------------------------------------------------------------------------ -----> Discovering process types Procfile declares types -> web -----> Compressing... done, 70.4MB -----> Launching... done, v6 https://agile-sierra-1405.herokuapp.com/ deployed to Heroku To [email protected]:agile-sierra-1405.git * [new branch] main -> main ``` Your application should now be up and running on Heroku. For more details, see [Deploying Spring Boot Applications to Heroku](https://devcenter.heroku.com/articles/deploying-spring-boot-apps-to-heroku). ## [](#howto.deployment.cloud.openshift)OpenShift [OpenShift](https://www.openshift.com/) has many resources describing how to deploy Spring Boot applications, including: * [Using the S2I builder](https://blog.openshift.com/using-openshift-enterprise-grade-spring-boot-deployments/) * [Running as a traditional web application on Wildfly](https://blog.openshift.com/using-spring-boot-on-openshift/) * [OpenShift Commons Briefing](https://blog.openshift.com/openshift-commons-briefing-96-cloud-native-applications-spring-rhoar/) ## [](#howto.deployment.cloud.aws)Amazon Web Services (AWS) Amazon Web Services provides several options that are suitable for running Spring Boot-based applications, either as containers, traditional web applications (war), or self-contained executable jar files. Popular options are: * Amazon Elastic Container Service (ECS) * AWS Elastic Beanstalk ### [](#howto.deployment.cloud.aws.ecs)Amazon Elastic Container Service (ECS) Official [Amazon ECS developer guide](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/Welcome.html) provides comprehensive overview of platform’s features and includes [getting started guide](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/getting-started.html) that walks you through the steps needed to get your containers up and running. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Spring Boot applications can be packaged in Docker containers using techniques described in [Container Images](../../reference/packaging/container-images/index.html). | In addition to the developer guide, AWS also provides a [topical guide](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-container-image.html) for deploying containerized Java services on Amazon ECS using AWS Fargate. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | Spring Boot auto-detects AWS ECS deployment environments by checking the environment for the `AWS_EXECUTION_ENV` variable. You can override this detection with the `spring.main.cloud-platform` configuration property. | ### [](#howto.deployment.cloud.aws.beanstalk)AWS Elastic Beanstalk As described in the official [Elastic Beanstalk Java guide](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/create_deploy_Java.html), there are two main options to deploy a Java application. You can either use the “Tomcat Platform” or the “Java SE platform”. #### [](#howto.deployment.cloud.aws.beanstalk.tomcat-platform)Using the Tomcat Platform This option applies to Spring Boot projects that produce a war file. Follow the official guide and [Java on Tomcat tutorial](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/tomcat-quickstart.html). | | | | -- | ---------------------------------------------------------------------------------------------------------------------------- | | ** | Creating deployable war for a Spring Boot application is described in [Traditional Deployment](traditional-deployment.html). | #### [](#howto.deployment.cloud.aws.beanstalk.java-se-platform)Using the Java SE Platform This option applies to Spring Boot projects that produce a jar file and run an embedded web container. Follow the official guide and [Java tutorial](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/java-quickstart.html). There are also community provided tutorials such as [this one](https://www.baeldung.com/spring-boot-deploy-aws-beanstalk). ## [](#howto.deployment.cloud.boxfuse)CloudCaptain and Amazon Web Services [CloudCaptain](https://cloudcaptain.sh/) works by turning your Spring Boot executable jar or war into a minimal VM image that can be deployed unchanged either on VirtualBox or on AWS. CloudCaptain comes with deep integration for Spring Boot and uses the information from your Spring Boot configuration file to automatically configure ports and health check URLs. CloudCaptain leverages this information both for the images it produces as well as for all the resources it provisions (instances, security groups, elastic load balancers, and so on). Once you have created a [CloudCaptain account](https://console.cloudcaptain.sh), connected it to your AWS account, installed the latest version of the CloudCaptain Client, and ensured that the application has been built by Maven or Gradle (by using, for example, `mvn clean package`), you can deploy your Spring Boot application to AWS with a command similar to the following: ```shell $ boxfuse run myapp-1.0.jar -env=prod ``` See the [`boxfuse run` documentation](https://cloudcaptain.sh/docs/commandline/run.html) for more options. If there is a [`boxfuse.conf`](https://cloudcaptain.sh/docs/commandline/#configuration) file present in the current directory, it is considered. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | By default, CloudCaptain activates a Spring profile named `boxfuse` on startup. If your executable jar or war contains an [`application-boxfuse.properties`](https://cloudcaptain.sh/docs/payloads/springboot.html#configuration) file, CloudCaptain bases its configuration on the properties it contains. | At this point, CloudCaptain creates an image for your application, uploads it, and configures and starts the necessary resources on AWS, resulting in output similar to the following example: ```none Fusing Image for myapp-1.0.jar ... Image fused in 00:06.838s (53937 K) -> axelfontaine/myapp:1.0 Creating axelfontaine/myapp ... Pushing axelfontaine/myapp:1.0 ... Verifying axelfontaine/myapp:1.0 ... Creating Elastic IP ... Mapping myapp-axelfontaine.boxfuse.io to 52.28.233.167 ... Waiting for AWS to create an AMI for axelfontaine/myapp:1.0 in eu-central-1 (this may take up to 50 seconds) ... AMI created in 00:23.557s -> ami-d23f38cf Creating security group boxfuse-sg_axelfontaine/myapp:1.0 ... Launching t2.micro instance of axelfontaine/myapp:1.0 (ami-d23f38cf) in eu-central-1 ... Instance launched in 00:30.306s -> i-92ef9f53 Waiting for AWS to boot Instance i-92ef9f53 and Payload to start at https://52.28.235.61/ ... Payload started in 00:29.266s -> https://52.28.235.61/ Remapping Elastic IP 52.28.233.167 to i-92ef9f53 ... Waiting 15s for AWS to complete Elastic IP Zero Downtime transition ... Deployment completed successfully. axelfontaine/myapp:1.0 is up and running at https://myapp-axelfontaine.boxfuse.io/ ``` Your application should now be up and running on AWS. See the blog post on [deploying Spring Boot apps on EC2](https://cloudcaptain.sh/blog/spring-boot-ec2.html) as well as the [documentation for the CloudCaptain Spring Boot integration](https://cloudcaptain.sh/docs/payloads/springboot.html) to get started with a Maven build to run the app. ## [](#howto.deployment.cloud.azure)Azure This [Getting Started guide](https://spring.io/guides/gs/spring-boot-for-azure/) walks you through deploying your Spring Boot application to either [Azure Spring Cloud](https://azure.microsoft.com/en-us/services/spring-cloud/) or [Azure App Service](https://docs.microsoft.com/en-us/azure/app-service/overview). ## [](#howto.deployment.cloud.google)Google Cloud Google Cloud has several options that can be used to launch Spring Boot applications. The easiest to get started with is probably App Engine, but you could also find ways to run Spring Boot in a container with Container Engine or on a virtual machine with Compute Engine. To deploy your first app to App Engine standard environment, follow [this tutorial](https://codelabs.developers.google.com/codelabs/cloud-app-engine-springboot#0). Alternatively, App Engine Flex requires you to create an `app.yaml` file to describe the resources your app requires. Normally, you put this file in `src/main/appengine`, and it should resemble the following file: ```yaml service: "default" runtime: "java17" env: "flex" handlers: - url: "/.*" script: "this field is required, but ignored" manual_scaling: instances: 1 health_check: enable_health_check: false env_variables: ENCRYPT_KEY: "your_encryption_key_here" ``` You can deploy the app (for example, with a Maven plugin) by adding the project ID to the build configuration, as shown in the following example: ```xml com.google.cloud.tools appengine-maven-plugin 2.4.4 myproject ``` Then deploy with `mvn appengine:deploy` (you need to authenticate first, otherwise the build fails). * [Spring Boot](../../index.html) * [4.1.1](cloud.html) * [4.0.8](../../4.0/how-to/deployment/cloud.html) * [3.5.16](../../3.5/how-to/deployment/cloud.html) * [3.4.13](../../3.4/how-to/deployment/cloud.html) * [3.3.13](../../3.3/how-to/deployment/cloud.html) - [4.2.0-M2](../../4.2/how-to/deployment/cloud.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/how-to/deployment/cloud.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/how-to/deployment/cloud.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/how-to/deployment/cloud.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/system-requirements.html ---- # System Requirements Spring Boot 4.1.1 requires at least [Java 17](https://www.java.com) and is compatible with versions up to and including Java 26. [Spring Framework 7.0.9](https://docs.spring.io/spring-framework/reference/7.0/) or above is also required. Support for third-party projects may have additional or higher requirements. Refer to the documentation for that support for further details. Explicit build support is provided for the following build tools: | Build Tool | Version | | ---------- | ---------------------------------- | | Maven | 3.6.3 or later | | Gradle | Gradle 8.x (8.14 or later) and 9.x | ## [](#getting-started.system-requirements.servlet-containers)Servlet Containers Spring Boot supports the following embedded servlet containers: | Name | Servlet Version | | ------------- | --------------- | | Tomcat 11.0.x | 6.1 | | Jetty 12.1.x | 6.1 | You can also deploy Spring Boot applications to any Servlet 6.1+ compatible container. ## [](#getting-started.system-requirements.graal)GraalVM Native Images Spring Boot applications can be [converted into a Native Image](reference/packaging/native-image/introducing-graalvm-native-images.html) using GraalVM 25 or above. Images can be created using the [native build tools](https://github.com/graalvm/native-build-tools) Gradle/Maven plugins or `native-image` tool provided by GraalVM. You can also create native images using the [native-image Paketo buildpack](https://github.com/paketo-buildpacks/native-image). The following versions are supported: | Name | Version | | ------------------ | ------- | | GraalVM Community | 25 | | Native Build Tools | 1.1.8 | * [Spring Boot](index.html) * [4.1.1](system-requirements.html) * [4.0.8](4.0/system-requirements.html) * [3.5.16](3.5/system-requirements.html) * [3.4.13](3.4/system-requirements.html) * [3.3.13](3.3/system-requirements.html) - [4.2.0-M2](4.2/system-requirements.html) * [4.2.0-SNAPSHOT](4.2-SNAPSHOT/system-requirements.html) * [4.1.3-SNAPSHOT](4.1-SNAPSHOT/system-requirements.html) * [4.0.10-SNAPSHOT](4.0-SNAPSHOT/system-requirements.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/messaging/pulsar.html ---- # Apache Pulsar Support [Apache Pulsar](https://pulsar.apache.org/) is supported by providing auto-configuration of the [Spring for Apache Pulsar](https://spring.io/projects/spring-pulsar) project. Spring Boot will auto-configure and register the Spring for Apache Pulsar components when `org.springframework.pulsar:spring-pulsar` is on the classpath. There is the `spring-boot-starter-pulsar` starter for conveniently collecting the dependencies for use. ## [](#messaging.pulsar.connecting)Connecting to Pulsar When you use the Pulsar starter, Spring Boot will auto-configure and register a [`PulsarClient`](https://javadoc.io/doc/org.apache.pulsar/pulsar-client-api/4.2.4/org/apache/pulsar/client/api/PulsarClient.html) bean. By default, the application tries to connect to a local Pulsar instance at `pulsar://localhost:6650`. This can be adjusted by setting the `spring.pulsar.client.service-url` property to a different value. | | | | -- | ---------------------------------------------------------------------------------------------------------------------- | | ** | The value must be a valid [Pulsar Protocol](https://pulsar.apache.org/docs/client-libraries-java/#connection-urls) URL | You can configure the client by specifying any of the `spring.pulsar.client.*` prefixed application properties. If you need more control over the configuration, consider registering one or more [`PulsarClientBuilderCustomizer`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/core/PulsarClientBuilderCustomizer.html) beans. ### [](#messaging.pulsar.connecting.auth)Authentication To connect to a Pulsar cluster that requires authentication, you need to specify which authentication plugin to use by setting the `pluginClassName` and any parameters required by the plugin. You can set the parameters as a map of parameter names to parameter values. The following example shows how to configure the `AuthenticationOAuth2` plugin. * Properties * YAML ```properties spring.pulsar.client.authentication.plugin-class-name=org.apache.pulsar.client.impl.auth.oauth2.AuthenticationOAuth2 spring.pulsar.client.authentication.param.issuerUrl=https://auth.server.cloud/ spring.pulsar.client.authentication.param.privateKey=file:///Users/some-key.json spring.pulsar.client.authentication.param.audience=urn:sn:acme:dev:my-instance ``` ```yaml spring: pulsar: client: authentication: plugin-class-name: org.apache.pulsar.client.impl.auth.oauth2.AuthenticationOAuth2 param: issuerUrl: https://auth.server.cloud/ privateKey: file:///Users/some-key.json audience: urn:sn:acme:dev:my-instance ``` | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You need to ensure that names defined under `spring.pulsar.client.authentication.param.*` exactly match those expected by your auth plugin (which is typically camel cased). Spring Boot will not attempt any kind of relaxed binding for these entries.For example, if you want to configure the issuer url for the `AuthenticationOAuth2` auth plugin you must use `spring.pulsar.client.authentication.param.issuerUrl`. If you use other forms, such as `issuerurl` or `issuer-url`, the setting will not be applied to the plugin.This lack of relaxed binding also makes using environment variables for authentication parameters problematic because the case sensitivity is lost during translation. If you use environment variables for the parameters then you will need to follow [these steps](https://docs.spring.io/spring-pulsar/docs/2.0.x/reference/reference/pulsar/pulsar-client.html#client-authentication-env-vars) in the Spring for Apache Pulsar reference documentation for it to work properly. | ### [](#messaging.pulsar.connecting.ssl)SSL By default, Pulsar clients communicate with Pulsar services in plain text. You can follow [these steps](https://docs.spring.io/spring-pulsar/docs/2.0.x/reference/reference/pulsar/pulsar-client.html#tls-encryption) in the Spring for Apache Pulsar reference documentation to enable TLS encryption. For complete details on the client and authentication see the Spring for Apache Pulsar [reference documentation](https://docs.spring.io/spring-pulsar/docs/2.0.x/reference/reference/pulsar/pulsar-client.html). ## [](#messaging.pulsar.admin)Connecting to Pulsar Administration Spring for Apache Pulsar’s [`PulsarAdministration`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/core/PulsarAdministration.html) client is also auto-configured. By default, the application tries to connect to a local Pulsar instance at `http://localhost:8080`. This can be adjusted by setting the `spring.pulsar.admin.service-url` property to a different value in the form `(http|https)://:`. If you need more control over the configuration, consider registering one or more [`PulsarAdminBuilderCustomizer`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/core/PulsarAdminBuilderCustomizer.html) beans. ### [](#messaging.pulsar.admin.auth)Authentication When accessing a Pulsar cluster that requires authentication, the admin client requires the same security configuration as the regular Pulsar client. You can use the aforementioned [authentication configuration](#messaging.pulsar.connecting.auth) by replacing `spring.pulsar.client.authentication` with `spring.pulsar.admin.authentication`. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | To create a topic on startup, add a bean of type [`PulsarTopic`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/core/PulsarTopic.html). If the topic already exists, the bean is ignored. | ## [](#messaging.pulsar.sending)Sending a Message Spring’s [`PulsarTemplate`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/core/PulsarTemplate.html) is auto-configured, and you can use it to send messages, as shown in the following example: * Java * Kotlin ```java import org.springframework.pulsar.core.PulsarTemplate; import org.springframework.stereotype.Component; @Component public class MyBean { private final PulsarTemplate pulsarTemplate; public MyBean(PulsarTemplate pulsarTemplate) { this.pulsarTemplate = pulsarTemplate; } public void someMethod() { this.pulsarTemplate.send("someTopic", "Hello"); } } ``` ```kotlin import org.apache.pulsar.client.api.PulsarClientException import org.springframework.pulsar.core.PulsarTemplate import org.springframework.stereotype.Component @Component class MyBean(private val pulsarTemplate: PulsarTemplate) { @Throws(PulsarClientException::class) fun someMethod() { pulsarTemplate.send("someTopic", "Hello") } } ``` The [`PulsarTemplate`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/core/PulsarTemplate.html) relies on a [`PulsarProducerFactory`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/core/PulsarProducerFactory.html) to create the underlying Pulsar producer. Spring Boot auto-configuration also provides this producer factory, which by default, caches the producers that it creates. You can configure the producer factory and cache settings by specifying any of the `spring.pulsar.producer.*` and `spring.pulsar.producer.cache.*` prefixed application properties. If you need more control over the producer factory configuration, consider registering one or more [`ProducerBuilderCustomizer`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/core/ProducerBuilderCustomizer.html) beans. These customizers are applied to all created producers. You can also pass in a [`ProducerBuilderCustomizer`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/core/ProducerBuilderCustomizer.html) when sending a message to only affect the current producer. If you need more control over the message being sent, you can pass in a [`TypedMessageBuilderCustomizer`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/core/TypedMessageBuilderCustomizer.html) when sending a message. ## [](#messaging.pulsar.receiving)Receiving a Message When the Apache Pulsar infrastructure is present, any bean can be annotated with [`@PulsarListener`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/annotation/PulsarListener.html) to create a listener endpoint. The following component creates a listener endpoint on the `someTopic` topic: * Java * Kotlin ```java import org.springframework.pulsar.annotation.PulsarListener; import org.springframework.stereotype.Component; @Component public class MyBean { @PulsarListener(topics = "someTopic") public void processMessage(String content) { // ... } } ``` ```kotlin import org.springframework.pulsar.annotation.PulsarListener import org.springframework.stereotype.Component @Component class MyBean { @PulsarListener(topics = ["someTopic"]) fun processMessage(content: String?) { // ... } } ``` Spring Boot auto-configuration provides all the components necessary for [`PulsarListener`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/annotation/PulsarListener.html), such as the [`PulsarListenerContainerFactory`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/config/PulsarListenerContainerFactory.html) and the consumer factory it uses to construct the underlying Pulsar consumers. You can configure these components by specifying any of the `spring.pulsar.listener.*` and `spring.pulsar.consumer.*` prefixed application properties. If you need more control over the configuration of the consumer factory, consider registering one or more [`ConsumerBuilderCustomizer`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/core/ConsumerBuilderCustomizer.html) beans. These customizers are applied to all consumers created by the factory, and therefore all [`@PulsarListener`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/annotation/PulsarListener.html) instances. You can also customize a single listener by setting the `consumerCustomizer` attribute of the [`@PulsarListener`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/annotation/PulsarListener.html) annotation. If you need more control over the actual container factory configuration, consider registering one or more `PulsarContainerFactoryCustomizer>` beans. ## [](#messaging.pulsar.reading)Reading a Message The Pulsar reader interface enables applications to manually manage cursors. When you use a reader to connect to a topic you need to specify which message the reader begins reading from when it connects to a topic. When the Apache Pulsar infrastructure is present, any bean can be annotated with [`@PulsarReader`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/annotation/PulsarReader.html) to consume messages using a reader. The following component creates a reader endpoint that starts reading messages from the beginning of the `someTopic` topic: * Java * Kotlin ```java import org.springframework.pulsar.annotation.PulsarReader; import org.springframework.stereotype.Component; @Component public class MyBean { @PulsarReader(topics = "someTopic", startMessageId = "earliest") public void processMessage(String content) { // ... } } ``` ```kotlin import org.springframework.pulsar.annotation.PulsarReader import org.springframework.stereotype.Component @Component class MyBean { @PulsarReader(topics = ["someTopic"], startMessageId = "earliest") fun processMessage(content: String?) { // ... } } ``` The [`@PulsarReader`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/annotation/PulsarReader.html) relies on a [`PulsarReaderFactory`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/core/PulsarReaderFactory.html) to create the underlying Pulsar reader. Spring Boot auto-configuration provides this reader factory which can be customized by setting any of the `spring.pulsar.reader.*` prefixed application properties. If you need more control over the configuration of the reader factory, consider registering one or more [`ReaderBuilderCustomizer`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/core/ReaderBuilderCustomizer.html) beans. These customizers are applied to all readers created by the factory, and therefore all [`@PulsarReader`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/annotation/PulsarReader.html) instances. You can also customize a single listener by setting the `readerCustomizer` attribute of the [`@PulsarReader`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/annotation/PulsarReader.html) annotation. If you need more control over the actual container factory configuration, consider registering one or more `PulsarContainerFactoryCustomizer>` beans. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | For more details on any of the above components and to discover other available features, see the Spring for Apache Pulsar [reference documentation](https://docs.spring.io/spring-pulsar/docs/2.0.x/reference). | ## [](#messaging.pulsar.transactions)Transaction Support Spring for Apache Pulsar supports transactions when using [`PulsarTemplate`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/core/PulsarTemplate.html) and [`@PulsarListener`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/annotation/PulsarListener.html). Setting the `spring.pulsar.transaction.enabled` property to `true` will: * Configure a [`PulsarTransactionManager`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/transaction/PulsarTransactionManager.html) bean * Enable transaction support for [`PulsarTemplate`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/core/PulsarTemplate.html) * Enable transaction support for [`@PulsarListener`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/annotation/PulsarListener.html) methods The `transactional` attribute of [`@PulsarListener`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/annotation/PulsarListener.html) can be used to fine-tune when transactions should be used with listeners. For more control of the Spring for Apache Pulsar transaction features you should define your own [`PulsarTemplate`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/core/PulsarTemplate.html) and/or [`ConcurrentPulsarListenerContainerFactory`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/config/ConcurrentPulsarListenerContainerFactory.html) beans. You can also define a [`PulsarAwareTransactionManager`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/transaction/PulsarAwareTransactionManager.html) bean if the default auto-configured [`PulsarTransactionManager`](https://docs.spring.io/spring-pulsar/docs/2.0.x/api/org/springframework/pulsar/transaction/PulsarTransactionManager.html) is not suitable. ## [](#messaging.pulsar.additional-properties)Additional Pulsar Properties The properties supported by auto-configuration are shown in the [Integration Properties](../../appendix/application-properties/index.html#appendix.application-properties.integration) section of the Appendix. Note that, for the most part, these properties (hyphenated or camelCase) map directly to the Apache Pulsar configuration properties. See the Apache Pulsar documentation for details. Only a subset of the properties supported by Pulsar are available directly through the [`PulsarProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/pulsar/autoconfigure/PulsarProperties.html) class. If you wish to tune the auto-configured components with additional properties that are not directly supported, you can use the customizer supported by each aforementioned component. * [Spring Boot](../../index.html) * [4.1.1](pulsar.html) * [4.0.8](../../4.0/reference/messaging/pulsar.html) * [3.5.16](../../3.5/reference/messaging/pulsar.html) * [3.4.13](../../3.4/reference/messaging/pulsar.html) * [3.3.13](../../3.3/reference/messaging/pulsar.html) - [4.2.0-M2](../../4.2/reference/messaging/pulsar.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/messaging/pulsar.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/messaging/pulsar.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/messaging/pulsar.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/AbstractRunMojo.html ---- # Class AbstractRunMojo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.plugin.AbstractMojo [org.springframework.boot.maven.AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") org.springframework.boot.maven.AbstractRunMojo * All Implemented Interfaces: `org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo` - Direct Known Subclasses: `RunMojo, StartMojo, TestRunMojo` *** public abstract class AbstractRunMojo extends [AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") Base class to run a Spring Boot application. * Since: 1.3.0 * Author: Phillip Webb, Stephane Nicoll, David Liu, Daniel Young, Dmytro Nosan, Moritz Halbritter * See Also: * [`RunMojo`](RunMojo.html "class in org.springframework.boot.maven") * [`StartMojo`](StartMojo.html "class in org.springframework.boot.maven") `AbstractRunMojo(org.apache.maven.toolchain.ToolchainManager toolchainManager)`   - ## Method Summary Modifier and Type Method Description `void` `execute()`   `protected List` `getClassesDirectories()` Returns the directories that contain the application's classes and resources. `protected URL[]` `getClassPathUrls()`   `protected abstract boolean` `isUseTestClasspath()`   `protected org.springframework.boot.maven.RunArguments` `resolveApplicationArguments()` Resolve the application arguments to use. `protected org.springframework.boot.maven.EnvVariables` `resolveEnvVariables()` Resolve the environment variables to use. `protected org.springframework.boot.maven.RunArguments` `resolveJvmArguments()` Resolve the JVM arguments to use. `protected abstract void` `run(org.springframework.boot.maven.JavaProcessExecutor processExecutor, File workingDirectory, List args, Map environmentVariables)` Run the application. * ### AbstractRunMojo protected AbstractRunMojo​(org.apache.maven.toolchain.ToolchainManager toolchainManager) * ## Method Details * ### execute public void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException * Throws: * `org.apache.maven.plugin.MojoExecutionException` * `org.apache.maven.plugin.MojoFailureException` * ### getClassesDirectories protected [List](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html "class or interface in java.util")<[File](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html "class or interface in java.io")> getClassesDirectories() Returns the directories that contain the application's classes and resources. When the application's main class has not been configured, each directory is searched in turn for an appropriate main class. * Returns: the directories that contain the application's classes and resources * Since: 3.1.0 * ### isUseTestClasspath protected abstract boolean isUseTestClasspath() * ### run protected abstract void run​(org.springframework.boot.maven.JavaProcessExecutor processExecutor, [File](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html "class or interface in java.io") workingDirectory, [List](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html "class or interface in java.util")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> args, [Map](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html "class or interface in java.util")<[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang"),​[String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")> environmentVariables) throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException Run the application. * Parameters: * `processExecutor` - the `JavaProcessExecutor` to use * `workingDirectory` - the working directory of the forked JVM * `args` - the arguments (JVM arguments and application arguments) * `environmentVariables` - the environment variables * Throws: * `org.apache.maven.plugin.MojoExecutionException` - in case of MOJO execution errors * `org.apache.maven.plugin.MojoFailureException` - in case of MOJO failures * Since: 3.0.0 * ### resolveApplicationArguments protected org.springframework.boot.maven.RunArguments resolveApplicationArguments() Resolve the application arguments to use. * Returns: a `RunArguments` defining the application arguments * ### resolveEnvVariables protected org.springframework.boot.maven.EnvVariables resolveEnvVariables() Resolve the environment variables to use. * Returns: an `EnvVariables` defining the environment variables * ### resolveJvmArguments protected org.springframework.boot.maven.RunArguments resolveJvmArguments() Resolve the JVM arguments to use. * Returns: a `RunArguments` defining the JVM arguments * ### getClassPathUrls protected [URL](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html "class or interface in java.net")\[] getClassPathUrls() throws org.apache.maven.plugin.MojoExecutionException * Throws: `org.apache.maven.plugin.MojoExecutionException` ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-11.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## L * [Layers](../org/springframework/boot/maven/Layers.html "class in org.springframework.boot.maven") - Class in [org.springframework.boot.maven](../org/springframework/boot/maven/package-summary.html) Layer configuration options. * [Layers()](../org/springframework/boot/maven/Layers.html#%3Cinit%3E\(\)) - Constructor for class org.springframework.boot.maven.[Layers](../org/springframework/boot/maven/Layers.html "class in org.springframework.boot.maven")   * [layout()](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html#layout\(\)) - Method in enum class org.springframework.boot.maven.[AbstractPackagerMojo.LayoutType](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven")   [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/plugin/class-use/SpringBootPlugin.html ---- Uses of Class\ org.springframework.boot.gradle.plugin.SpringBootPlugin ======================================================= No usage of org.springframework.boot.gradle.plugin.SpringBootPlugin ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/RunMojo.html ---- Uses of Class\ org.springframework.boot.maven.RunMojo ====================================== No usage of org.springframework.boot.maven.RunMojo ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/AbstractRunMojo.html ---- Uses of Class\ org.springframework.boot.maven.AbstractRunMojo ============================================== * ## Uses of [AbstractRunMojo](../AbstractRunMojo.html "class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Subclasses of [AbstractRunMojo](../AbstractRunMojo.html "class in org.springframework.boot.maven") in [org.springframework.boot.maven](../package-summary.html) Modifier and Type Class Description ---- url: https://docs.spring.io/spring-boot/reference/features/json.html ---- # JSON Spring Boot provides integration with the following JSON mapping libraries: * Jackson 3 * Jackson 2 * Gson * JSON-B * Kotlin Serialization Jackson 3 is the preferred and default library. Support for Jackson 2 is deprecated and will be removed in a future Spring Boot 4.x release. It is provided purely to ease the migration from Jackson 2 to Jackson 3 and should not be relied up in the longer term. ## [](#features.json.jackson)Jackson 3 Auto-configuration for Jackson 3 is provided and Jackson is part of `spring-boot-starter-json`. When Jackson is on the classpath a [`JsonMapper`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.html) bean is automatically configured. Several configuration properties are provided for [customizing the configuration of the ](../../how-to/spring-mvc.html#howto.spring-mvc.customize-jackson-jsonmapper)[`JsonMapper`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.html). ### [](#features.json.jackson.custom-serializers-and-deserializers)Custom Serializers and Deserializers If you use Jackson to serialize and deserialize JSON data, you might want to write your own [`ValueSerializer`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/ValueSerializer.html) and [`ValueDeserializer`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/ValueDeserializer.html) classes. Custom serializers are usually [registered with Jackson through a module](https://github.com/FasterXML/jackson-docs/wiki/JacksonHowToCustomSerializers), but Spring Boot provides an alternative [`@JacksonComponent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson/JacksonComponent.html) annotation that makes it easier to directly register Spring Beans. You can use the [`@JacksonComponent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson/JacksonComponent.html) annotation directly on [`ValueSerializer`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/ValueSerializer.html), [`ValueDeserializer`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/ValueDeserializer.html) or [`KeyDeserializer`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/KeyDeserializer.html) implementations. You can also use it on classes that contain serializers/deserializers as inner classes, as shown in the following example: * Java * Kotlin ```java import tools.jackson.core.JsonGenerator; import tools.jackson.core.JsonParser; import tools.jackson.databind.DeserializationContext; import tools.jackson.databind.JsonNode; import tools.jackson.databind.SerializationContext; import tools.jackson.databind.ValueDeserializer; import tools.jackson.databind.ValueSerializer; import org.springframework.boot.jackson.JacksonComponent; @JacksonComponent public class MyJacksonComponent { public static class Serializer extends ValueSerializer { @Override public void serialize(MyObject value, JsonGenerator jgen, SerializationContext context) { jgen.writeStartObject(); jgen.writeStringProperty("name", value.getName()); jgen.writeNumberProperty("age", value.getAge()); jgen.writeEndObject(); } } public static class Deserializer extends ValueDeserializer { @Override public MyObject deserialize(JsonParser jsonParser, DeserializationContext ctxt) { JsonNode tree = jsonParser.readValueAsTree(); String name = tree.get("name").stringValue(); int age = tree.get("age").intValue(); return new MyObject(name, age); } } } ``` ```kotlin import tools.jackson.core.JsonGenerator import tools.jackson.core.JsonParser import tools.jackson.databind.DeserializationContext import tools.jackson.databind.JsonNode import tools.jackson.databind.SerializationContext import tools.jackson.databind.ValueDeserializer import tools.jackson.databind.ValueSerializer import org.springframework.boot.jackson.JacksonComponent @JacksonComponent class MyJacksonComponent { class Serializer : ValueSerializer() { override fun serialize(value: MyObject, jgen: JsonGenerator, serializers: SerializationContext) { jgen.writeStartObject() jgen.writeStringProperty("name", value.name) jgen.writeNumberProperty("age", value.age) jgen.writeEndObject() } } class Deserializer : ValueDeserializer() { override fun deserialize(jsonParser: JsonParser, ctxt: DeserializationContext): MyObject { val tree = jsonParser.readValueAsTree() val name = tree["name"].stringValue() val age = tree["age"].intValue() return MyObject(name, age) } } } ``` All [`@JacksonComponent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson/JacksonComponent.html) beans in the [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html) are automatically registered with Jackson. Because [`@JacksonComponent`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson/JacksonComponent.html) is meta-annotated with [`@Component`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/stereotype/Component.html), the usual component-scanning rules apply. Spring Boot also provides [`ObjectValueSerializer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson/ObjectValueSerializer.html) and [`ObjectValueDeserializer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson/ObjectValueDeserializer.html) base classes that provide useful alternatives to the standard Jackson versions when serializing objects. See [`ObjectValueSerializer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson/ObjectValueSerializer.html) and [`ObjectValueDeserializer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson/ObjectValueDeserializer.html) in the API documentation for details. The example above can be rewritten to use [`ObjectValueSerializer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson/ObjectValueSerializer.html) and [`ObjectValueDeserializer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson/ObjectValueDeserializer.html) as follows: * Java * Kotlin ```java import tools.jackson.core.JsonGenerator; import tools.jackson.core.JsonParser; import tools.jackson.databind.DeserializationContext; import tools.jackson.databind.JsonNode; import tools.jackson.databind.SerializationContext; import org.springframework.boot.jackson.JacksonComponent; import org.springframework.boot.jackson.ObjectValueDeserializer; import org.springframework.boot.jackson.ObjectValueSerializer; @JacksonComponent public class MyJacksonComponent { public static class Serializer extends ObjectValueSerializer { @Override protected void serializeObject(MyObject value, JsonGenerator jgen, SerializationContext context) { jgen.writeStringProperty("name", value.getName()); jgen.writeNumberProperty("age", value.getAge()); } } public static class Deserializer extends ObjectValueDeserializer { @Override protected MyObject deserializeObject(JsonParser jsonParser, DeserializationContext context, JsonNode tree) { String name = nullSafeValue(tree.get("name"), String.class); int age = nullSafeValue(tree.get("age"), Integer.class); return new MyObject(name, age); } } } ``` ```kotlin import tools.jackson.core.JsonGenerator import tools.jackson.core.JsonParser import tools.jackson.databind.DeserializationContext import tools.jackson.databind.JsonNode import tools.jackson.databind.SerializationContext import org.springframework.boot.jackson.JacksonComponent; import org.springframework.boot.jackson.ObjectValueDeserializer import org.springframework.boot.jackson.ObjectValueSerializer @JacksonComponent class MyJacksonComponent { class Serializer : ObjectValueSerializer() { override fun serializeObject(value: MyObject, jgen: JsonGenerator, context: SerializationContext) { jgen.writeStringProperty("name", value.name) jgen.writeNumberProperty("age", value.age) } } class Deserializer : ObjectValueDeserializer() { override fun deserializeObject(jsonParser: JsonParser, context: DeserializationContext, tree: JsonNode): MyObject { val name = nullSafeValue(tree["name"], String::class.java) ?: throw IllegalStateException("name is null") val age = nullSafeValue(tree["age"], Int::class.java) ?: throw IllegalStateException("age is null") return MyObject(name, age) } } } ``` ### [](#features.json.jackson.mixins)Mixins Jackson has support for mixins that can be used to mix additional annotations into those already declared on a target class. Spring Boot’s Jackson auto-configuration will scan your application’s packages for classes annotated with [`@JacksonMixin`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson/JacksonMixin.html) and register them with the auto-configured [`JsonMapper`](https://javadoc.io/doc/tools.jackson.core/jackson-databind/3.1.5/tools/jackson/databind/json/JsonMapper.html). The registration is performed by Spring Boot’s [`JacksonMixinModule`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson/JacksonMixinModule.html). ## [](#features.json.jackson2)Jackson 2 Deprecated auto-configuration for Jackson 2 is provided by the `spring-boot-jackson2` module. When this module is on the classpath a [`ObjectMapper`](https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-databind/2.21.5/com/fasterxml/jackson/databind/ObjectMapper.html) bean is automatically configured. Several `spring.jackson2.*` configuration properties are provided for customizing the configuration. To take more control, define one or more [`Jackson2ObjectMapperBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jackson2/autoconfigure/Jackson2ObjectMapperBuilderCustomizer.html) beans. When both Jackson 3 and Jackson 2 are present, various configuration properties can be used to indicate that Jackson 2 is preferred: * `spring.graphql.rsocket.preferred-json-mapper` * `spring.http.codecs.preferred-json-mapper` (used by Spring WebFlux and reactive HTTP clients) * `spring.http.converters.preferred-json-mapper` (used by Spring MVC and imperative HTTP clients) * `spring.rsocket.preferred-mapper` * `spring.websocket.messaging.preferred-json-mapper` In each case, set the relevant property to `jackson2` to indicate that Jackson 2 is preferred. ## [](#features.json.gson)Gson Auto-configuration for Gson is provided. When Gson is on the classpath a [`Gson`](https://javadoc.io/doc/com.google.code.gson/gson/2.13.2/com/google/gson/Gson.html) bean is automatically configured. Several `spring.gson.*` configuration properties are provided for customizing the configuration. To take more control, one or more [`GsonBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/gson/autoconfigure/GsonBuilderCustomizer.html) beans can be used. ## [](#features.json.json-b)JSON-B Auto-configuration for JSON-B is provided. When the JSON-B API and an implementation are on the classpath a [`Jsonb`](https://jakarta.ee/specifications/jsonb/3.0/apidocs/jakarta/json/bind/Jsonb.html) bean will be automatically configured. The preferred JSON-B implementation is Eclipse Yasson for which dependency management is provided. ## [](#features.json.kotlin-serialization)Kotlin Serialization Auto-configuration for Kotlin Serialization is provided. When `kotlinx-serialization-json` is on the classpath a [Json](https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/-json/) bean is automatically configured. Several `spring.kotlinx.serialization.json.*` configuration properties are provided for customizing the configuration. * [Spring Boot](../../index.html) * [4.1.1](json.html) * [4.0.8](../../4.0/reference/features/json.html) * [3.5.16](../../3.5/reference/features/json.html) * [3.4.13](../../3.4/reference/features/json.html) * [3.3.13](../../3.3/reference/features/json.html) - [4.2.0-M2](../../4.2/reference/features/json.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/features/json.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/features/json.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/features/json.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/how-to/data-access.html ---- # Data Access Spring Boot includes a number of starters for working with data sources. This section answers questions related to doing so. ## [](#howto.data-access.configure-custom-datasource)Configure a Custom DataSource To configure your own [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html), define a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) of that type in your configuration. Spring Boot reuses your [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) anywhere one is required, including database initialization. If you need to externalize some settings, you can bind your [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) to the environment (see [Third-party Configuration](../reference/features/external-config.html#features.external-config.typesafe-configuration-properties.third-party-configuration)). The following example shows how to define a data source in a bean: * Java * Kotlin ```java import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyDataSourceConfiguration { @Bean @ConfigurationProperties("app.datasource") public SomeDataSource dataSource() { return new SomeDataSource(); } } ``` ```kotlin import org.springframework.boot.context.properties.ConfigurationProperties import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyDataSourceConfiguration { @Bean @ConfigurationProperties("app.datasource") fun dataSource(): SomeDataSource { return SomeDataSource() } } ``` The following example shows how to define a data source by setting its properties: * Properties * YAML ```properties app.datasource.url=jdbc:h2:mem:mydb app.datasource.username=sa app.datasource.pool-size=30 ``` ```yaml app: datasource: url: "jdbc:h2:mem:mydb" username: "sa" pool-size: 30 ``` Assuming that `SomeDataSource` has regular JavaBean properties for the URL, the username, and the pool size, these settings are bound automatically before the [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) is made available to other components. Spring Boot also provides a utility builder class, called [`DataSourceBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/DataSourceBuilder.html), that can be used to create one of the standard data sources (if it is on the classpath). The builder can detect which one to use based on what is available on the classpath. It also auto-detects the driver based on the JDBC URL. The following example shows how to create a data source by using a [`DataSourceBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/DataSourceBuilder.html): * Java * Kotlin ```java import javax.sql.DataSource; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.jdbc.DataSourceBuilder; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyDataSourceConfiguration { @Bean @ConfigurationProperties("app.datasource") public DataSource dataSource() { return DataSourceBuilder.create().build(); } } ``` ```kotlin import javax.sql.DataSource import org.springframework.boot.context.properties.ConfigurationProperties import org.springframework.boot.jdbc.DataSourceBuilder import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyDataSourceConfiguration { @Bean @ConfigurationProperties("app.datasource") fun dataSource(): DataSource { return DataSourceBuilder.create().build() } } ``` To run an app with that [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html), all you need is the connection information. Pool-specific settings can also be provided. Check the implementation that is going to be used at runtime for more details. The following example shows how to define a JDBC data source by setting properties: * Properties * YAML ```properties app.datasource.url=jdbc:mysql://localhost/test app.datasource.username=dbuser app.datasource.password=dbpass app.datasource.pool-size=30 ``` ```yaml app: datasource: url: "jdbc:mysql://localhost/test" username: "dbuser" password: "dbpass" pool-size: 30 ``` However, there is a catch due to the method’s [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) return type. This hides the actual type of the connection pool so no configuration property metadata is generated for your custom [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) and no auto-completion is available in your IDE. To address this problem, use the builder’s `type(Class)` method to specify the type of [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) to be built and update the method’s return type. For example, the following shows how to create a [`HikariDataSource`](https://javadoc.io/doc/com.zaxxer/HikariCP/7.0.2/com.zaxxer.hikari/com/zaxxer/hikari/HikariDataSource.html) with [`DataSourceBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/DataSourceBuilder.html): * Java * Kotlin ```java import com.zaxxer.hikari.HikariDataSource; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.jdbc.DataSourceBuilder; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyDataSourceConfiguration { @Bean @ConfigurationProperties("app.datasource") public HikariDataSource dataSource() { return DataSourceBuilder.create().type(HikariDataSource.class).build(); } } ``` ```kotlin import com.zaxxer.hikari.HikariDataSource import org.springframework.boot.context.properties.ConfigurationProperties import org.springframework.boot.jdbc.DataSourceBuilder import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyDataSourceConfiguration { @Bean @ConfigurationProperties("app.datasource") fun dataSource(): HikariDataSource { return DataSourceBuilder.create().type(HikariDataSource::class.java).build() } } ``` Unfortunately, this basic setup does not work because Hikari has no `url` property. Instead, it has a `jdbc-url` property which means that you must rewrite your configuration as follows: * Properties * YAML ```properties app.datasource.jdbc-url=jdbc:mysql://localhost/test app.datasource.username=dbuser app.datasource.password=dbpass app.datasource.pool-size=30 ``` ```yaml app: datasource: jdbc-url: "jdbc:mysql://localhost/test" username: "dbuser" password: "dbpass" pool-size: 30 ``` To address this problem, make use of [`DataSourceProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/autoconfigure/DataSourceProperties.html) which will handle the `url` to `jdbc-url` translation for you. You can initialize a [`DataSourceBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/DataSourceBuilder.html) from the state of any [`DataSourceProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/autoconfigure/DataSourceProperties.html) object using its `initializeDataSourceBuilder()` method. You could inject the [`DataSourceProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/autoconfigure/DataSourceProperties.html) that Spring Boot creates automatically, however, that would split your configuration across `spring.datasource.*` and `app.datasource.*`. To avoid this, define a custom [`DataSourceProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/autoconfigure/DataSourceProperties.html) with a custom configuration properties prefix, as shown in the following example: * Java * Kotlin ```java import com.zaxxer.hikari.HikariDataSource; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.jdbc.autoconfigure.DataSourceProperties; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Primary; @Configuration(proxyBeanMethods = false) public class MyDataSourceConfiguration { @Bean @Primary @ConfigurationProperties("app.datasource") public DataSourceProperties dataSourceProperties() { return new DataSourceProperties(); } @Bean @ConfigurationProperties("app.datasource.configuration") public HikariDataSource dataSource(DataSourceProperties properties) { return properties.initializeDataSourceBuilder().type(HikariDataSource.class).build(); } } ``` ```kotlin import com.zaxxer.hikari.HikariDataSource import org.springframework.boot.context.properties.ConfigurationProperties import org.springframework.boot.jdbc.autoconfigure.DataSourceProperties import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.context.annotation.Primary @Configuration(proxyBeanMethods = false) class MyDataSourceConfiguration { @Bean @Primary @ConfigurationProperties("app.datasource") fun dataSourceProperties(): DataSourceProperties { return DataSourceProperties() } @Bean @ConfigurationProperties("app.datasource.configuration") fun dataSource(properties: DataSourceProperties): HikariDataSource { return properties.initializeDataSourceBuilder().type(HikariDataSource::class.java).build() } } ``` This setup is equivalent to what Spring Boot does for you by default, except that the pool’s type is specified in code and its settings are exposed as `app.datasource.configuration.*` properties. [`DataSourceProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/autoconfigure/DataSourceProperties.html) takes care of the `url` to `jdbc-url` translation, so you can configure it as follows: * Properties * YAML ```properties app.datasource.url=jdbc:mysql://localhost/test app.datasource.username=dbuser app.datasource.password=dbpass app.datasource.configuration.maximum-pool-size=30 ``` ```yaml app: datasource: url: "jdbc:mysql://localhost/test" username: "dbuser" password: "dbpass" configuration: maximum-pool-size: 30 ``` Note that, as the custom configuration specifies in code that Hikari should be used, `app.datasource.type` will have no effect. As described in [Supported Connection Pools](../reference/data/sql.html#data.sql.datasource.connection-pool), [`DataSourceBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/DataSourceBuilder.html) supports several different connection pools. To use a pool other than Hikari, add it to the classpath, use the `type(Class)` method to specify the pool class to use, and update the [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) method’s return type to match. This will also provide you with configuration property metadata for the specific connection pool that you’ve chosen. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Spring Boot will expose Hikari-specific settings to `spring.datasource.hikari`. This example uses a more generic `configuration` sub namespace as the example does not support multiple datasource implementations. | See [Configure a DataSource](../reference/data/sql.html#data.sql.datasource) and the [`DataSourceAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-jdbc/src/main/java/org/springframework/boot/jdbc/autoconfigure/DataSourceAutoConfiguration.java) class for more details. ## [](#howto.data-access.configure-two-datasources)Configure Two DataSources To define an additional [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html), an approach that’s similar to the previous section can be used. A key difference is that the [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) must be declared with `defaultCandidate=false`. This prevents the auto-configured [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) from backing off. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The [Spring Framework reference documentation](https://docs.spring.io/spring-framework/reference/7.0/core/beans/dependencies/factory-autowire.html#beans-factory-autowire-candidate) describes this feature in more details. | To allow the additional [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) to be injected where it’s needed, also annotate it with [`@Qualifier`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Qualifier.html) as shown in the following example: * Java * Kotlin ```java import com.zaxxer.hikari.HikariDataSource; import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.jdbc.DataSourceBuilder; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyAdditionalDataSourceConfiguration { @Qualifier("second") @Bean(defaultCandidate = false) @ConfigurationProperties("app.datasource") public HikariDataSource secondDataSource() { return DataSourceBuilder.create().type(HikariDataSource.class).build(); } } ``` ```kotlin import com.zaxxer.hikari.HikariDataSource import org.springframework.beans.factory.annotation.Qualifier import org.springframework.boot.context.properties.ConfigurationProperties import org.springframework.boot.jdbc.DataSourceBuilder import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyAdditionalDataSourceConfiguration { @Qualifier("second") @Bean(defaultCandidate = false) @ConfigurationProperties("app.datasource") fun secondDataSource(): HikariDataSource { return DataSourceBuilder.create().type(HikariDataSource::class.java).build() } } ``` To consume the additional [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html), annotate the injection point with the same [`@Qualifier`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Qualifier.html). The auto-configured and additional data sources can be configured as follows: * Properties * YAML ```properties spring.datasource.url=jdbc:mysql://localhost/first spring.datasource.username=dbuser spring.datasource.password=dbpass spring.datasource.configuration.maximum-pool-size=30 app.datasource.url=jdbc:mysql://localhost/second app.datasource.username=dbuser app.datasource.password=dbpass app.datasource.max-total=30 ``` ```yaml spring: datasource: url: "jdbc:mysql://localhost/first" username: "dbuser" password: "dbpass" configuration: maximum-pool-size: 30 app: datasource: url: "jdbc:mysql://localhost/second" username: "dbuser" password: "dbpass" max-total: 30 ``` More advanced, implementation-specific, configuration of the auto-configured [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) is available through the `spring.datasource.configuration.*` properties. You can apply the same concept to the additional [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) as well, as shown in the following example: * Java * Kotlin ```java import com.zaxxer.hikari.HikariDataSource; import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.jdbc.autoconfigure.DataSourceProperties; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyCompleteAdditionalDataSourceConfiguration { @Qualifier("second") @Bean(defaultCandidate = false) @ConfigurationProperties("app.datasource") public DataSourceProperties secondDataSourceProperties() { return new DataSourceProperties(); } @Qualifier("second") @Bean(defaultCandidate = false) @ConfigurationProperties("app.datasource.configuration") public HikariDataSource secondDataSource(@Qualifier("second") DataSourceProperties dataSourceProperties) { return dataSourceProperties.initializeDataSourceBuilder().type(HikariDataSource.class).build(); } } ``` ```kotlin import com.zaxxer.hikari.HikariDataSource import org.springframework.beans.factory.annotation.Qualifier import org.springframework.boot.context.properties.ConfigurationProperties import org.springframework.boot.jdbc.autoconfigure.DataSourceProperties import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyCompleteAdditionalDataSourceConfiguration { @Qualifier("second") @Bean(defaultCandidate = false) @ConfigurationProperties("app.datasource") fun secondDataSourceProperties(): DataSourceProperties { return DataSourceProperties() } @Qualifier("second") @Bean(defaultCandidate = false) @ConfigurationProperties("app.datasource.configuration") fun secondDataSource(@Qualifier("second") dataSourceProperties: DataSourceProperties): HikariDataSource { return dataSourceProperties.initializeDataSourceBuilder().type(HikariDataSource::class.java).build() } } ``` The preceding example configures the additional data source with the same logic as Spring Boot would use in auto-configuration. Note that the `app.datasource.configuration.*` properties provide advanced settings based on the chosen implementation. As with [configuring a single custom ](#howto.data-access.configure-custom-datasource)[`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html), the type of one or both of the [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) beans can be customized using the `type(Class)` method on [`DataSourceBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jdbc/DataSourceBuilder.html). See [Supported Connection Pools](../reference/data/sql.html#data.sql.datasource.connection-pool) for details of the supported types. ## [](#howto.data-access.spring-data-repositories)Use Spring Data Repositories Spring Data can create implementations of [`Repository`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/Repository.html) interfaces of various flavors. Spring Boot handles all of that for you, as long as those [`Repository`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/Repository.html) implementations are included in one of the [auto-configuration packages](../reference/using/auto-configuration.html#using.auto-configuration.packages), typically the package (or a sub-package) of your main application class that is annotated with [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html) or [`@EnableAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/EnableAutoConfiguration.html). For many applications, all you need is to put the right Spring Data dependencies on your classpath. There is a `spring-boot-starter-data-jpa` for JPA, `spring-boot-starter-data-mongodb` for Mongodb, and various other starters for supported technologies. To get started, create some repository interfaces to handle your [`@Entity`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/Entity.html) objects. Spring Boot determines the location of your [`Repository`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/Repository.html) implementations by scanning the [auto-configuration packages](../reference/using/auto-configuration.html#using.auto-configuration.packages). For more control, use the `@Enable…Repositories` annotations from Spring Data. For more about Spring Data, see the [Spring Data project page](https://spring.io/projects/spring-data). ## [](#howto.data-access.separate-entity-definitions-from-spring-configuration)Separate @Entity Definitions from Spring Configuration Spring Boot determines the location of your [`@Entity`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/Entity.html) definitions by scanning the [auto-configuration packages](../reference/using/auto-configuration.html#using.auto-configuration.packages). For more control, use the [`@EntityScan`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/persistence/autoconfigure/EntityScan.html) annotation, as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.persistence.autoconfigure.EntityScan; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) @EnableAutoConfiguration @EntityScan(basePackageClasses = City.class) public class MyApplication { // ... } ``` ```kotlin import org.springframework.boot.autoconfigure.EnableAutoConfiguration import org.springframework.boot.persistence.autoconfigure.EntityScan import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) @EnableAutoConfiguration @EntityScan(basePackageClasses = [City::class]) class MyApplication { // ... } ``` ## [](#howto.data-access.filter-scanned-entity-definitions)Filter Scanned @Entity Definitions It is possible to filter the [`@Entity`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/Entity.html) definitions using a [`ManagedClassNameFilter`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/orm/jpa/persistenceunit/ManagedClassNameFilter.html) bean. This can be useful in tests when only a sub-set of the available entities should be considered. In the following example, only entities from the `com.example.app.customer` package are included: * Java * Kotlin ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.orm.jpa.persistenceunit.ManagedClassNameFilter; @Configuration(proxyBeanMethods = false) public class MyEntityScanConfiguration { @Bean public ManagedClassNameFilter entityScanFilter() { return (className) -> className.startsWith("com.example.app.customer."); } } ``` ```kotlin import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.orm.jpa.persistenceunit.ManagedClassNameFilter @Configuration(proxyBeanMethods = false) class MyEntityScanConfiguration { @Bean fun entityScanFilter() : ManagedClassNameFilter { return ManagedClassNameFilter { className -> className.startsWith("com.example.app.customer.") } } } ``` ## [](#howto.data-access.jpa-properties)Configure JPA Properties Spring Data JPA already provides some vendor-independent configuration options (such as those for SQL logging), and Spring Boot exposes those options and a few more for Hibernate as external configuration properties. Some of them are automatically detected according to the context so you should not have to set them. The `spring.jpa.hibernate.ddl-auto` is a special case, because, depending on runtime conditions, it has different defaults. If an embedded database is used and no schema manager (such as Liquibase or Flyway) is handling the [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html), it defaults to `create-drop`. In all other cases, it defaults to `none`. The dialect to use is detected by the JPA provider. If you prefer to set the dialect yourself, set the `spring.jpa.database-platform` property. The most common options to set are shown in the following example: * Properties * YAML ```properties spring.jpa.hibernate.naming.physical-strategy=com.example.MyPhysicalNamingStrategy spring.jpa.show-sql=true ``` ```yaml spring: jpa: hibernate: naming: physical-strategy: "com.example.MyPhysicalNamingStrategy" show-sql: true ``` In addition, all properties in `spring.jpa.properties.*` are passed through as normal JPA properties (with the prefix stripped) when the local [`EntityManagerFactory`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/EntityManagerFactory.html) is created. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You need to ensure that names defined under `spring.jpa.properties.*` exactly match those expected by your JPA provider. Spring Boot will not attempt any kind of relaxed binding for these entries.For example, if you want to configure Hibernate’s batch size you must use `spring.jpa.properties.hibernate.jdbc.batch_size`. If you use other forms, such as `batchSize` or `batch-size`, Hibernate will not apply the setting. | | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you need to apply advanced customization to Hibernate properties, consider registering a [`HibernatePropertiesCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/hibernate/autoconfigure/HibernatePropertiesCustomizer.html) bean that will be invoked prior to creating the [`EntityManagerFactory`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/EntityManagerFactory.html). This takes precedence over anything that is applied by the auto-configuration. | ## [](#howto.data-access.configure-hibernate-naming-strategy)Configure Hibernate Naming Strategy Hibernate uses [two different naming strategies](https://docs.jboss.org/hibernate/orm/7.4/userguide/html_single/Hibernate_User_Guide.html#naming) to map names from the object model to the corresponding database names. The fully qualified class name of the physical and the implicit strategy implementations can be configured by setting the `spring.jpa.hibernate.naming.physical-strategy` and `spring.jpa.hibernate.naming.implicit-strategy` properties, respectively. Alternatively, if [`ImplicitNamingStrategy`](https://docs.jboss.org/hibernate/orm/7.4/javadocs/org/hibernate/boot/model/naming/ImplicitNamingStrategy.html) or [`PhysicalNamingStrategy`](https://docs.jboss.org/hibernate/orm/7.4/javadocs/org/hibernate/boot/model/naming/PhysicalNamingStrategy.html) beans are available in the application context, Hibernate will be automatically configured to use them. By default, Spring Boot configures the physical naming strategy with [`CamelCaseToUnderscoresNamingStrategy`](https://docs.jboss.org/hibernate/orm/7.4/javadocs/org/hibernate/boot/model/naming/CamelCaseToUnderscoresNamingStrategy.html). Using this strategy, all dots are replaced by underscores and camel casing is replaced by underscores as well. Additionally, by default, all table names are generated in lower case. For example, a `TelephoneNumber` entity is mapped to the `telephone_number` table. If your schema requires mixed-case identifiers, define a custom [`CamelCaseToUnderscoresNamingStrategy`](https://docs.jboss.org/hibernate/orm/7.4/javadocs/org/hibernate/boot/model/naming/CamelCaseToUnderscoresNamingStrategy.html) bean, as shown in the following example: * Java * Kotlin ```java import org.hibernate.boot.model.naming.Identifier; import org.hibernate.boot.model.naming.PhysicalNamingStrategySnakeCaseImpl; import org.hibernate.engine.jdbc.env.spi.JdbcEnvironment; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyHibernateConfiguration { @Bean public PhysicalNamingStrategySnakeCaseImpl caseSensitivePhysicalNamingStrategy() { return new PhysicalNamingStrategySnakeCaseImpl() { @Override public Identifier toPhysicalColumnName(Identifier logicalName, JdbcEnvironment jdbcEnvironment) { return logicalName; } }; } } ``` ```kotlin import org.hibernate.boot.model.naming.Identifier import org.hibernate.boot.model.naming.PhysicalNamingStrategySnakeCaseImpl import org.hibernate.engine.jdbc.env.spi.JdbcEnvironment import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyHibernateConfiguration { @Bean fun caseSensitivePhysicalNamingStrategy(): PhysicalNamingStrategySnakeCaseImpl { return object : PhysicalNamingStrategySnakeCaseImpl() { override fun toPhysicalColumnName(logicalName: Identifier, jdbcEnvironment: JdbcEnvironment): Identifier { return logicalName } } } } ``` If you prefer to use Hibernate’s default instead, set the following property: * Properties * YAML ```properties spring.jpa.hibernate.naming.physical-strategy=org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl ``` ```yaml spring: jpa: hibernate: naming: physical-strategy: org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl ``` Alternatively, you can configure the following bean: * Java * Kotlin ```java import org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) class MyHibernateConfiguration { @Bean PhysicalNamingStrategyStandardImpl caseSensitivePhysicalNamingStrategy() { return new PhysicalNamingStrategyStandardImpl(); } } ``` ```kotlin import org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) internal class MyHibernateConfiguration { @Bean fun caseSensitivePhysicalNamingStrategy(): PhysicalNamingStrategyStandardImpl { return PhysicalNamingStrategyStandardImpl() } } ``` See [`HibernateJpaAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-hibernate/src/main/java/org/springframework/boot/hibernate/autoconfigure/HibernateJpaAutoConfiguration.java) and [`JpaBaseConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-jpa/src/main/java/org/springframework/boot/jpa/autoconfigure/JpaBaseConfiguration.java) for more details. ## [](#howto.data-access.configure-hibernate-second-level-caching)Configure Hibernate Second-Level Caching Hibernate [second-level cache](https://docs.jboss.org/hibernate/orm/7.4/userguide/html_single/Hibernate_User_Guide.html#caching) can be configured for a range of cache providers. Rather than configuring Hibernate to lookup the cache provider again, it is better to provide the one that is available in the context whenever possible. To do this with JCache, first make sure that `org.hibernate.orm:hibernate-jcache` is available on the classpath. Then, add a [`HibernatePropertiesCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/hibernate/autoconfigure/HibernatePropertiesCustomizer.html) bean as shown in the following example: * Java * Kotlin ```java import org.hibernate.cache.jcache.ConfigSettings; import org.springframework.boot.hibernate.autoconfigure.HibernatePropertiesCustomizer; import org.springframework.cache.jcache.JCacheCacheManager; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyHibernateSecondLevelCacheConfiguration { @Bean public HibernatePropertiesCustomizer hibernateSecondLevelCacheCustomizer(JCacheCacheManager cacheManager) { return (properties) -> properties.put(ConfigSettings.CACHE_MANAGER, cacheManager.getCacheManager()); } } ``` ```kotlin import org.hibernate.cache.jcache.ConfigSettings import org.springframework.boot.hibernate.autoconfigure.HibernatePropertiesCustomizer import org.springframework.cache.jcache.JCacheCacheManager import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyHibernateSecondLevelCacheConfiguration { @Bean fun hibernateSecondLevelCacheCustomizer(cacheManager: JCacheCacheManager): HibernatePropertiesCustomizer { return HibernatePropertiesCustomizer { properties -> val cacheManager = cacheManager.cacheManager if (cacheManager != null) { properties[ConfigSettings.CACHE_MANAGER] = cacheManager } } } } ``` This customizer will configure Hibernate to use the same [`CacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/CacheManager.html) as the one that the application uses. It is also possible to use separate [`CacheManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/cache/CacheManager.html) instances. For details, see [the Hibernate user guide](https://docs.jboss.org/hibernate/orm/7.4/userguide/html_single/Hibernate_User_Guide.html#caching-provider-jcache). ## [](#howto.data-access.dependency-injection-in-hibernate-components)Use Dependency Injection in Hibernate Components By default, Spring Boot registers a [`BeanContainer`](https://docs.jboss.org/hibernate/orm/7.4/javadocs/org/hibernate/resource/beans/container/spi/BeanContainer.html) implementation that uses the [`BeanFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/BeanFactory.html) so that converters and entity listeners can use regular dependency injection. You can disable or tune this behavior by registering a [`HibernatePropertiesCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/hibernate/autoconfigure/HibernatePropertiesCustomizer.html) that removes or changes the `hibernate.resource.beans.container` property. ## [](#howto.data-access.use-custom-entity-manager)Use a Custom EntityManagerFactory To take full control of the configuration of the [`EntityManagerFactory`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/EntityManagerFactory.html), you need to add a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) named ‘entityManagerFactory’. Spring Boot auto-configuration switches off its entity manager in the presence of a bean of that type. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | When you create a bean for [`LocalContainerEntityManagerFactoryBean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/orm/jpa/LocalContainerEntityManagerFactoryBean.html) yourself, any customization that was applied during the creation of the auto-configured [`LocalContainerEntityManagerFactoryBean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/orm/jpa/LocalContainerEntityManagerFactoryBean.html) is lost. Make sure to use the auto-configured [`EntityManagerFactoryBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jpa/EntityManagerFactoryBuilder.html) to retain JPA and vendor properties. This is particularly important if you were relying on `spring.jpa.*` properties for configuring things like the naming strategy or the DDL mode. | ## [](#howto.data-access.use-multiple-entity-managers)Using Multiple EntityManagerFactories If you need to use JPA against multiple datasources, you likely need one [`EntityManagerFactory`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/EntityManagerFactory.html) per datasource. The [`LocalContainerEntityManagerFactoryBean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/orm/jpa/LocalContainerEntityManagerFactoryBean.html) from Spring ORM allows you to configure an [`EntityManagerFactory`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/EntityManagerFactory.html) for your needs. You can also reuse [`JpaProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jpa/autoconfigure/JpaProperties.html) to bind settings for a second [`EntityManagerFactory`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/EntityManagerFactory.html). Building upon [the example for configuring a second ](#howto.data-access.configure-two-datasources)[`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html), a second [`EntityManagerFactory`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/EntityManagerFactory.html) can be defined as shown in the following example: * Java * Kotlin ```java import java.util.LinkedHashMap; import java.util.Map; import java.util.function.Function; import javax.sql.DataSource; import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.jpa.EntityManagerFactoryBuilder; import org.springframework.boot.jpa.autoconfigure.JpaProperties; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.orm.jpa.JpaVendorAdapter; import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean; import org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter; @Configuration(proxyBeanMethods = false) public class MyAdditionalEntityManagerFactoryConfiguration { @Qualifier("second") @Bean(defaultCandidate = false) @ConfigurationProperties("app.jpa") public JpaProperties secondJpaProperties() { return new JpaProperties(); } @Qualifier("second") @Bean(defaultCandidate = false) public LocalContainerEntityManagerFactoryBean secondEntityManagerFactory(@Qualifier("second") DataSource dataSource, @Qualifier("second") JpaProperties jpaProperties) { EntityManagerFactoryBuilder builder = createEntityManagerFactoryBuilder(jpaProperties); return builder.dataSource(dataSource).packages(Order.class).persistenceUnit("second").build(); } private EntityManagerFactoryBuilder createEntityManagerFactoryBuilder(JpaProperties jpaProperties) { JpaVendorAdapter jpaVendorAdapter = createJpaVendorAdapter(jpaProperties); Function> jpaPropertiesFactory = (dataSource) -> createJpaProperties(dataSource, jpaProperties.getProperties()); return new EntityManagerFactoryBuilder(jpaVendorAdapter, jpaPropertiesFactory, null); } private JpaVendorAdapter createJpaVendorAdapter(JpaProperties jpaProperties) { // ... map JPA properties as needed return new HibernateJpaVendorAdapter(); } private Map createJpaProperties(DataSource dataSource, Map existingProperties) { Map jpaProperties = new LinkedHashMap<>(existingProperties); // ... map JPA properties that require the DataSource (e.g. DDL flags) return jpaProperties; } } ``` ```kotlin import org.springframework.beans.factory.annotation.Qualifier import org.springframework.boot.context.properties.ConfigurationProperties import org.springframework.boot.jpa.EntityManagerFactoryBuilder import org.springframework.boot.jpa.autoconfigure.JpaProperties import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.orm.jpa.JpaVendorAdapter import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean import org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter import javax.sql.DataSource @Configuration(proxyBeanMethods = false) class MyAdditionalEntityManagerFactoryConfiguration { @Qualifier("second") @Bean(defaultCandidate = false) @ConfigurationProperties("app.jpa") fun secondJpaProperties(): JpaProperties { return JpaProperties() } @Qualifier("second") @Bean(defaultCandidate = false) fun secondEntityManagerFactory( @Qualifier("second") dataSource: DataSource, @Qualifier("second") jpaProperties: JpaProperties ): LocalContainerEntityManagerFactoryBean { val builder = createEntityManagerFactoryBuilder(jpaProperties) return builder.dataSource(dataSource).packages(Order::class.java).persistenceUnit("second").build() } private fun createEntityManagerFactoryBuilder(jpaProperties: JpaProperties): EntityManagerFactoryBuilder { val jpaVendorAdapter = createJpaVendorAdapter(jpaProperties) val jpaPropertiesFactory = { dataSource: DataSource -> createJpaProperties(dataSource, jpaProperties.properties) } return EntityManagerFactoryBuilder(jpaVendorAdapter, jpaPropertiesFactory, null) } private fun createJpaVendorAdapter(jpaProperties: JpaProperties): JpaVendorAdapter { // ... map JPA properties as needed return HibernateJpaVendorAdapter() } private fun createJpaProperties(dataSource: DataSource, existingProperties: Map): Map { val jpaProperties: Map = LinkedHashMap(existingProperties) // ... map JPA properties that require the DataSource (e.g. DDL flags) return jpaProperties } } ``` The example above creates an [`EntityManagerFactory`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/EntityManagerFactory.html) using the [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) bean qualified with `@Qualifier("second")`. It scans entities located in the same package as `Order`. It is possible to map additional JPA properties using the `app.jpa` namespace. The use of `@Bean(defaultCandidate=false)` allows the `secondJpaProperties` and `secondEntityManagerFactory` beans to be defined without interfering with auto-configured beans of the same type. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The [Spring Framework reference documentation](https://docs.spring.io/spring-framework/reference/7.0/core/beans/dependencies/factory-autowire.html#beans-factory-autowire-candidate) describes this feature in more details. | You should provide a similar configuration for any more additional data sources for which you need JPA access. To complete the picture, you need to configure a [`JpaTransactionManager`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/orm/jpa/JpaTransactionManager.html) for each [`EntityManagerFactory`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/EntityManagerFactory.html) as well. Alternatively, you might be able to use a JTA transaction manager that spans both. If you use Spring Data, you need to configure [`@EnableJpaRepositories`](https://docs.spring.io/spring-data/jpa/docs/4.1.x/api/org/springframework/data/jpa/repository/config/EnableJpaRepositories.html) accordingly, as shown in the following examples: * Java * Kotlin ```java import org.springframework.context.annotation.Configuration; import org.springframework.data.jpa.repository.config.EnableJpaRepositories; @Configuration(proxyBeanMethods = false) @EnableJpaRepositories(basePackageClasses = Order.class, entityManagerFactoryRef = "entityManagerFactory") public class OrderConfiguration { } ``` ```kotlin import org.springframework.context.annotation.Configuration import org.springframework.data.jpa.repository.config.EnableJpaRepositories @Configuration(proxyBeanMethods = false) @EnableJpaRepositories(basePackageClasses = [Order::class], entityManagerFactoryRef = "entityManagerFactory") class OrderConfiguration ``` * Java * Kotlin ```java import org.springframework.context.annotation.Configuration; import org.springframework.data.jpa.repository.config.EnableJpaRepositories; @Configuration(proxyBeanMethods = false) @EnableJpaRepositories(basePackageClasses = Customer.class, entityManagerFactoryRef = "secondEntityManagerFactory") public class CustomerConfiguration { } ``` ```kotlin import org.springframework.context.annotation.Configuration import org.springframework.data.jpa.repository.config.EnableJpaRepositories @Configuration(proxyBeanMethods = false) @EnableJpaRepositories(basePackageClasses = [Customer::class], entityManagerFactoryRef = "secondEntityManagerFactory") class CustomerConfiguration ``` ## [](#howto.data-access.use-traditional-persistence-xml)Use a Traditional persistence.xml File Spring Boot will not search for or use a `META-INF/persistence.xml` by default. If you prefer to use a traditional `persistence.xml`, you need to define your own [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) of type [`LocalEntityManagerFactoryBean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/orm/jpa/LocalEntityManagerFactoryBean.html) (with an ID of ‘entityManagerFactory’) and set the persistence unit name there. See [`JpaBaseConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-jpa/src/main/java/org/springframework/boot/jpa/autoconfigure/JpaBaseConfiguration.java) for the default settings. ## [](#howto.data-access.use-spring-data-jpa-and-mongo-repositories)Use Spring Data JPA and Mongo Repositories Spring Data JPA and Spring Data Mongo can both automatically create [`Repository`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/Repository.html) implementations for you. If they are both present on the classpath, you might have to do some extra configuration to tell Spring Boot which repositories to create. The most explicit way to do that is to use the standard Spring Data [`@EnableJpaRepositories`](https://docs.spring.io/spring-data/jpa/docs/4.1.x/api/org/springframework/data/jpa/repository/config/EnableJpaRepositories.html) and [`@EnableMongoRepositories`](https://docs.spring.io/spring-data/mongodb/docs/5.1.x/api/org/springframework/data/mongodb/repository/config/EnableMongoRepositories.html) annotations and provide the location of your [`Repository`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/Repository.html) interfaces. There are also flags (`spring.data.*.repositories.enabled` and `spring.data.*.repositories.type`) that you can use to switch the auto-configured repositories on and off in external configuration. Doing so is useful, for instance, in case you want to switch off the Mongo repositories and still use the auto-configured [`MongoTemplate`](https://docs.spring.io/spring-data/mongodb/docs/5.1.x/api/org/springframework/data/mongodb/core/MongoTemplate.html). The same obstacle and the same features exist for other auto-configured Spring Data repository types (Elasticsearch, Redis, and others). To work with them, change the names of the annotations and flags accordingly. ## [](#howto.data-access.customize-spring-data-web-support)Customize Spring Data’s Web Support Spring Data provides web support that simplifies the use of Spring Data repositories in a web application. Spring Boot provides properties in the `spring.data.web` namespace for customizing its configuration. Note that if you are using Spring Data REST, you must use the properties in the `spring.data.rest` namespace instead. ## [](#howto.data-access.exposing-spring-data-repositories-as-rest)Expose Spring Data Repositories as REST Endpoint Spring Data REST can expose the [`Repository`](https://docs.spring.io/spring-data/commons/docs/4.1.x/api/org/springframework/data/repository/Repository.html) implementations as REST endpoints for you, provided Spring MVC has been enabled for the application. Spring Boot exposes a set of useful properties (from the `spring.data.rest` namespace) that customize the [`RepositoryRestConfiguration`](https://docs.spring.io/spring-data/rest/docs/5.1.x/api/org/springframework/data/rest/core/config/RepositoryRestConfiguration.html). If you need to provide additional customization, you should use a [`RepositoryRestConfigurer`](https://docs.spring.io/spring-data/rest/docs/5.1.x/api/org/springframework/data/rest/webmvc/config/RepositoryRestConfigurer.html) bean. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you do not specify any order on your custom [`RepositoryRestConfigurer`](https://docs.spring.io/spring-data/rest/docs/5.1.x/api/org/springframework/data/rest/webmvc/config/RepositoryRestConfigurer.html), it runs after the one Spring Boot uses internally. If you need to specify an order, make sure it is higher than 0. | ## [](#howto.data-access.configure-a-component-that-is-used-by-jpa)Configure a Component that is Used by JPA If you want to configure a component that JPA uses, then you need to ensure that the component is initialized before JPA. When the component is auto-configured, Spring Boot takes care of this for you. For example, when Flyway is auto-configured, Hibernate is configured to depend on Flyway so that Flyway has a chance to initialize the database before Hibernate tries to use it. If you are configuring a component yourself, you can use an [`EntityManagerFactoryDependsOnPostProcessor`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jpa/autoconfigure/EntityManagerFactoryDependsOnPostProcessor.html) subclass as a convenient way of setting up the necessary dependencies. For example, if you use Hibernate Search with Elasticsearch as its index manager, any [`EntityManagerFactory`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/EntityManagerFactory.html) beans must be configured to depend on the `elasticsearchClient` bean, as shown in the following example: * Java * Kotlin ```java import jakarta.persistence.EntityManagerFactory; import org.springframework.boot.jpa.autoconfigure.EntityManagerFactoryDependsOnPostProcessor; import org.springframework.stereotype.Component; /** * {@link EntityManagerFactoryDependsOnPostProcessor} that ensures that * {@link EntityManagerFactory} beans depend on the {@code elasticsearchClient} bean. */ @Component public class ElasticsearchEntityManagerFactoryDependsOnPostProcessor extends EntityManagerFactoryDependsOnPostProcessor { public ElasticsearchEntityManagerFactoryDependsOnPostProcessor() { super("elasticsearchClient"); } } ``` ```kotlin import org.springframework.boot.jpa.autoconfigure.EntityManagerFactoryDependsOnPostProcessor import org.springframework.stereotype.Component @Component class ElasticsearchEntityManagerFactoryDependsOnPostProcessor : EntityManagerFactoryDependsOnPostProcessor("elasticsearchClient") ``` ## [](#howto.data-access.configure-jooq-with-multiple-datasources)Configure jOOQ with Two DataSources If you need to use jOOQ with multiple data sources, you should create your own [`DSLContext`](https://www.jooq.org/javadoc/3.21.7/org/jooq/DSLContext.html) for each one. See [`JooqAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-jooq/src/main/java/org/springframework/boot/jooq/autoconfigure/JooqAutoConfiguration.java) for more details. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | In particular, [`ExceptionTranslatorExecuteListener`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jooq/autoconfigure/ExceptionTranslatorExecuteListener.html) and [`SpringTransactionProvider`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/jooq/autoconfigure/SpringTransactionProvider.html) can be reused to provide similar features to what the auto-configuration does with a single [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html). | * [Spring Boot](../index.html) * [4.1.1](data-access.html) * [4.0.8](../4.0/how-to/data-access.html) * [3.5.16](../3.5/how-to/data-access.html) * [3.4.13](../3.4/how-to/data-access.html) * [3.3.13](../3.3/how-to/data-access.html) - [4.2.0-M2](../4.2/how-to/data-access.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/data-access.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/data-access.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/data-access.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/actuator/loggers.html ---- # Loggers Spring Boot Actuator includes the ability to view and configure the log levels of your application at runtime. You can view either the entire list or an individual logger’s configuration, which is made up of both the explicitly configured logging level as well as the effective logging level given to it by the logging framework. These levels can be one of: * `TRACE` * `DEBUG` * `INFO` * `WARN` * `ERROR` * `FATAL` * `OFF` * `null` `null` indicates that there is no explicit configuration. ## [](#actuator.loggers.configure)Configure a Logger To configure a given logger, `POST` a partial entity to the resource’s URI, as the following example shows: ```json { "configuredLevel": "DEBUG" } ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | To “reset” the specific level of the logger (and use the default configuration instead), you can pass a value of `null` as the `configuredLevel`. | ## [](#actuator.loggers.opentelemetry)OpenTelemetry By default, logging via OpenTelemetry is not configured. You have to provide the location of the OpenTelemetry logs endpoint to configure it: * Properties * YAML ```properties management.opentelemetry.logging.export.otlp.endpoint=https://otlp.example.com:4318/v1/logs ``` ```yaml management: opentelemetry: logging: export: otlp: endpoint: "https://otlp.example.com:4318/v1/logs" ``` The `management.opentelemetry.logging.export.*` configuration properties can be used to configure the [`BatchLogRecordProcessor`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-logs/1.62.0/io/opentelemetry/sdk/logs/export/BatchLogRecordProcessor.html). For example, to change the export interval to 15 seconds: * Properties * YAML ```properties management.opentelemetry.logging.export.schedule-delay=15s ``` ```yaml management: opentelemetry: logging: export: schedule-delay: "15s" ``` The `management.opentelemetry.logging.limits.*` configuration properties can be used to configure log record limits. For example, to limit the number of attributes per log record to 64 and the maximum attribute value length to 256 characters: * Properties * YAML ```properties management.opentelemetry.logging.limits.max-attributes=64 management.opentelemetry.logging.limits.max-attribute-value-length=256 ``` ```yaml management: opentelemetry: logging: limits: max-attributes: 64 max-attribute-value-length: 256 ``` If you need full control, you can register a custom [`LogLimits`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-logs/1.62.0/io/opentelemetry/sdk/logs/LogLimits.html) bean. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | The OpenTelemetry Logback appender and Log4j appender are not part of Spring Boot. For more details, see the [OpenTelemetry Logback appender](https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/logback/logback-appender-1.0/library) or the [OpenTelemetry Log4j2 appender](https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/log4j/log4j-appender-2.17/library) in the [OpenTelemetry Java instrumentation GitHub repository](https://github.com/open-telemetry/opentelemetry-java-instrumentation). | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------ | | ** | You have to configure the appender in your `logback-spring.xml` or `log4j2-spring.xml` configuration to get OpenTelemetry logging working. | The `OpenTelemetryAppender` for both Logback and Log4j requires access to an [`OpenTelemetry`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-api/1.62.0/io/opentelemetry/api/OpenTelemetry.html) instance to function properly. This instance must be set programmatically during application startup, which can be done like this: * Java * Kotlin ```java import io.opentelemetry.api.OpenTelemetry; import io.opentelemetry.instrumentation.logback.appender.v1_0.OpenTelemetryAppender; import org.springframework.beans.factory.InitializingBean; import org.springframework.stereotype.Component; @Component class OpenTelemetryAppenderInitializer implements InitializingBean { private final OpenTelemetry openTelemetry; OpenTelemetryAppenderInitializer(OpenTelemetry openTelemetry) { this.openTelemetry = openTelemetry; } @Override public void afterPropertiesSet() { OpenTelemetryAppender.install(this.openTelemetry); } } ``` ```kotlin import io.opentelemetry.api.OpenTelemetry import io.opentelemetry.instrumentation.logback.appender.v1_0.OpenTelemetryAppender import org.springframework.beans.factory.InitializingBean import org.springframework.stereotype.Component @Component class OpenTelemetryAppenderInitializer( private val openTelemetry: OpenTelemetry ) : InitializingBean { override fun afterPropertiesSet() = OpenTelemetryAppender.install(openTelemetry) } ``` * [Spring Boot](../../index.html) * [4.1.1](loggers.html) * [4.0.8](../../4.0/reference/actuator/loggers.html) * [3.5.16](../../3.5/reference/actuator/loggers.html) * [3.4.13](../../3.4/reference/actuator/loggers.html) * [3.3.13](../../3.3/reference/actuator/loggers.html) - [4.2.0-M2](../../4.2/reference/actuator/loggers.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/actuator/loggers.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/actuator/loggers.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/actuator/loggers.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/community.html ---- # Community If you have trouble with Spring Boot, we would like to help. * Try the [How-to documents](how-to/index.html). They provide solutions to the most common questions. * Learn the Spring basics. Spring Boot builds on many other Spring projects. Check the [spring.io](https://spring.io) web-site for a wealth of reference documentation. If you are starting out with Spring, try one of the [guides](https://spring.io/guides). * Ask a question. We monitor [stackoverflow.com](https://stackoverflow.com) for questions tagged with [`spring-boot`](https://stackoverflow.com/tags/spring-boot). * Report bugs with Spring Boot at [github.com/spring-projects/spring-boot/issues](https://github.com/spring-projects/spring-boot/issues). | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | All of Spring Boot is open source, including the documentation. If you find problems with the docs or if you want to improve them, please [get involved](https://github.com/spring-projects/spring-boot). | * [Spring Boot](index.html) * [4.1.1](community.html) * [4.0.8](4.0/community.html) * [3.5.16](3.5/community.html) * [3.4.13](3.4/community.html) * [3.3.13](3.3/community.html) - [4.2.0-M2](4.2/community.html) * [4.2.0-SNAPSHOT](4.2-SNAPSHOT/community.html) * [4.1.3-SNAPSHOT](4.1-SNAPSHOT/community.html) * [4.0.10-SNAPSHOT](4.0-SNAPSHOT/community.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/Include.html ---- # Class Include [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") [org.springframework.boot.maven.FilterableDependency](FilterableDependency.html "class in org.springframework.boot.maven") org.springframework.boot.maven.Include *** public class Include extends [FilterableDependency](FilterableDependency.html "class in org.springframework.boot.maven") A model for a dependency to include. `Include()`   - ## Method Summary ### Methods inherited from class [FilterableDependency](FilterableDependency.html#method-summary "class in org.springframework.boot.maven") `set` ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### Include public Include() ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/ProcessTestAotMojo.html ---- Uses of Class\ org.springframework.boot.maven.ProcessTestAotMojo ================================================= No usage of org.springframework.boot.maven.ProcessTestAotMojo ---- url: https://docs.spring.io/spring-boot/reference/testing/test-utilities.html ---- # Test Utilities A few test utility classes that are generally useful when testing your application are packaged as part of `spring-boot`. ## [](#testing.utilities.config-data-application-context-initializer)ConfigDataApplicationContextInitializer [`ConfigDataApplicationContextInitializer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/ConfigDataApplicationContextInitializer.html) is an [`ApplicationContextInitializer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContextInitializer.html) that you can apply to your tests to load Spring Boot `application.properties` files. You can use it when you do not need the full set of features provided by [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html), as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.test.context.ConfigDataApplicationContextInitializer; import org.springframework.test.context.ContextConfiguration; @ContextConfiguration(classes = Config.class, initializers = ConfigDataApplicationContextInitializer.class) class MyConfigFileTests { // ... } ``` ```kotlin import org.springframework.boot.test.context.ConfigDataApplicationContextInitializer import org.springframework.test.context.ContextConfiguration @ContextConfiguration(classes = [Config::class], initializers = [ConfigDataApplicationContextInitializer::class]) class MyConfigFileTests { // ... } ``` | | | | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Using [`ConfigDataApplicationContextInitializer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/ConfigDataApplicationContextInitializer.html) alone does not provide support for `@Value("${…​}")` injection. Its only job is to ensure that `application.properties` files are loaded into Spring’s [`Environment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/Environment.html). For [`@Value`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/beans/factory/annotation/Value.html) support, you need to either additionally configure a [`PropertySourcesPlaceholderConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/support/PropertySourcesPlaceholderConfigurer.html) or use [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html), which auto-configures one for you. | ## [](#testing.utilities.test-property-values)TestPropertyValues [`TestPropertyValues`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/util/TestPropertyValues.html) lets you quickly add properties to a [`ConfigurableEnvironment`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/core/env/ConfigurableEnvironment.html) or [`ConfigurableApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ConfigurableApplicationContext.html). You can call it with `key=value` strings, as follows: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.boot.test.util.TestPropertyValues; import org.springframework.mock.env.MockEnvironment; import static org.assertj.core.api.Assertions.assertThat; class MyEnvironmentTests { @Test void testPropertySources() { MockEnvironment environment = new MockEnvironment(); TestPropertyValues.of("org=Spring", "name=Boot").applyTo(environment); assertThat(environment.getProperty("name")).isEqualTo("Boot"); } } ``` ```kotlin import org.assertj.core.api.Assertions.assertThat import org.junit.jupiter.api.Test import org.springframework.boot.test.util.TestPropertyValues import org.springframework.mock.env.MockEnvironment class MyEnvironmentTests { @Test fun testPropertySources() { val environment = MockEnvironment() TestPropertyValues.of("org=Spring", "name=Boot").applyTo(environment) assertThat(environment.getProperty("name")).isEqualTo("Boot") } } ``` ## [](#testing.utilities.output-capture)OutputCaptureExtension [`OutputCaptureExtension`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/system/OutputCaptureExtension.html) is a JUnit [`Extension`](https://junit.org/junit5/docs/6.0.3/api/org.junit.jupiter.api/org/junit/jupiter/api/extension/Extension.html) that you can use to capture [`System.out`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/System.html#out) and [`System.err`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/System.html#err) output. To use it, add `@ExtendWith(OutputCaptureExtension.class)` and inject [`CapturedOutput`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/system/CapturedOutput.html) as an argument to your test class constructor or test method as follows: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; import org.springframework.boot.test.system.CapturedOutput; import org.springframework.boot.test.system.OutputCaptureExtension; import static org.assertj.core.api.Assertions.assertThat; @ExtendWith(OutputCaptureExtension.class) class MyOutputCaptureTests { @Test void testName(CapturedOutput output) { System.out.println("Hello World!"); assertThat(output).contains("World"); } } ``` ```kotlin import org.assertj.core.api.Assertions.assertThat import org.junit.jupiter.api.Test import org.junit.jupiter.api.extension.ExtendWith import org.springframework.boot.test.system.CapturedOutput import org.springframework.boot.test.system.OutputCaptureExtension @ExtendWith(OutputCaptureExtension::class) class MyOutputCaptureTests { @Test fun testName(output: CapturedOutput?) { println("Hello World!") assertThat(output).contains("World") } } ``` ## [](#testing.utilities.test-rest-template)TestRestTemplate [`TestRestTemplate`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/resttestclient/TestRestTemplate.html) is a convenience alternative to Spring’s [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html) that is useful in integration tests. It’s provided by the `spring-boot-resttestclient` module. A dependency on `spring-boot-restclient` is also required. Take care when adding this dependency as it will enable auto-configuration for `RestClient.Builder`. If your main code uses `RestClient.Builder`, declare the `spring-boot-restclient` dependency so that it is on your application’s main classpath and not only on its test classpath. You can get a vanilla template or one that sends Basic HTTP authentication (with a username and password). In either case, the template is fault tolerant. This means that it behaves in a test-friendly way by not throwing exceptions on 4xx and 5xx errors. Instead, such errors can be detected through the returned [`ResponseEntity`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/ResponseEntity.html) and its status code. If you need fluent API for assertions, consider using [`RestTestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/servlet/client/RestTestClient.html) that works with [mock environments](spring-boot-applications.html#testing.spring-boot-applications.with-mock-environment) and [end-to-end tests](spring-boot-applications.html#testing.spring-boot-applications.with-running-server). If you are using Spring WebFlux, consider the [`WebTestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/test/web/reactive/server/WebTestClient.html) that provides a similar API and works with [mock environments](spring-boot-applications.html#testing.spring-boot-applications.with-mock-environment), [WebFlux integration tests](spring-boot-applications.html#testing.spring-boot-applications.spring-webflux-tests), and [end-to-end tests](spring-boot-applications.html#testing.spring-boot-applications.with-running-server). It is recommended, but not mandatory, to use the Apache HTTP Client (version 5.1 or better). If you have that on your classpath, the [`TestRestTemplate`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/resttestclient/TestRestTemplate.html) responds by configuring the client appropriately. [`TestRestTemplate`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/resttestclient/TestRestTemplate.html) can be instantiated directly in your integration tests, as shown in the following example: * Java * Kotlin ```java import org.junit.jupiter.api.Test; import org.springframework.boot.resttestclient.TestRestTemplate; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import static org.assertj.core.api.Assertions.assertThat; class MyTests { private final TestRestTemplate template = new TestRestTemplate(); @Test void testRequest() { ResponseEntity response = this.template.getForEntity("https://myhost.example.com/example", String.class); assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK); // Other assertions to verify the response } } ``` ```kotlin import org.assertj.core.api.Assertions.assertThat import org.junit.jupiter.api.Test import org.springframework.boot.resttestclient.TestRestTemplate import org.springframework.http.HttpStatus class MyTests { private val template = TestRestTemplate() @Test fun testRequest() { val response = template.getForEntity("https://myhost.example.com/example", String::class.java) assertThat(response.statusCode).isEqualTo(HttpStatus.OK) // Other assertions to verify the response } } ``` Alternatively, if you use the [`@SpringBootTest`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/test/context/SpringBootTest.html) annotation with `WebEnvironment.RANDOM_PORT` or `WebEnvironment.DEFINED_PORT`, you can inject a fully configured [`TestRestTemplate`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/resttestclient/TestRestTemplate.html) by annotating the test class with [`@AutoConfigureTestRestTemplate`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/resttestclient/autoconfigure/AutoConfigureTestRestTemplate.html). If necessary, additional customizations can be applied through the [`RestTemplateBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateBuilder.html) bean. Any URLs that do not specify a host and port automatically connect to the embedded server, as shown in the following example: * Java * Kotlin ```java import java.time.Duration; import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.restclient.RestTemplateBuilder; import org.springframework.boot.resttestclient.TestRestTemplate; import org.springframework.boot.resttestclient.autoconfigure.AutoConfigureTestRestTemplate; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest.WebEnvironment; import org.springframework.boot.test.context.TestConfiguration; import org.springframework.context.annotation.Bean; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import static org.assertj.core.api.Assertions.assertThat; @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) @AutoConfigureTestRestTemplate class MySpringBootTests { @Autowired private TestRestTemplate template; @Test void testRequest() { ResponseEntity response = this.template.getForEntity("/example", String.class); assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK); // Other assertions to verify the response } @TestConfiguration(proxyBeanMethods = false) static class RestTemplateBuilderConfiguration { @Bean RestTemplateBuilder restTemplateBuilder() { return new RestTemplateBuilder().connectTimeout(Duration.ofSeconds(1)).readTimeout(Duration.ofSeconds(1)); } } } ``` ```kotlin import org.assertj.core.api.Assertions.assertThat import org.junit.jupiter.api.Test import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.test.context.SpringBootTest import org.springframework.boot.test.context.SpringBootTest.WebEnvironment import org.springframework.boot.test.context.TestConfiguration import org.springframework.boot.restclient.RestTemplateBuilder import org.springframework.boot.resttestclient.TestRestTemplate import org.springframework.boot.resttestclient.autoconfigure.AutoConfigureTestRestTemplate import org.springframework.context.annotation.Bean import org.springframework.http.HttpStatus import java.time.Duration @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) @AutoConfigureTestRestTemplate class MySpringBootTests(@Autowired val template: TestRestTemplate) { @Test fun testRequest() { val response = template.getForEntity("/example", String::class.java) assertThat(response.statusCode).isEqualTo(HttpStatus.OK) // Other assertions to verify the response } @TestConfiguration(proxyBeanMethods = false) internal class RestTemplateBuilderConfiguration { @Bean fun restTemplateBuilder(): RestTemplateBuilder { return RestTemplateBuilder().connectTimeout(Duration.ofSeconds(1)) .readTimeout(Duration.ofSeconds(1)) } } } ``` * [Spring Boot](../../index.html) * [4.1.1](test-utilities.html) * [4.0.8](../../4.0/reference/testing/test-utilities.html) * [3.5.16](../../3.5/reference/testing/test-utilities.html) * [3.4.13](../../3.4/reference/testing/test-utilities.html) * [3.3.13](../../3.3/reference/testing/test-utilities.html) - [4.2.0-M2](../../4.2/reference/testing/test-utilities.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/testing/test-utilities.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/testing/test-utilities.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/testing/test-utilities.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/search.html ---- # Search Additional resources The [help page](help-doc.html#search) provides an introduction to the scope and syntax of JavaDoc search. Use the `↓` / `↑` keys to move between search results and the `←` / `→` keys to switch between result tabs. The URL template below may be useful to configure this page as a search engine or bookmarklet in browsers that support this feature. link Redirect to first result Loading search index... ---- url: https://docs.spring.io/spring-boot/reference/messaging/spring-integration.html ---- # Spring Integration Spring Boot offers several conveniences for working with [Spring Integration](https://spring.io/projects/spring-integration), including the `spring-boot-starter-integration` starter. Spring Integration provides abstractions over messaging and also other transports such as HTTP, TCP, and others. If Spring Integration is available on your classpath, it is initialized through the [`@EnableIntegration`](https://docs.spring.io/spring-integration/docs/7.1.x/api/org/springframework/integration/config/EnableIntegration.html) annotation. Spring Integration polling logic relies [on the auto-configured ](../features/task-execution-and-scheduling.html)[`TaskScheduler`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/scheduling/TaskScheduler.html). The default [`PollerMetadata`](https://docs.spring.io/spring-integration/docs/7.1.x/api/org/springframework/integration/scheduling/PollerMetadata.html) (poll unbounded number of messages every second) can be customized with `spring.integration.poller.*` configuration properties. Spring Boot also configures some features that are triggered by the presence of additional Spring Integration modules. If `spring-integration-jmx` is also on the classpath, message processing statistics are published over JMX. If `spring-integration-jdbc` is available, the default database schema can be created on startup, as shown in the following line: * Properties * YAML ```properties spring.integration.jdbc.initialize-schema=always ``` ```yaml spring: integration: jdbc: initialize-schema: "always" ``` If `spring-integration-rsocket` is available, developers can configure an RSocket server using `spring.rsocket.server.*` properties and let it use [`IntegrationRSocketEndpoint`](https://docs.spring.io/spring-integration/docs/7.1.x/api/org/springframework/integration/rsocket/IntegrationRSocketEndpoint.html) or [`RSocketOutboundGateway`](https://docs.spring.io/spring-integration/docs/7.1.x/api/org/springframework/integration/rsocket/outbound/RSocketOutboundGateway.html) components to handle incoming RSocket messages. This infrastructure can handle Spring Integration RSocket channel adapters and [`@MessageMapping`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/messaging/handler/annotation/MessageMapping.html) handlers (given `spring.integration.rsocket.server.message-mapping-enabled` is configured). Spring Boot can also auto-configure an [`ClientRSocketConnector`](https://docs.spring.io/spring-integration/docs/7.1.x/api/org/springframework/integration/rsocket/ClientRSocketConnector.html) using configuration properties: * Properties * YAML ```properties spring.integration.rsocket.client.host=example.org spring.integration.rsocket.client.port=9898 ``` ```yaml # Connecting to a RSocket server over TCP spring: integration: rsocket: client: host: "example.org" port: 9898 ``` * Properties * YAML ```properties spring.integration.rsocket.client.uri=ws://example.org ``` ```yaml # Connecting to a RSocket Server over WebSocket spring: integration: rsocket: client: uri: "ws://example.org" ``` See the [`IntegrationAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/module/spring-boot-integration/src/main/java/org/springframework/boot/integration/autoconfigure/IntegrationAutoConfiguration.java) and [`IntegrationProperties`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/integration/autoconfigure/IntegrationProperties.html) classes for more details. * [Spring Boot](../../index.html) * [4.1.1](spring-integration.html) * [4.0.8](../../4.0/reference/messaging/spring-integration.html) * [3.5.16](../../3.5/reference/messaging/spring-integration.html) * [3.4.13](../../3.4/reference/messaging/spring-integration.html) * [3.3.13](../../3.3/reference/messaging/spring-integration.html) - [4.2.0-M2](../../4.2/reference/messaging/spring-integration.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/messaging/spring-integration.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/messaging/spring-integration.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/messaging/spring-integration.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/getting-started.html ---- # Getting Started To get started with the plugin it needs to be applied to your project. The plugin is [published to Gradle’s plugin portal](https://plugins.gradle.org/plugin/org.springframework.boot) and can be applied using the `plugins` block: * Groovy * Kotlin ```groovy plugins { id 'org.springframework.boot' version '4.1.1' } ``` ```kotlin plugins { id("org.springframework.boot") version "4.1.1" } ``` Applied in isolation the plugin makes few changes to a project. Instead, the plugin detects when certain other plugins are applied and reacts accordingly. For example, when the `java` plugin is applied a task for building an executable jar is automatically configured. A typical Spring Boot project will apply the [`groovy`](https://docs.gradle.org/current/userguide/groovy_plugin.html), [`java`](https://docs.gradle.org/current/userguide/java_plugin.html), or [`org.jetbrains.kotlin.jvm`](https://kotlinlang.org/docs/reference/using-gradle.html) plugin as a minimum and also use the [`io.spring.dependency-management`](https://github.com/spring-gradle-plugins/dependency-management-plugin) plugin or Gradle’s native bom support for dependency management. For example: * Groovy * Kotlin ```groovy plugins { id 'java' id 'org.springframework.boot' version '4.1.1' } apply plugin: 'io.spring.dependency-management' ``` ```kotlin plugins { java id("org.springframework.boot") version "4.1.1" } apply(plugin = "io.spring.dependency-management") ``` To learn more about how the Spring Boot plugin behaves when other plugins are applied please see the section on [reacting to other plugins](reacting.html). * [Spring Boot](../index.html) * [4.1.1](getting-started.html) * [4.0.8](../4.0/gradle-plugin/getting-started.html) * [3.5.16](../3.5/gradle-plugin/getting-started.html) * [3.4.13](../3.4/gradle-plugin/getting-started.html) * [3.3.13](../3.3/gradle-plugin/getting-started.html) - [4.2.0-M2](../4.2/gradle-plugin/getting-started.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/gradle-plugin/getting-started.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/gradle-plugin/getting-started.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/gradle-plugin/getting-started.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/run/package-summary.html ---- # Package org.springframework.boot.gradle.tasks.run *** @NullMarked package org.springframework.boot.gradle.tasks.run Support for running Spring Boot applications. * Classes Class Description [BootRun](BootRun.html "class in org.springframework.boot.gradle.tasks.run") Custom [`JavaExec`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/JavaExec.html "class or interface in org.gradle.api.tasks") task for running a Spring Boot application. ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/Docker.html ---- Uses of Class\ org.springframework.boot.maven.Docker ===================================== No usage of org.springframework.boot.maven.Docker ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/class-use/AbstractAotMojo.Errors.html ---- Uses of Class\ org.springframework.boot.maven.AbstractAotMojo.Errors ===================================================== No usage of org.springframework.boot.maven.AbstractAotMojo.Errors ---- url: https://docs.spring.io/spring-boot/reference/using/structuring-your-code.html ---- # Structuring Your Code Spring Boot does not require any specific code layout to work. However, there are some best practices that help. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you wish to enforce a structure based on domains, take a look at [Spring Modulith](https://spring.io/projects/spring-modulith#overview). | ## [](#using.structuring-your-code.using-the-default-package)Using the “default” Package When a class does not include a `package` declaration, it is considered to be in the “default package”. The use of the “default package” is generally discouraged and should be avoided. It can cause particular problems for Spring Boot applications that use the [`@ComponentScan`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/ComponentScan.html), [`@ConfigurationPropertiesScan`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/properties/ConfigurationPropertiesScan.html), [`@EntityScan`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/persistence/autoconfigure/EntityScan.html), or [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html) annotations, since every class from every jar is read. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | ** | We recommend that you follow Java’s recommended package naming conventions and use a reversed domain name (for example, `com.example.project`). | ## [](#using.structuring-your-code.locating-the-main-class)Locating the Main Application Class We generally recommend that you locate your main application class in a root package above other classes. The [`@SpringBootApplication` annotation](using-the-springbootapplication-annotation.html) is often placed on your main class, and it implicitly defines a base “search package” for certain items. For example, if you are writing a JPA application, the package of the [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html) annotated class is used to search for [`@Entity`](https://jakarta.ee/specifications/persistence/3.2/apidocs/jakarta.persistence/jakarta/persistence/Entity.html) items. Using a root package also allows component scan to apply only on your project. | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ** | If you do not want to use [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html), the [`@EnableAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/EnableAutoConfiguration.html) and [`@ComponentScan`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/ComponentScan.html) annotations that it imports defines that behavior so you can also use those instead. | The following listing shows a typical layout: ```none com +- example +- myapplication +- MyApplication.java | +- customer | +- Customer.java | +- CustomerController.java | +- CustomerService.java | +- CustomerRepository.java | +- order +- Order.java +- OrderController.java +- OrderService.java +- OrderRepository.java ``` The `MyApplication.java` file would declare the `main` method, along with the basic [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html), as follows: * Java * Kotlin ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class MyApplication { public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } ``` ```kotlin import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.runApplication @SpringBootApplication class MyApplication fun main(args: Array) { runApplication(*args) } ``` * [Spring Boot](../../index.html) * [4.1.1](structuring-your-code.html) * [4.0.8](../../4.0/reference/using/structuring-your-code.html) * [3.5.16](../../3.5/reference/using/structuring-your-code.html) * [3.4.13](../../3.4/reference/using/structuring-your-code.html) * [3.3.13](../../3.3/reference/using/structuring-your-code.html) - [4.2.0-M2](../../4.2/reference/using/structuring-your-code.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/using/structuring-your-code.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/using/structuring-your-code.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/using/structuring-your-code.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/how-to/security.html ---- # Security This section addresses questions about security when working with Spring Boot, including questions that arise from using Spring Security with Spring Boot. For more about Spring Security, see the [Spring Security project page](https://spring.io/projects/spring-security). ## [](#howto.security.switch-off-spring-boot-configuration)Switch Off the Spring Boot Security Configuration If you define a [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) with a [`SecurityFilterChain`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/SecurityFilterChain.html) bean in your application, this action switches off the default webapp security settings in Spring Boot. ## [](#howto.security.change-user-details-service-and-add-user-accounts)Change the UserDetailsService and Add User Accounts If you provide a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) of type [`AuthenticationManager`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/authentication/AuthenticationManager.html), [`AuthenticationProvider`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/authentication/AuthenticationProvider.html), or [`UserDetailsService`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/core/userdetails/UserDetailsService.html), the default [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) for [`InMemoryUserDetailsManager`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/provisioning/InMemoryUserDetailsManager.html) is not created. This means you have the full feature set of Spring Security available (such as [various authentication options](https://docs.spring.io/spring-security/reference/7.1/servlet/authentication/index.html)). The easiest way to add user accounts is by providing your own [`UserDetailsService`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/core/userdetails/UserDetailsService.html) bean. ## [](#howto.security.enable-https)Enable HTTPS When Running Behind a Proxy Server Ensuring that all your main endpoints are only available over HTTPS is an important chore for any application. If you use Tomcat as a servlet container, then Spring Boot adds Tomcat’s own [`RemoteIpValve`](https://tomcat.apache.org/tomcat-11.0-doc/api/org/apache/catalina/valves/RemoteIpValve.html) automatically if it detects some environment settings, allowing you to rely on the [`HttpServletRequest`](https://jakarta.ee/specifications/servlet/6.1/apidocs/jakarta.servlet/jakarta/servlet/http/HttpServletRequest.html) to report whether it is secure or not (even downstream of a proxy server that handles the real SSL termination). The standard behavior is determined by the presence or absence of certain request headers (`x-forwarded-for` and `x-forwarded-proto`), whose names are conventional, so it should work with most front-end proxies. You can switch on the valve by adding some entries to `application.properties`, as shown in the following example: * Properties * YAML ```properties server.tomcat.remoteip.remote-ip-header=x-forwarded-for server.tomcat.remoteip.protocol-header=x-forwarded-proto ``` ```yaml server: tomcat: remoteip: remote-ip-header: "x-forwarded-for" protocol-header: "x-forwarded-proto" ``` (The presence of either of those properties switches on the valve. Alternatively, you can add the [`RemoteIpValve`](https://tomcat.apache.org/tomcat-11.0-doc/api/org/apache/catalina/valves/RemoteIpValve.html) by customizing the [`TomcatServletWebServerFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/tomcat/servlet/TomcatServletWebServerFactory.html) using a [`WebServerFactoryCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/WebServerFactoryCustomizer.html) bean.) To configure Spring Security to require a secure channel for all (or some) requests, consider adding your own [`SecurityFilterChain`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/web/SecurityFilterChain.html) bean that adds the following [`HttpSecurity`](https://docs.spring.io/spring-security/reference/7.1/api/java/org/springframework/security/config/annotation/web/builders/HttpSecurity.html) configuration: * Java * Kotlin ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.security.config.Customizer; import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.web.SecurityFilterChain; @Configuration public class MySecurityConfig { @Bean public SecurityFilterChain securityFilterChain(HttpSecurity http) { // Customize the application security ... http.redirectToHttps(Customizer.withDefaults()); return http.build(); } } ``` ```kotlin import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.security.config.annotation.web.builders.HttpSecurity import org.springframework.security.web.SecurityFilterChain @Configuration class MySecurityConfig { @Bean fun securityFilterChain(http: HttpSecurity): SecurityFilterChain { // Customize the application security ... http.redirectToHttps { } return http.build() } } ``` * [Spring Boot](../index.html) * [4.1.1](security.html) * [4.0.8](../4.0/how-to/security.html) * [3.5.16](../3.5/how-to/security.html) * [3.4.13](../3.4/how-to/security.html) * [3.3.13](../3.3/how-to/security.html) - [4.2.0-M2](../4.2/how-to/security.html) * [4.2.0-SNAPSHOT](../4.2-SNAPSHOT/how-to/security.html) * [4.1.3-SNAPSHOT](../4.1-SNAPSHOT/how-to/security.html) * [4.0.10-SNAPSHOT](../4.0-SNAPSHOT/how-to/security.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/BootJar.html ---- # Class BootJar org.springframework.boot.gradle.tasks.bundling.BootJar * All Implemented Interfaces: `Comparable, ContentFilterable, CopyProcessingSpec, CopySourceSpec, CopySpec, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.file.copy.CopySpecSource, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Task, PatternFilterable, Configurable, BootArchive` *** [@DisableCachingByDefault](https://docs.gradle.org/9.7.0/javadoc/org/gradle/work/DisableCachingByDefault.html "class or interface in org.gradle.work")([because](https://docs.gradle.org/9.7.0/javadoc/org/gradle/work/DisableCachingByDefault.html#because\(\) "class or interface in org.gradle.work")="Not worth caching") public abstract class BootJar extends [Jar](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/Jar.html "class or interface in org.gradle.api.tasks.bundling") implements [BootArchive](BootArchive.html "interface in org.springframework.boot.gradle.tasks.bundling") A custom [`Jar`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/bundling/Jar.html "class or interface in org.gradle.api.tasks.bundling") task that produces a Spring Boot executable jar. * Since: 2.0.0 * Author: Andy Wilkinson, Madhura Bhave, Scott Frederick, Phillip Webb - ## Nested Class Summary ### Nested classes/interfaces inherited from interface [Named](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Named.html#nested-class-summary "class or interface in org.gradle.api") `Named.Namer` - ## Field Summary `BootJar()` Creates a new `BootJar` task. - ## Method Summary Modifier and Type Method Description `CopySpec` `bootInf(Action action)` Calls the given `action` to add content to the `BOOT-INF` directory of the jar. `void` `classpath(Object... classpath)` Adds files to the classpath to include in the archive. `void` `copy()`   `protected org.gradle.api.internal.file.copy.CopyAction` `createCopyAction()`   `CopySpec` `getBootInf()` Returns a `CopySpec` that can be used to add content to the `BOOT-INF` directory of the jar. `@Nullable FileCollection` `getClasspath()` Returns the classpath that will be included in the archive. `LayeredSpec` `getLayered()` Returns the spec that describes the layers in a layered jar. `protected boolean` `isLibrary(FileCopyDetails details)` Return if the [`FileCopyDetails`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCopyDetails.html "class or interface in org.gradle.api.file") are for a library. `void` `layered(Action action)` Configures the jar's layering using the given `action`. `setClasspath(Object classpath)` Sets the classpath to include in the archive. `void` `setClasspath(FileCollection classpath)` Sets the classpath to include in the archive. `createRootSpec, dirPermissions, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, expand, filePermissions, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirectoryFileTreeFactory, getDirPermissions, getDocumentationRegistry, getDuplicatesStrategy, getExcludes, getFileLookup, getFilePermissions, getFileResolver, getFileSystem, getFilteringCharset, getIncludeEmptyDirs, getIncludes, getInstantiator, getMainSpec, getObjectFactory, getPropertyFactory, getRootSpec, getSource, include, include, include, include, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDuplicatesStrategy, setExcludes, setFilteringCharset, setIncludeEmptyDirs, setIncludes, with` `getIncludeTools, getMainClass, getTargetJavaVersion` * ### BootJar public BootJar() Creates a new `BootJar` task. * ## Method Details * ### resolvedArtifacts public void resolvedArtifacts​([Provider](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/provider/Provider.html "class or interface in org.gradle.api.provider")<[Set](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html "class or interface in java.util")<[ResolvedArtifactResult](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/artifacts/result/ResolvedArtifactResult.html "class or interface in org.gradle.api.artifacts.result")>> resolvedArtifacts) Description copied from interface: `BootArchive` Registers the given lazily provided `resolvedArtifacts`. They are used to map from the files in the [`classpath`](BootArchive.html#getClasspath\(\)) to their dependency coordinates. * Specified by: `resolvedArtifacts` in interface `BootArchive` * Parameters: `resolvedArtifacts` - the lazily provided resolved artifacts * ### copy public void copy() * Overrides: `copy` in class `AbstractCopyTask` * ### createCopyAction protected org.gradle.api.internal.file.copy.CopyAction createCopyAction() * Overrides: `createCopyAction` in class `Zip` * ### requiresUnpack public void requiresUnpack​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang")... patterns) Description copied from interface: `BootArchive` Adds Ant-style patterns that identify files that must be unpacked from the archive when it is launched. * Specified by: `requiresUnpack` in interface `BootArchive` * Parameters: `patterns` - the patterns * ### requiresUnpack public void requiresUnpack​([Spec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/specs/Spec.html "class or interface in org.gradle.api.specs")<[FileTreeElement](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileTreeElement.html "class or interface in org.gradle.api.file")> spec) Description copied from interface: `BootArchive` Adds a spec that identifies files that must be unpacked from the archive when it is launched. * Specified by: `requiresUnpack` in interface `BootArchive` * Parameters: `spec` - the spec * ### getLayered public [LayeredSpec](LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling") getLayered() Returns the spec that describes the layers in a layered jar. * Returns: the spec for the layers * Since: 2.3.0 * ### layered public void layered​([Action](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Action.html "class or interface in org.gradle.api")<[LayeredSpec](LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling")> action) Configures the jar's layering using the given `action`. * Parameters: `action` - the action to apply * Since: 2.3.0 * ### getClasspath public @Nullable [FileCollection](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCollection.html "class or interface in org.gradle.api.file") getClasspath() Description copied from interface: `BootArchive` Returns the classpath that will be included in the archive. * Specified by: `getClasspath` in interface `BootArchive` * Returns: the classpath * ### classpath public void classpath​([Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang")... classpath) Description copied from interface: `BootArchive` Adds files to the classpath to include in the archive. The given `classpath` is evaluated as per [`Project.files(Object...)`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Project.html#files\(java.lang.Object...\) "class or interface in org.gradle.api"). * Specified by: `classpath` in interface `BootArchive` * Parameters: `classpath` - the additions to the classpath * ### setClasspath public void setClasspath​([Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") classpath) Description copied from interface: `BootArchive` Sets the classpath to include in the archive. The given `classpath` is evaluated as per [`Project.files(Object...)`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Project.html#files\(java.lang.Object...\) "class or interface in org.gradle.api"). * Specified by: `setClasspath` in interface `BootArchive` * Parameters: `classpath` - the classpath * ### setClasspath public void setClasspath​([FileCollection](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCollection.html "class or interface in org.gradle.api.file") classpath) Description copied from interface: `BootArchive` Sets the classpath to include in the archive. * Specified by: `setClasspath` in interface `BootArchive` * Parameters: `classpath` - the classpath * ### getBootInf [@Internal](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/tasks/Internal.html "class or interface in org.gradle.api.tasks") public [CopySpec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/CopySpec.html "class or interface in org.gradle.api.file") getBootInf() Returns a `CopySpec` that can be used to add content to the `BOOT-INF` directory of the jar. * Returns: a `CopySpec` for `BOOT-INF` * Since: 2.0.3 * ### bootInf public [CopySpec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/CopySpec.html "class or interface in org.gradle.api.file") bootInf​([Action](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/Action.html "class or interface in org.gradle.api")<[CopySpec](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/CopySpec.html "class or interface in org.gradle.api.file")> action) Calls the given `action` to add content to the `BOOT-INF` directory of the jar. * Parameters: `action` - the `Action` to call * Returns: the `CopySpec` for `BOOT-INF` that was passed to the `Action` * Since: 2.0.3 * ### resolveZipCompression protected [ZipCompression](ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") resolveZipCompression​([FileCopyDetails](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCopyDetails.html "class or interface in org.gradle.api.file") details) Return the [`ZipCompression`](ZipCompression.html "enum class in org.springframework.boot.gradle.tasks.bundling") that should be used when adding the file represented by the given `details` to the jar. By default, any [`library`](#isLibrary\(org.gradle.api.file.FileCopyDetails\)) is [`stored`](ZipCompression.html#STORED) and all other files are [`deflated`](ZipCompression.html#DEFLATED). * Parameters: `details` - the file copy details * Returns: the compression to use * ### isLibrary protected boolean isLibrary​([FileCopyDetails](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCopyDetails.html "class or interface in org.gradle.api.file") details) Return if the [`FileCopyDetails`](https://docs.gradle.org/9.7.0/javadoc/org/gradle/api/file/FileCopyDetails.html "class or interface in org.gradle.api.file") are for a library. By default any file in `BOOT-INF/lib` is considered to be a library. * Parameters: `details` - the file copy details * Returns: `true` if the details are for a library * Since: 2.3.0 ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/Docker.DockerRegistry.html ---- # Class Docker.DockerRegistry [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.maven.Docker.DockerRegistry * Enclosing class: `Docker` *** public static class Docker.DockerRegistry extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") `DockerRegistry()`   `DockerRegistry(@Nullable String username, @Nullable String password, @Nullable String url, @Nullable String email)`   `DockerRegistry(String token)`   - ## Method Summary Modifier and Type Method Description `@Nullable String` `getEmail()` The email address that will be used for user authentication to the registry. `@Nullable String` `getPassword()` The password that will be used for user authentication to the registry. `@Nullable String` `getToken()` The token that will be used for token authentication to the registry. `@Nullable String` `getUsername()` The username that will be used for user authentication to the registry. ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### DockerRegistry public DockerRegistry() * ### DockerRegistry public DockerRegistry​(@Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") username, @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") password, @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") url, @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") email) * ### DockerRegistry public DockerRegistry​([String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") token) * ## Method Details * ### getUsername public @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getUsername() The username that will be used for user authentication to the registry. * Returns: the username * ### getPassword public @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getPassword() The password that will be used for user authentication to the registry. * Returns: the password * ### getEmail public @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getEmail() The email address that will be used for user authentication to the registry. * Returns: the email address * ### getToken public @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getToken() The token that will be used for token authentication to the registry. * Returns: the authentication token ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/Docker.html ---- # Class Docker [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.maven.Docker *** public class Docker extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") Docker configuration options. `Docker.DockerRegistry` Encapsulates Docker registry authentication configuration options. - ## Constructor Summary Constructors Constructor Description `Docker()`   - ## Method Summary Modifier and Type Method Description `@Nullable String` `getCertPath()` The path to TLS certificate and key files required for TLS communication with the Docker daemon. `@Nullable String` `getContext()` The Docker context to use to retrieve host configuration. `@Nullable String` `getHost()` The host address of the Docker daemon. `boolean` `isBindHostToBuilder()` Whether to use the configured Docker host in the builder container. `boolean` `isTlsVerify()` Whether the Docker daemon requires TLS communication. `void` `setContext(@Nullable String context)`   ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Constructor Details * ### Docker public Docker() * ## Method Details * ### getHost public @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getHost() The host address of the Docker daemon. * Returns: the Docker host * ### getContext public @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getContext() The Docker context to use to retrieve host configuration. * Returns: the Docker context * ### setContext public void setContext​(@Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") context) * ### isTlsVerify public boolean isTlsVerify() Whether the Docker daemon requires TLS communication. * Returns: `true` to enable TLS * ### getCertPath public @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") getCertPath() The path to TLS certificate and key files required for TLS communication with the Docker daemon. * Returns: the TLS certificate path * ### isBindHostToBuilder public boolean isBindHostToBuilder() Whether to use the configured Docker host in the builder container. * Returns: `true` to use the configured Docker host in the builder container ---- url: https://docs.spring.io/spring-boot/reference/data/index.html ---- # Data Spring Boot integrates with a number of data technologies, both SQL and NoSQL. * [Spring Boot](../../index.html) * [4.1.1](index.html) * [4.0.8](../../4.0/reference/data/index.html) * [3.5.16](../../3.5/reference/data/index.html) * [3.4.13](../../3.4/reference/data/index.html) * [3.3.13](../../3.3/reference/data/index.html) - [4.2.0-M2](../../4.2/reference/data/index.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/data/index.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/data/index.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/data/index.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/io/rest-client.html ---- # Calling REST Services Spring Boot provides various convenient ways to call remote REST services. If you are developing a non-blocking reactive application and you’re using Spring WebFlux, then you can use [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html). If you prefer imperative APIs then you can use [`RestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.html) or [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html). ## [](#io.rest-client.webclient)WebClient If you have Spring WebFlux on your classpath we recommend that you use [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html) to call remote REST services. The [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html) interface provides a functional style API and is fully reactive. You can learn more about the [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html) in the dedicated [section in the Spring Framework docs](https://docs.spring.io/spring-framework/reference/7.0/web/webflux-webclient.html). | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you are not writing a reactive Spring WebFlux application you can use the [`RestClient`](#io.rest-client.restclient) instead of a [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html). This provides a similar functional API, but is imperative rather than reactive. | Spring Boot creates and pre-configures a prototype [`WebClient.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.Builder.html) bean for you. It is strongly advised to inject it in your components and use it to create [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html) instances. Spring Boot is configuring that builder to share HTTP resources and reflect codecs setup in the same fashion as the server ones (see [WebFlux HTTP codecs auto-configuration](../web/reactive.html#web.reactive.webflux.httpcodecs)), and more. The following code shows a typical example: * Java * Kotlin ```java import reactor.core.publisher.Mono; import org.springframework.stereotype.Service; import org.springframework.web.reactive.function.client.WebClient; @Service public class MyService { private final WebClient webClient; public MyService(WebClient.Builder webClientBuilder) { this.webClient = webClientBuilder.baseUrl("https://example.org").build(); } public Mono

someRestCall(String name) { return this.webClient.get().uri("/{name}/details", name).retrieve().bodyToMono(Details.class); } } ``` ```kotlin import org.springframework.stereotype.Service import org.springframework.web.reactive.function.client.WebClient import reactor.core.publisher.Mono @Service class MyService(webClientBuilder: WebClient.Builder) { private val webClient: WebClient init { webClient = webClientBuilder.baseUrl("https://example.org").build() } fun someRestCall(name: String): Mono
{ return webClient.get().uri("/{name}/details", name) .retrieve().bodyToMono(Details::class.java) } } ``` ### [](#io.rest-client.webclient.runtime)WebClient Runtime Spring Boot will auto-detect which [`ClientHttpConnector`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/client/reactive/ClientHttpConnector.html) to use to drive [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html) depending on the libraries available on the application classpath. In order of preference, the following clients are supported: 1. Reactor Netty 2. Jetty RS client 3. Apache HttpClient 4. JDK HttpClient If multiple clients are available on the classpath, the most preferred client will be used. The `spring-boot-starter-webflux` starter depends on `io.projectreactor.netty:reactor-netty` by default, which brings both server and client implementations. If you choose to use Jetty as a reactive server instead, you should add a dependency on the Jetty Reactive HTTP client library, `org.eclipse.jetty:jetty-reactive-httpclient`. Using the same technology for server and client has its advantages, as it will automatically share HTTP resources between client and server. Developers can override the resource configuration for Jetty and Reactor Netty by providing a custom [`ReactorResourceFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/client/ReactorResourceFactory.html) or [`JettyResourceFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/client/reactive/JettyResourceFactory.html) bean - this will be applied to both clients and servers. If you wish to override that choice for the client, you can define your own [`ClientHttpConnector`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/client/reactive/ClientHttpConnector.html) bean and have full control over the client configuration. You can learn more about the [`WebClient` configuration options in the Spring Framework reference documentation](https://docs.spring.io/spring-framework/reference/7.0/web/webflux-webclient/client-builder.html). ### [](#io.rest-client.webclient.configuration)Global HTTP Connector Configuration If the auto-detected [`ClientHttpConnector`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/client/reactive/ClientHttpConnector.html) does not meet your needs, you can use the `spring.http.clients.reactive.connector` property to pick a specific connector. For example, if you have Reactor Netty on your classpath, but you prefer Jetty’s [`HttpClient`](https://javadoc.jetty.org/jetty-12/org/eclipse/jetty/client/HttpClient.html) you can add the following: * Properties * YAML ```properties spring.http.clients.reactive.connector=jetty ``` ```yaml spring: http: clients: reactive: connector: jetty ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------- | | ** | You can also use [global configuration properties](#io.rest-client.global-configuration) which apply to all HTTP clients. | For more complex customizations, you can use [`ClientHttpConnectorBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/http/client/autoconfigure/reactive/ClientHttpConnectorBuilderCustomizer.html) or declare your own [`ClientHttpConnectorBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/http/client/reactive/ClientHttpConnectorBuilder.html) bean which will cause auto-configuration to back off. This can be useful when you need to customize some of the internals of the underlying HTTP library. For example, the following will use a JDK client configured with a specific [`ProxySelector`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/ProxySelector.html): * Java * Kotlin ```java import java.net.ProxySelector; import org.springframework.boot.http.client.reactive.ClientHttpConnectorBuilder; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyConnectorHttpConfiguration { @Bean ClientHttpConnectorBuilder clientHttpConnectorBuilder(ProxySelector proxySelector) { return ClientHttpConnectorBuilder.jdk().withHttpClientCustomizer((builder) -> builder.proxy(proxySelector)); } } ``` ```kotlin import org.springframework.boot.http.client.reactive.ClientHttpConnectorBuilder import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import java.net.ProxySelector @Configuration(proxyBeanMethods = false) class MyConnectorHttpConfiguration { @Bean fun clientHttpConnectorBuilder(proxySelector: ProxySelector): ClientHttpConnectorBuilder<*> { return ClientHttpConnectorBuilder.jdk().withHttpClientCustomizer { builder -> builder.proxy(proxySelector) } } } ``` ### [](#io.rest-client.webclient.customization)WebClient Customization There are three main approaches to [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html) customization, depending on how broadly you want the customizations to apply. To make the scope of any customizations as narrow as possible, inject the auto-configured [`WebClient.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.Builder.html) and then call its methods as required. [`WebClient.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.Builder.html) instances are stateful: Any change on the builder is reflected in all clients subsequently created with it. If you want to create several clients with the same builder, you can also consider cloning the builder with `WebClient.Builder other = builder.clone();`. To make an application-wide, additive customization to all [`WebClient.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.Builder.html) instances, you can declare [`WebClientCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webclient/WebClientCustomizer.html) beans and change the [`WebClient.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.Builder.html) locally at the point of injection. Finally, you can fall back to the original API and use `WebClient.create()`. In that case, no auto-configuration or [`WebClientCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webclient/WebClientCustomizer.html) is applied. ### [](#io.rest-client.webclient.ssl)WebClient SSL Support If you need custom SSL configuration on the [`ClientHttpConnector`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/client/reactive/ClientHttpConnector.html) used by the [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html), you can inject a [`WebClientSsl`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webclient/autoconfigure/WebClientSsl.html) instance that can be used with the builder’s `apply` method. The [`WebClientSsl`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/webclient/autoconfigure/WebClientSsl.html) interface provides access to any [SSL bundles](../features/ssl.html#features.ssl.bundles) that you have defined in your `application.properties` or `application.yaml` file. The following code shows a typical example: * Java * Kotlin ```java import reactor.core.publisher.Mono; import org.springframework.boot.webclient.autoconfigure.WebClientSsl; import org.springframework.stereotype.Service; import org.springframework.web.reactive.function.client.WebClient; @Service public class MyService { private final WebClient webClient; public MyService(WebClient.Builder webClientBuilder, WebClientSsl ssl) { this.webClient = webClientBuilder.baseUrl("https://example.org").apply(ssl.fromBundle("mybundle")).build(); } public Mono
someRestCall(String name) { return this.webClient.get().uri("/{name}/details", name).retrieve().bodyToMono(Details.class); } } ``` ```kotlin import org.springframework.boot.webclient.autoconfigure.WebClientSsl import org.springframework.stereotype.Service import org.springframework.web.reactive.function.client.WebClient import reactor.core.publisher.Mono @Service class MyService(webClientBuilder: WebClient.Builder, ssl: WebClientSsl) { private val webClient: WebClient init { webClient = webClientBuilder.baseUrl("https://example.org") .apply(ssl.fromBundle("mybundle")).build() } fun someRestCall(name: String): Mono
{ return webClient.get().uri("/{name}/details", name) .retrieve().bodyToMono(Details::class.java) } } ``` ## [](#io.rest-client.restclient)RestClient If you are not using Spring WebFlux or Project Reactor in your application we recommend that you use [`RestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.html) to call remote REST services. The [`RestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.html) interface provides a functional style imperative API. Spring Boot creates and pre-configures a prototype [`RestClient.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.Builder.html) bean for you. It is strongly advised to inject it in your components and use it to create [`RestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.html) instances. Spring Boot is configuring that builder with [`HttpMessageConverters`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/converter/HttpMessageConverters.html) and an appropriate [`ClientHttpRequestFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/client/ClientHttpRequestFactory.html). The following code shows a typical example: * Java * Kotlin ```java import org.springframework.stereotype.Service; import org.springframework.web.client.RestClient; @Service public class MyService { private final RestClient restClient; public MyService(RestClient.Builder restClientBuilder) { this.restClient = restClientBuilder.baseUrl("https://example.org").build(); } public Details someRestCall(String name) { return this.restClient.get().uri("/{name}/details", name).retrieve().body(Details.class); } } ``` ```kotlin import org.springframework.boot.docs.io.restclient.restclient.ssl.Details import org.springframework.stereotype.Service import org.springframework.web.client.RestClient @Service class MyService(restClientBuilder: RestClient.Builder) { private val restClient: RestClient init { restClient = restClientBuilder.baseUrl("https://example.org").build() } fun someRestCall(name: String): Details { return restClient.get().uri("/{name}/details", name) .retrieve().body(Details::class.java)!! } } ``` ### [](#io.rest-client.restclient.customization)RestClient Customization There are three main approaches to [`RestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.html) customization, depending on how broadly you want the customizations to apply. To make the scope of any customizations as narrow as possible, inject the auto-configured [`RestClient.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.Builder.html) and then call its methods as required. [`RestClient.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.Builder.html) instances are stateful: Any change on the builder is reflected in all clients subsequently created with it. If you want to create several clients with the same builder, you can also consider cloning the builder with `RestClient.Builder other = builder.clone();`. To make an application-wide, additive customization to all [`RestClient.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.Builder.html) instances, you can declare [`RestClientCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestClientCustomizer.html) beans and change the [`RestClient.Builder`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.Builder.html) locally at the point of injection. Finally, you can fall back to the original API and use `RestClient.create()`. In that case, no auto-configuration or [`RestClientCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestClientCustomizer.html) is applied. | | | | -- | ------------------------------------------------------------------------------------------------------------------- | | ** | You can also change the [global HTTP client configuration](#io.rest-client.clienthttprequestfactory.configuration). | ### [](#io.rest-client.restclient.ssl)RestClient SSL Support If you need custom SSL configuration on the [`ClientHttpRequestFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/client/ClientHttpRequestFactory.html) used by the [`RestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.html), you can inject a [`RestClientSsl`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/autoconfigure/RestClientSsl.html) instance that can be used with the builder’s `apply` method. The [`RestClientSsl`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/autoconfigure/RestClientSsl.html) interface provides access to any [SSL bundles](../features/ssl.html#features.ssl.bundles) that you have defined in your `application.properties` or `application.yaml` file. The following code shows a typical example: * Java * Kotlin ```java import org.springframework.boot.restclient.autoconfigure.RestClientSsl; import org.springframework.stereotype.Service; import org.springframework.web.client.RestClient; @Service public class MyService { private final RestClient restClient; public MyService(RestClient.Builder restClientBuilder, RestClientSsl ssl) { this.restClient = restClientBuilder.baseUrl("https://example.org").apply(ssl.fromBundle("mybundle")).build(); } public Details someRestCall(String name) { return this.restClient.get().uri("/{name}/details", name).retrieve().body(Details.class); } } ``` ```kotlin import org.springframework.boot.docs.io.restclient.restclient.ssl.settings.Details import org.springframework.boot.restclient.autoconfigure.RestClientSsl import org.springframework.stereotype.Service import org.springframework.web.client.RestClient @Service class MyService(restClientBuilder: RestClient.Builder, ssl: RestClientSsl) { private val restClient: RestClient init { restClient = restClientBuilder.baseUrl("https://example.org") .apply(ssl.fromBundle("mybundle")).build() } fun someRestCall(name: String): Details { return restClient.get().uri("/{name}/details", name) .retrieve().body(Details::class.java)!! } } ``` If you need to apply other customization in addition to an SSL bundle, you can use the [`HttpClientSettings`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/http/client/HttpClientSettings.html) class with [`ClientHttpRequestFactoryBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/http/client/ClientHttpRequestFactoryBuilder.html): * Java * Kotlin ```java import java.time.Duration; import org.springframework.boot.http.client.ClientHttpRequestFactoryBuilder; import org.springframework.boot.http.client.HttpClientSettings; import org.springframework.boot.ssl.SslBundles; import org.springframework.http.client.ClientHttpRequestFactory; import org.springframework.stereotype.Service; import org.springframework.web.client.RestClient; @Service public class MyService { private final RestClient restClient; public MyService(RestClient.Builder restClientBuilder, SslBundles sslBundles) { HttpClientSettings settings = HttpClientSettings.ofSslBundle(sslBundles.getBundle("mybundle")) .withReadTimeout(Duration.ofMinutes(2)); ClientHttpRequestFactory requestFactory = ClientHttpRequestFactoryBuilder.detect().build(settings); this.restClient = restClientBuilder.baseUrl("https://example.org").requestFactory(requestFactory).build(); } public Details someRestCall(String name) { return this.restClient.get().uri("/{name}/details", name).retrieve().body(Details.class); } } ``` ```kotlin import org.springframework.boot.http.client.ClientHttpRequestFactoryBuilder; import org.springframework.boot.http.client.HttpClientSettings import org.springframework.boot.ssl.SslBundles import org.springframework.stereotype.Service import org.springframework.web.client.RestClient import java.time.Duration @Service class MyService(restClientBuilder: RestClient.Builder, sslBundles: SslBundles) { private val restClient: RestClient init { val settings = HttpClientSettings.defaults() .withReadTimeout(Duration.ofMinutes(2)) .withSslBundle(sslBundles.getBundle("mybundle")) val requestFactory = ClientHttpRequestFactoryBuilder.detect().build(settings); restClient = restClientBuilder .baseUrl("https://example.org") .requestFactory(requestFactory).build() } fun someRestCall(name: String): Details { return restClient.get().uri("/{name}/details", name).retrieve().body(Details::class.java)!! } } ``` ## [](#io.rest-client.resttemplate)RestTemplate Spring Framework’s [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html) class predates [`RestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.html) and is the classic way that many applications use to call remote REST services. You might choose to use [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html) when you have existing code that you don’t want to migrate to [`RestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.html), or because you’re already familiar with the [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html) API. Since [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html) instances often need to be customized before being used, Spring Boot does not provide any single auto-configured [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html) bean. It does, however, auto-configure a [`RestTemplateBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateBuilder.html), which can be used to create [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html) instances when needed. The auto-configured [`RestTemplateBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateBuilder.html) ensures that sensible [`HttpMessageConverters`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/http/converter/autoconfigure/HttpMessageConverters.html) and an appropriate [`ClientHttpRequestFactory`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/http/client/ClientHttpRequestFactory.html) are applied to [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html) instances. The following code shows a typical example: * Java * Kotlin ```java import org.springframework.boot.restclient.RestTemplateBuilder; import org.springframework.stereotype.Service; import org.springframework.web.client.RestTemplate; @Service public class MyService { private final RestTemplate restTemplate; public MyService(RestTemplateBuilder restTemplateBuilder) { this.restTemplate = restTemplateBuilder.build(); } public Details someRestCall(String name) { return this.restTemplate.getForObject("/{name}/details", Details.class, name); } } ``` ```kotlin import org.springframework.boot.restclient.RestTemplateBuilder import org.springframework.stereotype.Service import org.springframework.web.client.RestTemplate @Service class MyService(restTemplateBuilder: RestTemplateBuilder) { private val restTemplate: RestTemplate init { restTemplate = restTemplateBuilder.build() } fun someRestCall(name: String): Details { return restTemplate.getForObject("/{name}/details", Details::class.java, name)!! } } ``` [`RestTemplateBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateBuilder.html) includes a number of useful methods that can be used to quickly configure a [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html). For example, to add BASIC authentication support, you can use `builder.basicAuthentication("user", "password").build()`. ### [](#io.rest-client.resttemplate.customization)RestTemplate Customization There are three main approaches to [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html) customization, depending on how broadly you want the customizations to apply. To make the scope of any customizations as narrow as possible, inject the auto-configured [`RestTemplateBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateBuilder.html) and then call its methods as required. Each method call returns a new [`RestTemplateBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateBuilder.html) instance, so the customizations only affect this use of the builder. To make an application-wide, additive customization, use a [`RestTemplateCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateCustomizer.html) bean. All such beans are automatically registered with the auto-configured [`RestTemplateBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateBuilder.html) and are applied to any templates that are built with it. The following example shows a customizer that configures the use of a proxy for all hosts except `192.168.0.5`: * Java * Kotlin ```java import org.apache.hc.client5.http.classic.HttpClient; import org.apache.hc.client5.http.impl.classic.HttpClientBuilder; import org.apache.hc.client5.http.impl.routing.DefaultProxyRoutePlanner; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.protocol.HttpContext; import org.springframework.boot.restclient.RestTemplateCustomizer; import org.springframework.http.client.HttpComponentsClientHttpRequestFactory; import org.springframework.web.client.RestTemplate; public class MyRestTemplateCustomizer implements RestTemplateCustomizer { @Override public void customize(RestTemplate restTemplate) { HttpRoutePlanner routePlanner = new CustomRoutePlanner(new HttpHost("proxy.example.com")); HttpClient httpClient = HttpClientBuilder.create().setRoutePlanner(routePlanner).build(); restTemplate.setRequestFactory(new HttpComponentsClientHttpRequestFactory(httpClient)); } static class CustomRoutePlanner extends DefaultProxyRoutePlanner { CustomRoutePlanner(HttpHost proxy) { super(proxy); } @Override protected HttpHost determineProxy(HttpHost target, HttpContext context) throws HttpException { if (target.getHostName().equals("192.168.0.5")) { return null; } return super.determineProxy(target, context); } } } ``` ```kotlin import org.apache.hc.client5.http.classic.HttpClient import org.apache.hc.client5.http.impl.classic.HttpClientBuilder import org.apache.hc.client5.http.impl.routing.DefaultProxyRoutePlanner import org.apache.hc.client5.http.routing.HttpRoutePlanner import org.apache.hc.core5.http.HttpException import org.apache.hc.core5.http.HttpHost import org.apache.hc.core5.http.protocol.HttpContext import org.springframework.boot.restclient.RestTemplateCustomizer import org.springframework.http.client.HttpComponentsClientHttpRequestFactory import org.springframework.web.client.RestTemplate class MyRestTemplateCustomizer : RestTemplateCustomizer { override fun customize(restTemplate: RestTemplate) { val routePlanner: HttpRoutePlanner = CustomRoutePlanner(HttpHost("proxy.example.com")) val httpClient: HttpClient = HttpClientBuilder.create().setRoutePlanner(routePlanner).build() restTemplate.requestFactory = HttpComponentsClientHttpRequestFactory(httpClient) } internal class CustomRoutePlanner(proxy: HttpHost?) : DefaultProxyRoutePlanner(proxy) { @Throws(HttpException::class) public override fun determineProxy(target: HttpHost, context: HttpContext): HttpHost? { if (target.hostName == "192.168.0.5") { return null } return super.determineProxy(target, context) } } } ``` Finally, you can define your own [`RestTemplateBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateBuilder.html) bean. Doing so will replace the auto-configured builder. If you want any [`RestTemplateCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateCustomizer.html) beans to be applied to your custom builder, as the auto-configuration would have done, configure it using a [`RestTemplateBuilderConfigurer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/autoconfigure/RestTemplateBuilderConfigurer.html). The following example exposes a [`RestTemplateBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateBuilder.html) that matches what Spring Boot’s auto-configuration would have done, except that custom connect and read timeouts are also specified: * Java * Kotlin ```java import java.time.Duration; import org.springframework.boot.restclient.RestTemplateBuilder; import org.springframework.boot.restclient.autoconfigure.RestTemplateBuilderConfigurer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyRestTemplateBuilderConfiguration { @Bean public RestTemplateBuilder restTemplateBuilder(RestTemplateBuilderConfigurer configurer) { return configurer.configure(new RestTemplateBuilder()) .connectTimeout(Duration.ofSeconds(5)) .readTimeout(Duration.ofSeconds(2)); } } ``` ```kotlin import org.springframework.boot.restclient.autoconfigure.RestTemplateBuilderConfigurer import org.springframework.boot.restclient.RestTemplateBuilder import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import java.time.Duration @Configuration(proxyBeanMethods = false) class MyRestTemplateBuilderConfiguration { @Bean fun restTemplateBuilder(configurer: RestTemplateBuilderConfigurer): RestTemplateBuilder { return configurer.configure(RestTemplateBuilder()).connectTimeout(Duration.ofSeconds(5)) .readTimeout(Duration.ofSeconds(2)) } } ``` The most extreme (and rarely used) option is to create your own [`RestTemplateBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateBuilder.html) bean without using a configurer. In addition to replacing the auto-configured builder, this also prevents any [`RestTemplateCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateCustomizer.html) beans from being used. | | | | -- | ------------------------------------------------------------------------------------------------------------------- | | ** | You can also change the [global HTTP client configuration](#io.rest-client.clienthttprequestfactory.configuration). | ### [](#io.rest-client.resttemplate.ssl)RestTemplate SSL Support If you need custom SSL configuration on the [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html), you can apply an [SSL bundle](../features/ssl.html#features.ssl.bundles) to the [`RestTemplateBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/restclient/RestTemplateBuilder.html) as shown in this example: * Java * Kotlin ```java import org.springframework.boot.docs.io.restclient.resttemplate.Details; import org.springframework.boot.restclient.RestTemplateBuilder; import org.springframework.boot.ssl.SslBundles; import org.springframework.stereotype.Service; import org.springframework.web.client.RestTemplate; @Service public class MyService { private final RestTemplate restTemplate; public MyService(RestTemplateBuilder restTemplateBuilder, SslBundles sslBundles) { this.restTemplate = restTemplateBuilder.sslBundle(sslBundles.getBundle("mybundle")).build(); } public Details someRestCall(String name) { return this.restTemplate.getForObject("/{name}/details", Details.class, name); } } ``` ```kotlin import org.springframework.boot.docs.io.restclient.resttemplate.Details import org.springframework.boot.ssl.SslBundles import org.springframework.boot.restclient.RestTemplateBuilder import org.springframework.stereotype.Service import org.springframework.web.client.RestTemplate @Service class MyService(restTemplateBuilder: RestTemplateBuilder, sslBundles: SslBundles) { private val restTemplate: RestTemplate init { restTemplate = restTemplateBuilder.sslBundle(sslBundles.getBundle("mybundle")).build() } fun someRestCall(name: String): Details { return restTemplate.getForObject("/{name}/details", Details::class.java, name)!! } } ``` ## [](#io.rest-client.clienthttprequestfactory)HTTP Client Detection for RestClient and RestTemplate Spring Boot will auto-detect which HTTP client to use with [`RestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.html) and [`RestTemplate`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestTemplate.html) depending on the libraries available on the application classpath. In order of preference, the following clients are supported: 1. Apache HttpClient 2. Jetty HttpClient 3. Reactor Netty HttpClient 4. JDK client (`java.net.http.HttpClient`) 5. Simple JDK client (`java.net.HttpURLConnection`) If multiple clients are available on the classpath, and no global configuration is provided, the most preferred client will be used. ### [](#io.rest-client.clienthttprequestfactory.configuration)Global HTTP Client Configuration If the auto-detected HTTP client does not meet your needs, you can use the `spring.http.clients.imperative.factory` property to pick a specific factory. For example, if you have Apache HttpClient on your classpath, but you prefer Jetty’s [`HttpClient`](https://javadoc.jetty.org/jetty-12/org/eclipse/jetty/client/HttpClient.html) you can add the following: * Properties * YAML ```properties spring.http.clients.imperative.factory=jetty ``` ```yaml spring: http: clients: imperative: factory: jetty ``` | | | | -- | ------------------------------------------------------------------------------------------------------------------------- | | ** | You can also use [global configuration properties](#io.rest-client.global-configuration) which apply to all HTTP clients. | For more complex customizations, you can use [`ClientHttpRequestFactoryBuilderCustomizer`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/http/client/autoconfigure/ClientHttpRequestFactoryBuilderCustomizer.html) or declare your own [`ClientHttpRequestFactoryBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/http/client/ClientHttpRequestFactoryBuilder.html) bean which will cause auto-configuration to back off. This can be useful when you need to customize some of the internals of the underlying HTTP library. For example, the following will use a JDK client configured with a specific [`ProxySelector`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/ProxySelector.html): * Java * Kotlin ```java import java.net.ProxySelector; import org.springframework.boot.http.client.ClientHttpRequestFactoryBuilder; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyClientHttpConfiguration { @Bean ClientHttpRequestFactoryBuilder clientHttpRequestFactoryBuilder(ProxySelector proxySelector) { return ClientHttpRequestFactoryBuilder.jdk() .withHttpClientCustomizer((builder) -> builder.proxy(proxySelector)); } } ``` ```kotlin import org.springframework.boot.http.client.ClientHttpRequestFactoryBuilder import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import java.net.ProxySelector @Configuration(proxyBeanMethods = false) class MyClientHttpConfiguration { @Bean fun clientHttpRequestFactoryBuilder(proxySelector: ProxySelector): ClientHttpRequestFactoryBuilder<*> { return ClientHttpRequestFactoryBuilder.jdk() .withHttpClientCustomizer { builder -> builder.proxy(proxySelector) } } } ``` ## [](#io.rest-client.apiversioning)API Versioning Both `WebClient` and `RestClient` support making versioned remote HTTP calls so that APIs can be evolved over time. Commonly this involves sending an HTTP header, a query parameter or URL path segment that indicates the version of the API that should be used. You can configure API versioning using methods on `WebClient.Builder` or `RestClient.Builder`. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | API versioning is also supported on the server-side. See the [Spring MVC](../web/servlet.html#web.servlet.spring-mvc.api-versioning) and [Spring WebFlux](../web/reactive.html#web.reactive.webflux.api-versioning) sections for details. | | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | The server-side API versioning configuration is not taken into account to auto-configure the client. Clients that should use an API versioning strategy, typically for testing, need to configure it explicitly. | ## [](#io.rest-client.httpservice)HTTP Service Interface Clients Instead of directly using a [`RestClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/RestClient.html) or [`WebClient`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html) to call an HTTP service, it’s also possible to call them using annotated Java interfaces. HTTP Service interfaces defines a service contract by using methods that are annotated with [`@HttpExchange`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/service/annotation/HttpExchange.html), or more typically the method specific variants ([`@GetExchange`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/service/annotation/GetExchange.html), [`@PostExchange`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/service/annotation/PostExchange.html), [`@DeleteExchange`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/service/annotation/DeleteExchange.html), etc). For example, the following code defines an HTTP Service for an “echo” API that will return a JSON object containing an echo of the request. * Java * Kotlin ```java import java.util.Map; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.service.annotation.HttpExchange; import org.springframework.web.service.annotation.PostExchange; @HttpExchange(url = "https://echo.zuplo.io") public interface EchoService { @PostExchange Map echo(@RequestBody Map message); } ``` ```kotlin import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.service.annotation.HttpExchange import org.springframework.web.service.annotation.PostExchange @HttpExchange(url = "https://echo.zuplo.io") interface EchoService { @PostExchange fun echo(@RequestBody message: Map): Map<*, *> } ``` More details about how to develop HTTP Service interface clients can be found in the [Spring Framework reference documentation](https://docs.spring.io/spring-framework/reference/7.0/integration/rest-clients.html#rest-http-service-client). ### [](#io.rest-client.httpservice.importing)Importing HTTP Services In order to use an HTTP Service interface as client you need to import it. One way to achieve this is to use the [`@ImportHttpServices`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/service/registry/ImportHttpServices.html) annotation, typically on your main application class. You can use the annotation to import specific classes, or scan for classes to import from specific packages. For example, the following configuration will scan for HTTP Service interfaces in the `com.example.myclients` package: * Java * Kotlin ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.web.service.registry.ImportHttpServices; @SpringBootApplication @ImportHttpServices(basePackages = "com.example.myclients") public class MyApplication { public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } ``` ```kotlin import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.runApplication import org.springframework.web.service.registry.ImportHttpServices @SpringBootApplication @ImportHttpServices(basePackages = ["com.example.myclients"]) class MyApplication fun main(args: Array) { runApplication(*args) } ``` ### [](#io.rest-client.httpservice.groups)Service Client Groups Hard-coding absolute URLs in [`@HttpExchange`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/service/annotation/HttpExchange.html) annotations is often not ideal in production applications. Instead, you will typically want to give the HTTP Service client a logical name in your code, and then lookup a URL from a property based on that name. HTTP Service clients allow you to do this by registering them into named groups. An HTTP Service group is a collection of HTTP Service interfaces that all share common features. For example, we may want to define an “echo” group to use for HTTP Service clients that call `https://echo.zuplo.io`. | | | | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | HTTP Service groups can be used to define more than just URLs. For example, your group could define connection timeouts and SSL settings. You can also associate client customization logic to a group, such as adding code to insert required authorization headers. | To associate an HTTP Service interface with a group when using [`@ImportHttpServices`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/service/registry/ImportHttpServices.html) you can use the `group` attribute. For example, if we assume our example above is organized in such a way that all HTTP Service interfaces in the `com.example.myclients` package belong to the `echo` group. We first remove the hardcoded URL from the service interface: * Java * Kotlin ```java import java.util.Map; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.service.annotation.PostExchange; public interface EchoService { @PostExchange Map echo(@RequestBody Map message); } ``` ```kotlin import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.service.annotation.HttpExchange import org.springframework.web.service.annotation.PostExchange interface EchoService { @PostExchange fun echo(@RequestBody message: Map): Map<*, *> } ``` We can then write: * Java * Kotlin ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.web.service.registry.ImportHttpServices; @SpringBootApplication @ImportHttpServices(group = "echo", basePackages = "com.example.myclients") public class MyApplication { public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } ``` ```kotlin import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.runApplication import org.springframework.web.service.registry.ImportHttpServices @SpringBootApplication @ImportHttpServices(group = "echo", basePackages = ["com.example.myclients"]) class MyApplication fun main(args: Array) { runApplication(*args) } ``` And finally we can then use a `base-url` property to link the `echo` group to an actual URL: * Properties * YAML ```properties spring.http.serviceclient.echo.base-url=https://echo.zuplo.io ``` ```yaml spring: http: serviceclient: echo: base-url: "https://echo.zuplo.io" ``` | | | | -- | -------------------------------------------------------------------------------------------------- | | ** | HTTP Service clients will be associated with a group named “default” if you don’t specify a group. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | If you have multiple HTTP Service interfaces in the same package that need to be associated with different groups you can list them individually. The [`@ImportHttpServices`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/service/registry/ImportHttpServices.html) is repeatable and the `types` attributes allows you to import individual classes.For example:- Java - Kotlin```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.web.service.registry.ImportHttpServices; @SpringBootApplication @ImportHttpServices(group = "echo", types = EchoService.class) @ImportHttpServices(group = "other", types = OtherService.class) public class MyApplication { public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } ``````kotlin import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.runApplication import org.springframework.web.service.registry.ImportHttpServices @SpringBootApplication @ImportHttpServices(group = "echo", types = [EchoService::class]) @ImportHttpServices(group = "other", types = [OtherService::class]) class MyApplication fun main(args: Array) { runApplication(*args) } ``` | ### [](#io.rest-client.httpservice.properties)Configuration Properties Configuration properties for HTTP Services can be specified under `spring.http.serviceclient.`: You can use properties to configure aspects such as: * The base URL. * Any default headers that should be sent. * API versioning configuration. * Redirect settings. * Connection and read timeouts. * SSL bundles to use. | | | | -- | ------------------------------------------------------------------------------------------------------------------------- | | ** | You can also use [global configuration properties](#io.rest-client.global-configuration) which apply to all HTTP clients. | For example, the properties below will: * Configure all HTTP clients to use a one second connect timeout (unless otherwise overridden). * Configure HTTP Service clients in the “echo” group to: * Use a specific base URL. * Have a one-second connect timeout. * Have a two-second read timeout. - Properties - YAML ```properties spring.http.clients.connect-timeout=1s spring.http.serviceclient.echo.base-url=https://echo.zuplo.io spring.http.serviceclient.echo.connect-timeout=2s spring.http.serviceclient.echo.read-timeout=2s ``` ```yaml spring: http: clients: connect-timeout: 1s serviceclient: echo: base-url: "https://echo.zuplo.io" connect-timeout: 2s read-timeout: 2s ``` ### [](#io.rest-client.httpservice.customization)Customization If you need to customize HTTP Service clients beyond basic properties, you can use an HTTP Service group configurer. For `RestClient` backed HTTP Service clients, you can declare a bean that implements [`RestClientHttpServiceGroupConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/client/support/RestClientHttpServiceGroupConfigurer.html). For `WebClient` backed HTTP Service clients you can declare a bean that implements [`WebClientHttpServiceGroupConfigurer`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/reactive/function/client/support/WebClientHttpServiceGroupConfigurer.html). Both work in the same way and will be automatically applied by Spring Boot’s auto-configuration. For example, the following configuration would add a group customizer that adds an HTTP header to each outgoing request containing the group name: * Java * Kotlin ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.web.client.support.RestClientHttpServiceGroupConfigurer; @Configuration(proxyBeanMethods = false) public class MyHttpServiceGroupConfiguration { @Bean RestClientHttpServiceGroupConfigurer myHttpServiceGroupConfigurer() { return (groups) -> groups.forEachClient((group, clientBuilder) -> { String groupName = group.name(); clientBuilder.defaultHeader("service-group", groupName); }); } } ``` ```kotlin import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration import org.springframework.web.client.support.RestClientHttpServiceGroupConfigurer @Configuration(proxyBeanMethods = false) class MyHttpServiceGroupConfiguration { @Bean fun myHttpServiceGroupConfigurer(): RestClientHttpServiceGroupConfigurer { return RestClientHttpServiceGroupConfigurer { groups -> groups.forEachClient { group, clientBuilder -> val groupName = group.name() clientBuilder.defaultHeader("service-group", groupName) } } } } ``` ### [](#io.rest-client.httpservice.advanced-configuration)Advanced Configuration As well as the [`@ImportHttpServices`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/service/registry/ImportHttpServices.html) annotation, Spring Framework also offers an [`AbstractHttpServiceRegistrar`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/web/service/registry/AbstractHttpServiceRegistrar.html) class. You can [`@Import`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Import.html) your own extension of this class to perform programmatic configuration. For more details, see [Spring Framework reference documentation](https://docs.spring.io/spring-framework/reference/7.0/integration/rest-clients.html#rest-http-service-client-group-config). Regardless of which method you use to register HTTP Service clients, Spring Boot’s support remains the same. ## [](#io.rest-client.global-configuration)Applying Global Configuration to All HTTP Clients Regardless of the underlying technology being used, all HTTP clients have common settings that can be configured. These include: * Connection Timeouts. * Read Timeouts. * How HTTP redirects should be handled. * Which SSL bundle should be used when connecting. These common settings are represented by the [`HttpClientSettings`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/http/client/HttpClientSettings.html) class which can be passed into the `build(…​)` methods of [`ClientHttpConnectorBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/http/client/reactive/ClientHttpConnectorBuilder.html) and [`ClientHttpRequestFactoryBuilder`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/http/client/ClientHttpRequestFactoryBuilder.html). If you want to apply the same configuration to all auto-configured clients, you can use `spring.http.clients` properties to do so: * Properties * YAML ```properties spring.http.clients.connect-timeout=2s spring.http.clients.read-timeout=1s spring.http.clients.redirects=dont-follow ``` ```yaml spring: http: clients: connect-timeout: 2s read-timeout: 1s redirects: dont-follow ``` ### [](#io.rest-client.global-configuration.inetaddress-filtering)InetAddress Filtering and SSRF Protection It’s sometimes useful to limit the remote addresses that an HTTP client is permitted to call. This technique can be especially useful when hardening your application against Server-Side Request Forgery (SSRF) attacks. To limit the address that a client can call, you can use an [`InetAddressFilter`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/http/client/InetAddressFilter.html) which will only allow outgoing calls to addresses that match the filter. The filter is a functional interface and you can either create your own implementation, or use one of the convenient factory methods. Filters may be applied to the [`HttpClientSettings`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/http/client/HttpClientSettings.html) you used when building a client: * Java * Kotlin ```java import org.springframework.boot.http.client.ClientHttpRequestFactoryBuilder; import org.springframework.boot.http.client.HttpClientSettings; import org.springframework.boot.http.client.InetAddressFilter; import org.springframework.http.client.ClientHttpRequestFactory; import org.springframework.stereotype.Service; import org.springframework.web.client.RestClient; @Service public class MyService { private final RestClient restClient; public MyService() { InetAddressFilter onlyExternalAddresses = InetAddressFilter.externalAddresses(); HttpClientSettings settings = HttpClientSettings.defaults().withInetAddressFilter(onlyExternalAddresses); ClientHttpRequestFactory requestFactory = ClientHttpRequestFactoryBuilder.jdk().build(settings); this.restClient = RestClient.builder().requestFactory(requestFactory).baseUrl("https://example.org").build(); } public Details someRestCall(String name) { return this.restClient.get().uri("/{name}/details", name).retrieve().body(Details.class); } } ``` ```kotlin import org.springframework.boot.http.client.ClientHttpRequestFactoryBuilder import org.springframework.boot.http.client.HttpClientSettings import org.springframework.boot.http.client.InetAddressFilter import org.springframework.http.client.ClientHttpRequestFactory import org.springframework.stereotype.Service import org.springframework.web.client.RestClient @Service class MyService { private val restClient: RestClient init { val onlyExternalAddresses = InetAddressFilter.externalAddresses() val settings = HttpClientSettings.defaults().withInetAddressFilter(onlyExternalAddresses) val requestFactory: ClientHttpRequestFactory = ClientHttpRequestFactoryBuilder.jdk().build(settings) restClient = RestClient.builder().requestFactory(requestFactory).baseUrl("https://example.org").build() } fun someRestCall(name: String?): Details { return restClient.get().uri("/{name}/details", name) .retrieve().body(Details::class.java)!! } } ``` Or you can also define one as a [`@Bean`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Bean.html) if you want to apply it to all auto-configured HTTP client builders: * Java * Kotlin ```java import org.springframework.boot.http.client.InetAddressFilter; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration(proxyBeanMethods = false) public class MyHttpClientConfiguration { @Bean public InetAddressFilter httpClientInetAddressFilter() { return InetAddressFilter.of("192.168.1.0/24").andNot("192.168.1.1", "192.168.1.10"); } } ``` ```kotlin import org.springframework.boot.http.client.InetAddressFilter import org.springframework.context.annotation.Bean import org.springframework.context.annotation.Configuration @Configuration(proxyBeanMethods = false) class MyHttpClientConfiguration { @Bean fun httpClientInetAddressFilter(): InetAddressFilter { return InetAddressFilter.of("192.168.1.0/24").andNot("192.168.1.1", "192.168.1.10") } } ``` * [Spring Boot](../../index.html) * [4.1.1](rest-client.html) * [4.0.8](../../4.0/reference/io/rest-client.html) * [3.5.16](../../3.5/reference/io/rest-client.html) * [3.4.13](../../3.4/reference/io/rest-client.html) * [3.3.13](../../3.3/reference/io/rest-client.html) - [4.2.0-M2](../../4.2/reference/io/rest-client.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/io/rest-client.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/io/rest-client.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/io/rest-client.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/actuator/process-monitoring.html ---- # Process Monitoring In the `spring-boot` module, you can find two classes to create files that are often useful for process monitoring: * [`ApplicationPidFileWriter`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/context/ApplicationPidFileWriter.html) creates a file that contains the application PID (by default, in the application directory with a file name of `application.pid`). * [`WebServerPortFileWriter`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/web/server/context/WebServerPortFileWriter.html) creates a file (or files) that contain the ports of the running web server (by default, in the application directory with a file name of `application.port`). By default, these writers are not activated, but you can enable them: * [Extending Configuration](#actuator.process-monitoring.configuration) * [Programmatically Enabling Process Monitoring](#actuator.process-monitoring.programmatically) ## [](#actuator.process-monitoring.configuration)Extending Configuration In the `META-INF/spring.factories` file, you can activate the listener (or listeners) that writes a PID file: ```none org.springframework.context.ApplicationListener=\ org.springframework.boot.context.ApplicationPidFileWriter,\ org.springframework.boot.web.server.context.WebServerPortFileWriter ``` ## [](#actuator.process-monitoring.programmatically)Programmatically Enabling Process Monitoring You can also activate a listener by invoking the `SpringApplication.addListeners(…​)` method and passing the appropriate [`Writer`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Writer.html) object. This method also lets you customize the file name and path in the [`Writer`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Writer.html) constructor. * [Spring Boot](../../index.html) * [4.1.1](process-monitoring.html) * [4.0.8](../../4.0/reference/actuator/process-monitoring.html) * [3.5.16](../../3.5/reference/actuator/process-monitoring.html) * [3.4.13](../../3.4/reference/actuator/process-monitoring.html) * [3.3.13](../../3.3/reference/actuator/process-monitoring.html) - [4.2.0-M2](../../4.2/reference/actuator/process-monitoring.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/actuator/process-monitoring.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/actuator/process-monitoring.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/actuator/process-monitoring.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/util/VersionExtractor.html ---- # Class VersionExtractor [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.springframework.boot.gradle.util.VersionExtractor *** public final class VersionExtractor extends [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") Extracts version information for a Class. * Since: 2.3.0 * Author: Andy Wilkinson, Scott Frederick - ## Method Summary Modifier and Type Method Description `static @Nullable String` `forClass(Class cls)` Return the version information for the provided [`Class`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html "class or interface in java.lang"). ### Methods inherited from class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary "class or interface in java.lang") `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait` * ## Method Details * ### forClass public static @Nullable [String](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html "class or interface in java.lang") forClass​([Class](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html "class or interface in java.lang")\ cls) Return the version information for the provided [`Class`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html "class or interface in java.lang"). * Parameters: `cls` - the Class to retrieve the version for * Returns: the version, or `null` if a version can not be extracted ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/org/springframework/boot/maven/ProcessAotMojo.html ---- # Class ProcessAotMojo [java.lang.Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") org.apache.maven.plugin.AbstractMojo [org.springframework.boot.maven.AbstractDependencyFilterMojo](AbstractDependencyFilterMojo.html "class in org.springframework.boot.maven") [org.springframework.boot.maven.AbstractAotMojo](AbstractAotMojo.html "class in org.springframework.boot.maven") org.springframework.boot.maven.ProcessAotMojo * All Implemented Interfaces: `org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo` *** @Mojo(name="process-aot", defaultPhase=PREPARE\_PACKAGE, threadSafe=true, requiresDependencyResolution=COMPILE\_PLUS\_RUNTIME, requiresDependencyCollection=COMPILE\_PLUS\_RUNTIME) public class ProcessAotMojo extends [AbstractAotMojo](AbstractAotMojo.html "class in org.springframework.boot.maven") Invoke the AOT engine on the application. * Since: 3.0.0 * Author: Stephane Nicoll, Andy Wilkinson `ProcessAotMojo(org.apache.maven.toolchain.ToolchainManager toolchainManager)`   - ## Method Summary Modifier and Type Method Description `protected void` `executeAot()` * ### ProcessAotMojo @Inject public ProcessAotMojo​(org.apache.maven.toolchain.ToolchainManager toolchainManager) * ## Method Details * ### executeAot protected void executeAot() throws [Exception](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html "class or interface in java.lang") * Specified by: `executeAot` in class `AbstractAotMojo` * Throws: `Exception` ---- url: https://docs.spring.io/spring-boot/maven-plugin/api/java/index-files/index-10.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ## J * [JAR](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html#JAR) - Enum constant in enum class org.springframework.boot.maven.[AbstractPackagerMojo.LayoutType](../org/springframework/boot/maven/AbstractPackagerMojo.LayoutType.html "enum class in org.springframework.boot.maven") Jar Layout. [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [H](index-8.html) [I](index-9.html) [J](index-10.html) [L](index-11.html) [M](index-12.html) [N](index-13.html) [O](index-14.html) [P](index-15.html) [R](index-16.html) [S](index-17.html) [T](index-18.html) [V](index-19.html) [W](index-20.html) [Z](index-21.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/org/springframework/boot/gradle/tasks/bundling/class-use/CacheSpec.html ---- Uses of Class\ org.springframework.boot.gradle.tasks.bundling.CacheSpec ======================================================== Packages that use [CacheSpec](../CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Package Description [org.springframework.boot.gradle.tasks.bundling](#org.springframework.boot.gradle.tasks.bundling) Support for creating executable jars and wars. * ## Uses of [CacheSpec](../CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) Methods in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) that return [CacheSpec](../CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Modifier and Type Method Description `CacheSpec` BootBuildImage.`getBuildCache()` Returns the build cache that will be used when building the image. `CacheSpec` BootBuildImage.`getBuildWorkspace()` Returns the build temporary workspace that will be used when building the image. `CacheSpec` BootBuildImage.`getLaunchCache()` Returns the launch cache that will be used when building the image. Method parameters in [org.springframework.boot.gradle.tasks.bundling](../package-summary.html) with type arguments of type [CacheSpec](../CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") Modifier and Type Method Description `void` BootBuildImage.`buildCache(Action action)` Customizes the [`CacheSpec`](../CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") for the build cache using the given `action`. `void` BootBuildImage.`buildWorkspace(Action action)` Customizes the [`CacheSpec`](../CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") for the build temporary workspace using the given `action`. `void` BootBuildImage.`launchCache(Action action)` Customizes the [`CacheSpec`](../CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") for the launch cache using the given `action`. ---- url: https://docs.spring.io/spring-boot/reference/actuator/jmx.html ---- # Monitoring and Management over JMX Java Management Extensions (JMX) provide a standard mechanism to monitor and manage applications. By default, this feature is not enabled. You can turn it on by setting the `spring.jmx.enabled` configuration property to `true`. Spring Boot exposes the most suitable [`MBeanServer`](https://docs.oracle.com/en/java/javase/17/docs/api/java.management/javax/management/MBeanServer.html) as a bean with an ID of `mbeanServer`. Any of your beans that are annotated with Spring JMX annotations (`@org.springframework.jmx.export.annotation.ManagedResource`, [`@ManagedAttribute`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jmx/export/annotation/ManagedAttribute.html), or [`@ManagedOperation`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/jmx/export/annotation/ManagedOperation.html)) are exposed to it. If your platform provides a standard [`MBeanServer`](https://docs.oracle.com/en/java/javase/17/docs/api/java.management/javax/management/MBeanServer.html), Spring Boot uses that and defaults to the VM [`MBeanServer`](https://docs.oracle.com/en/java/javase/17/docs/api/java.management/javax/management/MBeanServer.html), if necessary. If all that fails, a new [`MBeanServer`](https://docs.oracle.com/en/java/javase/17/docs/api/java.management/javax/management/MBeanServer.html) is created. | | | | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | `spring.jmx.enabled` affects only the management beans provided by Spring. Enabling management beans provided by other libraries (for example [Log4j2](https://logging.apache.org/log4j/2.x/manual/jmx.html) or [Quartz](https://javadoc.io/doc/org.quartz-scheduler/quartz/2.5.2/constant-values.html#org.quartz.impl.StdSchedulerFactory.PROP_SCHED_JMX_EXPORT)) is independent. | See the [`JmxAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/v4.1.1/core/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jmx/JmxAutoConfiguration.java) class for more details. By default, Spring Boot also exposes management endpoints as JMX MBeans under the `org.springframework.boot` domain. To take full control over endpoint registration in the JMX domain, consider registering your own [`EndpointObjectNameFactory`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/actuate/endpoint/jmx/EndpointObjectNameFactory.html) implementation. ## [](#actuator.jmx.custom-mbean-names)Customizing MBean Names The name of the MBean is usually generated from the `id` of the endpoint. For example, the `health` endpoint is exposed as `org.springframework.boot:type=Endpoint,name=Health`. If your application contains more than one Spring [`ApplicationContext`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/ApplicationContext.html), you may find that names clash. To solve this problem, you can set the `spring.jmx.unique-names` property to `true` so that MBean names are always unique. You can also customize the JMX domain under which endpoints are exposed. The following settings show an example of doing so in `application.properties`: * Properties * YAML ```properties spring.jmx.unique-names=true management.endpoints.jmx.domain=com.example.myapp ``` ```yaml spring: jmx: unique-names: true management: endpoints: jmx: domain: "com.example.myapp" ``` ## [](#actuator.jmx.disable-jmx-endpoints)Disabling JMX Endpoints If you do not want to expose endpoints over JMX, you can set the `management.endpoints.jmx.exposure.exclude` property to `*`, as the following example shows: * Properties * YAML ```properties management.endpoints.jmx.exposure.exclude=* ``` ```yaml management: endpoints: jmx: exposure: exclude: "*" ``` * [Spring Boot](../../index.html) * [4.1.1](jmx.html) * [4.0.8](../../4.0/reference/actuator/jmx.html) * [3.5.16](../../3.5/reference/actuator/jmx.html) * [3.4.13](../../3.4/reference/actuator/jmx.html) * [3.3.13](../../3.3/reference/actuator/jmx.html) - [4.2.0-M2](../../4.2/reference/actuator/jmx.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/actuator/jmx.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/actuator/jmx.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/actuator/jmx.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/reference/using/auto-configuration.html ---- # Auto-configuration Spring Boot auto-configuration attempts to automatically configure your Spring application based on the jar dependencies that you have added. For example, if `HSQLDB` is on your classpath, and you have not manually configured any database connection beans, then Spring Boot auto-configures an in-memory database. You need to opt-in to auto-configuration by adding the [`@EnableAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/EnableAutoConfiguration.html) or [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html) annotations to one of your [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) classes. | | | | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | You should only ever add one [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html) or [`@EnableAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/EnableAutoConfiguration.html) annotation. We generally recommend that you add one or the other to your primary [`@Configuration`](https://docs.spring.io/spring-framework/docs/7.0.x/javadoc-api/org/springframework/context/annotation/Configuration.html) class only. | ## [](#using.auto-configuration.replacing)Gradually Replacing Auto-configuration Auto-configuration is non-invasive. At any point, you can start to define your own configuration to replace specific parts of the auto-configuration. For example, if you add your own [`DataSource`](https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html) bean, the default embedded database support backs away. If you need to find out what auto-configuration is currently being applied, and why, start your application with the `--debug` switch. Doing so enables debug logs for a selection of core loggers and logs a conditions report to the console. ## [](#using.auto-configuration.disabling-specific)Disabling Specific Auto-configuration Classes If you find that specific auto-configuration classes that you do not want are being applied, you can use the exclude attribute of [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html) to disable them, as shown in the following example: * Java * Kotlin ```java import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.jdbc.autoconfigure.DataSourceAutoConfiguration; @SpringBootApplication(exclude = { DataSourceAutoConfiguration.class }) public class MyApplication { } ``` ```kotlin import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.jdbc.autoconfigure.DataSourceAutoConfiguration @SpringBootApplication(exclude = [DataSourceAutoConfiguration::class]) class MyApplication ``` If the class is not on the classpath, you can use the `excludeName` attribute of the annotation and specify the fully qualified name instead. If you prefer to use [`@EnableAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/EnableAutoConfiguration.html) rather than [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html), `exclude` and `excludeName` are also available. Finally, you can also control the list of auto-configuration classes to exclude by using the `spring.autoconfigure.exclude` property. | | | | -- | --------------------------------------------------------------------------------- | | ** | You can define exclusions both at the annotation level and by using the property. | | | | | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ** | Even though auto-configuration classes are `public`, the only aspect of the class that is considered public API is the name of the class which can be used for disabling the auto-configuration. The actual contents of those classes, such as nested configuration classes or bean methods are for internal use only and we do not recommend using those directly. | ## [](#using.auto-configuration.packages)Auto-configuration Packages Auto-configuration packages are the packages that various auto-configured features look in by default when scanning for things such as entities and Spring Data repositories. The [`@EnableAutoConfiguration`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/EnableAutoConfiguration.html) annotation (either directly or through its presence on [`@SpringBootApplication`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/SpringBootApplication.html)) determines the default auto-configuration package. Additional packages can be configured using the [`@AutoConfigurationPackage`](https://docs.spring.io/spring-boot/4.1.1/api/java/org/springframework/boot/autoconfigure/AutoConfigurationPackage.html) annotation. * [Spring Boot](../../index.html) * [4.1.1](auto-configuration.html) * [4.0.8](../../4.0/reference/using/auto-configuration.html) * [3.5.16](../../3.5/reference/using/auto-configuration.html) * [3.4.13](../../3.4/reference/using/auto-configuration.html) * [3.3.13](../../3.3/reference/using/auto-configuration.html) - [4.2.0-M2](../../4.2/reference/using/auto-configuration.html) * [4.2.0-SNAPSHOT](../../4.2-SNAPSHOT/reference/using/auto-configuration.html) * [4.1.3-SNAPSHOT](../../4.1-SNAPSHOT/reference/using/auto-configuration.html) * [4.0.10-SNAPSHOT](../../4.0-SNAPSHOT/reference/using/auto-configuration.html) - Related Spring Documentation * [Spring Boot](https://docs.spring.io/spring-boot/) * [Spring Framework](https://docs.spring.io/spring-framework/reference/) * [**]()Spring Cloud * [Spring Cloud Build](https://docs.spring.io/spring-cloud-build/reference/) * [Spring Cloud Bus](https://docs.spring.io/spring-cloud-bus/reference/) * [Spring Cloud Circuit Breaker](https://docs.spring.io/spring-cloud-circuitbreaker/reference/) * [Spring Cloud Commons](https://docs.spring.io/spring-cloud-commons/reference/) * [Spring Cloud Config](https://docs.spring.io/spring-cloud-config/reference/) * [Spring Cloud Consul](https://docs.spring.io/spring-cloud-consul/reference/) * [Spring Cloud Contract](https://docs.spring.io/spring-cloud-contract/reference/) * [Spring Cloud Function](https://docs.spring.io/spring-cloud-function/reference/) * [Spring Cloud Gateway](https://docs.spring.io/spring-cloud-gateway/reference/) * [Spring Cloud Kubernetes](https://docs.spring.io/spring-cloud-kubernetes/reference/) * [Spring Cloud Netflix](https://docs.spring.io/spring-cloud-netflix/reference/) * [Spring Cloud OpenFeign](https://docs.spring.io/spring-cloud-openfeign/reference/) * [Spring Cloud Stream](https://docs.spring.io/spring-cloud-stream/reference/) * [Spring Cloud Task](https://docs.spring.io/spring-cloud-task/reference/) * [Spring Cloud Vault](https://docs.spring.io/spring-cloud-vault/reference/) * [Spring Cloud Zookeeper](https://docs.spring.io/spring-cloud-zookeeper/reference/) * [**]()Spring Data * [Spring Data Cassandra](https://docs.spring.io/spring-data/cassandra/reference/) * [Spring Data Commons](https://docs.spring.io/spring-data/commons/reference/) * [Spring Data Couchbase](https://docs.spring.io/spring-data/couchbase/reference/) * [Spring Data Elasticsearch](https://docs.spring.io/spring-data/elasticsearch/reference/) * [Spring Data JPA](https://docs.spring.io/spring-data/jpa/reference/) * [Spring Data KeyValue](https://docs.spring.io/spring-data/keyvalue/reference/) * [Spring Data LDAP](https://docs.spring.io/spring-data/ldap/reference/) * [Spring Data MongoDB](https://docs.spring.io/spring-data/mongodb/reference/) * [Spring Data Neo4j](https://docs.spring.io/spring-data/neo4j/reference/) * [Spring Data Redis](https://docs.spring.io/spring-data/redis/reference/) * [Spring Data JDBC & R2DBC](https://docs.spring.io/spring-data/relational/reference/) * [Spring Data REST](https://docs.spring.io/spring-data/rest/reference/) * [Spring Integration](https://docs.spring.io/spring-integration/reference/) * [Spring Batch](https://docs.spring.io/spring-batch/reference/) * [**]()[Spring Security](https://docs.spring.io/spring-security/reference/) * [Spring Authorization Server](https://docs.spring.io/spring-authorization-server/reference/) * [Spring LDAP](https://docs.spring.io/spring-ldap/reference/) * [Spring Security Kerberos](https://docs.spring.io/spring-security-kerberos/reference/) * [Spring Session](https://docs.spring.io/spring-session/reference/) * [Spring Vault](https://docs.spring.io/spring-vault/reference/) ---- url: https://docs.spring.io/spring-boot/gradle-plugin/api/java/index-files/index-9.html ---- # Index [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html) ## L * [launchCache(Action)](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html#launchCache\(org.gradle.api.Action\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootBuildImage](../org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html "class in org.springframework.boot.gradle.tasks.bundling") Customizes the [`CacheSpec`](../org/springframework/boot/gradle/tasks/bundling/CacheSpec.html "class in org.springframework.boot.gradle.tasks.bundling") for the launch cache using the given `action`. * [layered(Action)](../org/springframework/boot/gradle/tasks/bundling/BootJar.html#layered\(org.gradle.api.Action\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootJar](../org/springframework/boot/gradle/tasks/bundling/BootJar.html "class in org.springframework.boot.gradle.tasks.bundling") Configures the jar's layering using the given `action`. * [layered(Action)](../org/springframework/boot/gradle/tasks/bundling/BootWar.html#layered\(org.gradle.api.Action\)) - Method in class org.springframework.boot.gradle.tasks.bundling.[BootWar](../org/springframework/boot/gradle/tasks/bundling/BootWar.html "class in org.springframework.boot.gradle.tasks.bundling") Configures the war's layering using the given `action`. * [LayeredSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling") - Class in [org.springframework.boot.gradle.tasks.bundling](../org/springframework/boot/gradle/tasks/bundling/package-summary.html) Encapsulates the configuration for a layered archive. * [LayeredSpec(ObjectFactory)](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html#%3Cinit%3E\(org.gradle.api.model.ObjectFactory\)) - Constructor for class org.springframework.boot.gradle.tasks.bundling.[LayeredSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.html "class in org.springframework.boot.gradle.tasks.bundling")   * [LayeredSpec.ApplicationSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.ApplicationSpec.html "class in org.springframework.boot.gradle.tasks.bundling") - Class in [org.springframework.boot.gradle.tasks.bundling](../org/springframework/boot/gradle/tasks/bundling/package-summary.html) An [`LayeredSpec.IntoLayersSpec`](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which application classes and resources belong. * [LayeredSpec.DependenciesIntoLayerSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesIntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") - Class in [org.springframework.boot.gradle.tasks.bundling](../org/springframework/boot/gradle/tasks/bundling/package-summary.html) Spec that controls the dependencies that should be part of a particular layer. * [LayeredSpec.DependenciesSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.DependenciesSpec.html "class in org.springframework.boot.gradle.tasks.bundling") - Class in [org.springframework.boot.gradle.tasks.bundling](../org/springframework/boot/gradle/tasks/bundling/package-summary.html) An [`LayeredSpec.IntoLayersSpec`](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") that controls the layers to which dependencies belong. * [LayeredSpec.IntoLayerSpec](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayerSpec.html "class in org.springframework.boot.gradle.tasks.bundling") - Class in [org.springframework.boot.gradle.tasks.bundling](../org/springframework/boot/gradle/tasks/bundling/package-summary.html) Spec that controls the content that should be part of a particular layer. * [LayeredSpec.IntoLayersSpec\](../org/springframework/boot/gradle/tasks/bundling/LayeredSpec.IntoLayersSpec.html "class in org.springframework.boot.gradle.tasks.bundling") - Class in [org.springframework.boot.gradle.tasks.bundling](../org/springframework/boot/gradle/tasks/bundling/package-summary.html) Base class for specs that control the layers to which a category of content should belong. [A](index-1.html) [B](index-2.html) [C](index-3.html) [D](index-4.html) [E](index-5.html) [F](index-6.html) [G](index-7.html) [I](index-8.html) [L](index-9.html) [O](index-10.html) [P](index-11.html) [R](index-12.html) [S](index-13.html) [T](index-14.html) [V](index-15.html) [Z](index-16.html) \ [All Classes and Interfaces](../allclasses-index.html)|[All Packages](../allpackages-index.html)|[Constant Field Values](../constant-values.html)|[Serialized Form](../serialized-form.html)