Spring Boot

https://docs.spring.io/spring-boot/3.5
Admin
Spring Boot simplifies the creation of stand-alone, production-grade Spring applications by...
Tokens:2,463,728
Snippets:37,398
Trust Score:10
Update:1 hour ago
Show doc for...
Tokens:
Raw
### Example response for GET /actuator/startup

Source: https://docs.spring.io/spring-boot/3.5/api/rest/actuator/startup.html

Example HTTP response showing the JSON structure returned by a GET request to /actuator/startup. It includes springBootVersion, timeline startTime, and an array of events with startup step details.

```http
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 890

{
  "springBootVersion" : "3.5.16",
  "timeline" : {
    "startTime" : "2026-06-25T08:14:20.028169198Z",
    "events" : [ {
      "endTime" : "2026-06-25T08:14:20.373844988Z",
      "duration" : "PT0.000005618S",
      "startTime" : "2026-06-25T08:14:20.373839370Z",
      "startupStep" : {
        "name" : "spring.beans.instantiate",
        "id" : 3,
        "tags" : [ {
          "key" : "beanName",
          "value" : "homeController"
        } ],
        "parentId" : 2
      }
    }, {
      "endTime" : "2026-06-25T08:14:20.373852309Z",
      "duration" : "PT0.000020801S",
      "startTime" : "2026-06-25T08:14:20.373831508Z",
      "startupStep" : {
        "name" : "spring.boot.application.starting",
        "id" : 2,
        "tags" : [ {
          "key" : "mainApplicationClass",
          "value" : "com.example.startup.StartupApplication"
        } ]
      }
    } ]
  }
}
```

--------------------------------

### Expected Startup Output

Source: https://docs.spring.io/spring-boot/3.5/how-to/native-image/developing-your-first-application.html

Example output when starting the native executable. The startup time is much faster than a JVM-based Spring Boot application.

```shell
  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v3.5.16)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.08 seconds (process running for 0.095)
```

--------------------------------

### Classpath Index File Example

Source: https://docs.spring.io/spring-boot/3.5/specification/executable-jar/nested-jars.html

Shows the format of BOOT-INF/classpath.idx. Each line starts with dash space and the jar names are in double quotes, listing the order jars are added to the classpath.

```none
- "BOOT-INF/lib/dependency2.jar"
- "BOOT-INF/lib/dependency1.jar"
```

--------------------------------

### Run the native image Docker container

Source: https://docs.spring.io/spring-boot/3.5/how-to/native-image/developing-your-first-application.html

Start the application using docker run with the built image. The example uses docker.io/library/myproject:0.0.1-SNAPSHOT.

```shell
$ docker run --rm -p 8080:8080 docker.io/library/myproject:0.0.1-SNAPSHOT
```

--------------------------------

### start(LogLevel)

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/docker/compose/core/DockerCompose.html

Runs docker compose start to start services, waiting until all containers are started and healthy.

```APIDOC
## start(LogLevel)

### Description
Run `docker compose start` to start services. Waits until all containers are started and healthy.

### Method
start

### Parameters
- `logLevel` (LogLevel) - Required - The log level used to report progress.

### Returns
void

```

--------------------------------

### Get detailed help for the init command

Source: https://docs.spring.io/spring-boot/3.5/cli/using-the-cli.html

Running `spring help init` shows detailed usage for the `init` command, including all options such as `-a/--artifact-id`, `-b/--boot-version`, `--build`, `-d/--dependencies`, `--format`, `-g/--group-id`, `-j/--java-version`, `-l/--language`, `--list`, `-n/--name`, `-p/--packaging`, `--package-name`, `-t/--type`, `--target`, `-v/--version`, and `-x/--extract`. The output also includes example invocations for listing capabilities, creating a default project, creating a web project, and creating a web/data-jpa gradle project.

```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 <String>   Project coordinates; infer archive name (for
                               example 'test')
-b, --boot-version <String>  Spring Boot version (for example '1.2.0.RELEASE')
--build <String>             Build system to use (for example 'maven' or
                               'gradle') (default: maven)
-d, --dependencies <String>  Comma-separated list of dependency identifiers to
                               include in the generated project
--description <String>       Project description
-f, --force                  Force overwrite of existing files
--format <String>            Format of the generated content (for example
                               'build' for a build file, 'project' for a
                               project archive) (default: project)
-g, --group-id <String>      Project coordinates (for example 'org.test')
-j, --java-version <String>  Language level (for example '1.8')
-l, --language <String>      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 <String>          Project name; infer application name
-p, --packaging <String>     Project packaging (for example 'jar')
--package-name <String>      Package name
-t, --type <String>          Project type. Not normally needed if you use --
                               build and/or --format. Check the capabilities of
                               the service (--list) for more details
--target <String>            URL of the service to use (default: https://start.
                               spring.io)
-v, --version <String>       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

```

--------------------------------

### starting(ConfigurableBootstrapContext)

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/SpringApplicationRunListener.html

Called immediately when the run method has first started. Can be used for very early initialization.

```APIDOC
## starting(ConfigurableBootstrapContext)

### Description
Called immediately when the run method has first started. Can be used for very early initialization.

### Method
starting

### Signature
`default void starting(ConfigurableBootstrapContext bootstrapContext)`

### Parameters
- `bootstrapContext` (ConfigurableBootstrapContext) - Required - the bootstrap context

### Return Type
void
```

--------------------------------

### hasNotFailed assertion example

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/test/context/assertj/ApplicationContextAssert.html

Verifies that the application has not failed to start. Throws AssertionError if the application context failed to start.

```java
assertThat(context).hasNotFailed();
```

--------------------------------

### Method: start(String name)

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/context/metrics/buffering/BufferingApplicationStartup.html

Starts a new StartupStep with the given name. This method is specified by the ApplicationStartup interface.

```APIDOC
## Method: start(String name)

### Description
Starts a new StartupStep with the given name. This method is specified by the ApplicationStartup interface.

### Parameters
- **name** (String) - Required - The name of the step.

### Returns
- **StartupStep** - The started step.

### Usage
```java
StartupStep step = startup.start("myStep");
```
```

--------------------------------

### hasFailed assertion example

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/test/context/assertj/ApplicationContextAssert.html

Verifies that the application has failed to start. Throws AssertionError if the application context started without a failure.

```java
assertThat(context).hasFailed();
```

--------------------------------

### Example Response for Single Logger

Source: https://docs.spring.io/spring-boot/3.5/api/rest/actuator/loggers.html

Example HTTP response for a GET request to /actuator/loggers/com.example. Shows the JSON body with configuredLevel and effectiveLevel.

```http
HTTP/1.1 200 OK
Content-Disposition: inline;filename=f.txt
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 61

{
  "configuredLevel" : "INFO",
  "effectiveLevel" : "INFO"
}
```

--------------------------------

### Example Response for Single Logger Group

Source: https://docs.spring.io/spring-boot/3.5/api/rest/actuator/loggers.html

Example HTTP response for a GET request to /actuator/loggers/test. Shows the JSON body with configuredLevel and members array.

```http
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 82

{
  "configuredLevel" : "INFO",
  "members" : [ "test.member1", "test.member2" ]
}
```

--------------------------------

### start()

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/devtools/filewatch/FileSystemWatcher.html

Starts monitoring the source directory for changes.

```APIDOC
## start()

### Description
Starts monitoring the source directory for changes.

### Method
`public void start()`

### Parameters
None.

### Returns
void
```

--------------------------------

### Example Jar Structure for Classpath Index

Source: https://docs.spring.io/spring-boot/3.5/specification/executable-jar/nested-jars.html

Illustrates a jar structure with dependencies in BOOT-INF/lib, used as the basis for the classpath index example.

```none
example.jar
 |
 +-META-INF
 |  +-...
 +-BOOT-INF
    +-classes
    |  +...
    +-lib
       +-dependency1.jar
       +-dependency2.jar
```

--------------------------------

### WebClient example in Kotlin

Source: https://docs.spring.io/spring-boot/3.5/reference/io/rest-client.html

Kotlin version of the WebClient example. It injects the WebClient.Builder bean, builds a WebClient with a base URL, and defines a function that retrieves a Mono<Details> from a GET request.

```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<Details> {
		return webClient.get().uri("/{name}/details", name)
				.retrieve().bodyToMono(Details::class.java)
	}

}
```

--------------------------------

### Example response for GET /actuator/integrationgraph

Source: https://docs.spring.io/spring-boot/3.5/api/rest/actuator/integrationgraph.html

Example HTTP response showing the structure of the integration graph, including content descriptor, nodes, and links. The response includes a 200 OK status and Content-Type application/vnd.spring-boot.actuator.v3+json.

```http
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 1034

{
  "contentDescriptor" : {
    "providerVersion" : "6.5.10",
    "providerFormatVersion" : 1.2,
    "provider" : "spring-integration"
  },
  "nodes" : [ {
    "nodeId" : 1,
    "componentType" : "null-channel",
    "integrationPatternType" : "null_channel",
    "integrationPatternCategory" : "messaging_channel",
    "properties" : { },
    "name" : "nullChannel",
    "observed" : false
  }, {
    "nodeId" : 2,
    "componentType" : "publish-subscribe-channel",
    "integrationPatternType" : "publish_subscribe_channel",
    "integrationPatternCategory" : "messaging_channel",
    "properties" : { },
    "name" : "errorChannel",
    "observed" : false
  }, {
    "nodeId" : 3,
    "componentType" : "logging-channel-adapter",
    "integrationPatternType" : "outbound_channel_adapter",
    "integrationPatternCategory" : "messaging_endpoint",
    "properties" : { },
    "input" : "errorChannel",
    "name" : "errorLogger",
    "observed" : false
  } ],
  "links" : [ {
    "from" : 2,
    "to" : 3,
    "type" : "input"
  } ]
}
```

--------------------------------

### PropertiesLauncher.main(String[] args)

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/loader/launch/PropertiesLauncher.html

Static main method to launch the application using PropertiesLauncher. It delegates to the launcher's launch mechanism.

```APIDOC
## [STATIC] PropertiesLauncher.main(String[] args)

### Description
Static main method to launch the application using PropertiesLauncher. It delegates to the launcher's launch mechanism.

### Method
static void

### Signature
`public static void main(String[] args)`

### Parameters
- **args** (String[]) - Required - Command line arguments passed to the application.

### Usage
This method is typically invoked by the JVM when the class is specified as the main class.

```

--------------------------------

### Standard @SpringBootApplication usage in Kotlin

Source: https://docs.spring.io/spring-boot/3.5/reference/using/using-the-springbootapplication-annotation.html

Kotlin equivalent of the standard @SpringBootApplication example. Uses runApplication<MyApplication>(*args) to start the application.

```kotlin
import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.runApplication

// Same as @SpringBootConfiguration @EnableAutoConfiguration @ComponentScan
@SpringBootApplication
class MyApplication

fun main(args: Array<String>) {
	runApplication<MyApplication>(*args)
}
```

--------------------------------

### logStartupInfo(boolean isRoot) (Deprecated)

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/SpringApplication.html

Deprecated method for logging startup information. Use logStartupInfo(ConfigurableApplicationContext) instead. Scheduled for removal in 4.0.0.

```APIDOC
## logStartupInfo(boolean isRoot) (Deprecated)

### Description
Deprecated, for removal: This API element is subject to removal in a future version. Since 3.4.0 for removal in 4.0.0 in favor of logStartupInfo(ConfigurableApplicationContext). Called to log startup information, subclasses may override to add additional logging.

### Method
@Deprecated(since="3.4.0", forRemoval=true) protected void logStartupInfo(boolean isRoot)

### Parameters
- **isRoot** (boolean) - Required - Indicates if this is the root application.
```

--------------------------------

### Run the application with Maven (mvn spring-boot:run)

Source: https://docs.spring.io/spring-boot/3.5/tutorial/first-application/index.html

Use the spring-boot-starter-parent POM's run goal to start the application. Expected output includes the Spring Boot banner and a 'Started MyApplication' message. Open localhost:8080 to see 'Hello World!'. Press ctrl-c to exit.

```shell
$ mvn spring-boot:run

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v3.5.16)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.906 seconds (process running for 6.514)
```

--------------------------------

### hasBean example

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/test/context/assertj/ApplicationContextAssert.html

Verifies that the application context contains a bean with the given name. Throws AssertionError if the context did not start or does not contain the bean.

```java
assertThat(context).hasBean("fooBean");
```

--------------------------------

### start()

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/jdbc/HikariCheckpointRestoreLifecycle.html

Starts the lifecycle, resuming the connection pool if necessary.

```APIDOC
## Method: start()

### Description
Starts the lifecycle. When subsequently started, the pool is resumed if necessary.

### Signature
public void start()

### Specified By
start in interface Lifecycle
```

--------------------------------

### Method: startRecording()

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/context/metrics/buffering/BufferingApplicationStartup.html

Starts the recording of steps and marks the beginning of the StartupTimeline. The constructor implicitly calls this, but it can be reset as long as steps have not been recorded already.

```APIDOC
## Method: startRecording()

### Description
Starts the recording of steps and marks the beginning of the StartupTimeline. The class constructor already implicitly calls this, but it is possible to reset it as long as steps have not been recorded already.

### Signature
`public void startRecording()`

### Throws
- **IllegalStateException** - if called and StartupStep have been recorded already.

### Usage
```java
startup.startRecording();
```
```

--------------------------------

### logStartupInfo(ConfigurableApplicationContext context)

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/SpringApplication.html

Called to log startup information. Subclasses may override to add additional logging. Available since 3.4.0.

```APIDOC
## logStartupInfo(ConfigurableApplicationContext context)

### Description
Called to log startup information, subclasses may override to add additional logging.

### Method
protected void logStartupInfo(ConfigurableApplicationContext context)

### Parameters
- **context** (ConfigurableApplicationContext) - Required - The application context.

### Since
3.4.0
```

--------------------------------

### Expected output when running the native image

Source: https://docs.spring.io/spring-boot/3.5/how-to/native-image/developing-your-first-application.html

Example output showing Spring Boot startup logs and the application starting in 0.08 seconds.

```shell
  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v{version-spring-boot})
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.08 seconds (process running for 0.095)
```

--------------------------------

### Retrieve a specific metric with curl

Source: https://docs.spring.io/spring-boot/3.5/api/rest/actuator/metrics.html

Makes a GET request to /actuator/metrics/{metric.name} to retrieve details for a specific metric, using jvm.memory.max as an example.

```bash
$ curl 'http://localhost:8080/actuator/metrics/jvm.memory.max' -i -X GET
```

--------------------------------

### start()

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/devtools/livereload/LiveReloadServer.html

Starts the livereload server and accepts incoming connections. Returns the port on which the server is listening.

```APIDOC
## start()

### Description
Starts the livereload server and accepts incoming connections. Returns the port on which the server is listening.

### Method
`public int start() throws IOException`

### Parameters
None.

### Returns
- **int** - The port on which the server is listening.

### Throws
- **IOException** - In case of I/O errors.

### Example
```java
LiveReloadServer server = new LiveReloadServer();
int port = server.start();
```
```

--------------------------------

### RootUriRequestExpectationManager usage example with RestTemplate and MockRestServiceServer

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/test/web/client/RootUriRequestExpectationManager.html

Shows how to use RootUriRequestExpectationManager to simplify test declarations when all REST calls start with the same root URI. It binds a MockRestServiceServer to a RestTemplate configured with a rootUri, then expects a request to '/hello' and responds with success. The example is from the class documentation.

```java
RestTemplate restTemplate = new RestTemplateBuilder().rootUri("https://example.com").build();
MockRestServiceServer server = RootUriRequestExpectationManager.bindTo(restTemplate);
server.expect(requestTo("/hello")).andRespond(withSuccess());
restTemplate.getForEntity("/hello", String.class);
```

--------------------------------

### spring-devtools.properties example for restart classloader customization

Source: https://docs.spring.io/spring-boot/3.5/reference/using/devtools.html

Example properties file to exclude local class files and include extra libraries in the restart classloader. Property keys must be unique and start with restart.include. or restart.exclude. All META-INF/spring-devtools.properties from the classpath are loaded; system properties cannot be used.

```properties
restart.exclude.companycommonlibs="/mycorp-common-[\w\d-\.]/(build|bin|out|target)/"
restart.include.projectcommon="/mycorp-myproj-[\w\d-\.]+\.jar"
```

--------------------------------

### Response to GET /actuator/sbom

Source: https://docs.spring.io/spring-boot/3.5/api/rest/actuator/sbom.html

Example HTTP response showing a 200 OK with Content-Type application/vnd.spring-boot.actuator.v3+json and a JSON body containing the available SBOM ids.

```http
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 31

{
  "ids" : [ "application" ]
}

```

--------------------------------

### Example response for POST /actuator/startup

Source: https://docs.spring.io/spring-boot/3.5/api/rest/actuator/startup.html

Example HTTP response showing the JSON structure returned by a POST request to /actuator/startup. It includes springBootVersion, timeline startTime, and an array of events with startup step details.

```http
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 890

{
  "springBootVersion" : "3.5.16",
  "timeline" : {
    "startTime" : "2026-06-25T08:14:20.028169198Z",
    "events" : [ {
      "endTime" : "2026-06-25T08:14:20.318313520Z",
      "duration" : "PT0.003393571S",
      "startTime" : "2026-06-25T08:14:20.314919949Z",
      "startupStep" : {
        "name" : "spring.beans.instantiate",
        "id" : 1,
        "tags" : [ {
          "key" : "beanName",
          "value" : "homeController"
        } ],
        "parentId" : 0
      }
    }, {
      "endTime" : "2026-06-25T08:14:20.318347720Z",
      "duration" : "PT0.006113288S",
      "startTime" : "2026-06-25T08:14:20.312234432Z",
      "startupStep" : {
        "name" : "spring.boot.application.starting",
        "id" : 0,
        "tags" : [ {
          "key" : "mainApplicationClass",
          "value" : "com.example.startup.StartupApplication"
        } ]
      }
    } ]
  }
}
```

--------------------------------

### doesNotHaveBean by name example

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/test/context/assertj/ApplicationContextAssert.html

Verifies that the application context does not contain a bean with the given name. Throws AssertionError if the context did not start or contains a bean with the name.

```java
assertThat(context).doesNotHaveBean("fooBean");
```

--------------------------------

### Basic SpringApplication.run() bootstrap

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/SpringApplication.html

Shows the minimal setup for a Spring Boot application using @Configuration, @EnableAutoConfiguration, and a main method that calls SpringApplication.run().

```java
 @Configuration
 @EnableAutoConfiguration
 public class MyApplication  {

   // ... Bean definitions

   public static void main(String[] args) {
     SpringApplication.run(MyApplication.class, args);
   }
 }

```

--------------------------------

### curl GET /actuator/env/{property.name}

Source: https://docs.spring.io/spring-boot/3.5/api/rest/actuator/env.html

Retrieves information about a single property from the application environment. The example requests the property 'com.example.cache.max-size' from a local Spring Boot application.

```bash
$ curl 'http://localhost:8080/actuator/env/com.example.cache.max-size' -i -X GET
```

--------------------------------

### BufferingApplicationStartup(int)

Source: https://docs.spring.io/spring-boot/3.5/api/java/index-files/index-2.html

Constructor for BufferingApplicationStartup. Creates a new buffered ApplicationStartup with a limited capacity and starts the recording of steps.

```APIDOC
## Constructor: BufferingApplicationStartup(int)

### Description
Create a new buffered `ApplicationStartup` with a limited capacity and starts the recording of steps.

### Class
org.springframework.boot.context.metrics.buffering.BufferingApplicationStartup

### Parameters
- **capacity** (int) - Required - The maximum number of steps to buffer.
```

--------------------------------

### onStart()

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/buildpack/platform/docker/UpdateListener.html

Called when the operation starts. This is a default method that can be overridden.

```APIDOC
## onStart()

### Description
Called when the operation starts.

### Method
Default method

### Signature
`default void onStart()`

### Parameters
None

### Returns
void

### Example
```java
UpdateListener<UpdateEvent> listener = new UpdateListener<UpdateEvent>() {
    @Override
    public void onStart() {
        // handle start
    }
    @Override
    public void onUpdate(UpdateEvent event) {
        // handle update
    }
};
```
```

--------------------------------

### Retrieve Cache by Name with curl

Source: https://docs.spring.io/spring-boot/3.5/api/rest/actuator/caches.html

Makes a GET request to /actuator/caches/{name} to retrieve a specific cache by name. The example retrieves the cache named 'cities'.

```bash
$ curl 'http://localhost:8080/actuator/caches/cities' -i -X GET
```

--------------------------------

### getBean(String) example: assert bean by name

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/test/context/assertj/ApplicationContextAssert.html

Obtains a single bean by name and asserts its type or null. Throws AssertionError if the application context did not start.

```java
assertThat(context).getBean("foo").isInstanceOf(Foo.class);
assertThat(context).getBean("foo").isNull();
```

--------------------------------

### start()

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/web/embedded/jetty/JettyWebServer.html

Starts the web server. Calling this method on an already started server has no effect.

```APIDOC
## Method: start()

### Description
Starts the web server. Calling this method on an already started server has no effect.

### Method
start

### Throws
- **WebServerException** - if the server cannot be started.

```

--------------------------------

### doesNotHaveBean by type example

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/test/context/assertj/ApplicationContextAssert.html

Verifies that the application context (or ancestors) does not contain any beans of the given type. Throws AssertionError if the context did not start or contains any beans of the type.

```java
assertThat(context).doesNotHaveBean(Foo.class);
```

--------------------------------

### Run the application with Gradle (gradle bootRun)

Source: https://docs.spring.io/spring-boot/3.5/tutorial/first-application/index.html

Use the org.springframework.boot Gradle plugin's bootRun task to start the application. Expected output includes the Spring Boot banner and a 'Started MyApplication' message. Open localhost:8080 to see 'Hello World!'. Press ctrl-c to exit.

```shell
$ gradle bootRun

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v3.5.16)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.906 seconds (process running for 6.514)
```

--------------------------------

### Retrieve Job Group Overview with curl

Source: https://docs.spring.io/spring-boot/3.5/api/rest/actuator/quartz.html

Makes a GET request to /actuator/quartz/jobs/{groupName} to retrieve an overview of jobs in a particular group. The example uses the 'samples' group.

```bash
$ curl 'http://localhost:8080/actuator/quartz/jobs/samples' -i -X GET
```

--------------------------------

### SpringApplication.logStartupInfo(ConfigurableApplicationContext context)

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/SpringApplication.html

Called to log startup information, subclasses may override to add additional logging.

```APIDOC
## [PROTECTED] logStartupInfo(ConfigurableApplicationContext context)

### Description
Called to log startup information, subclasses may override to add additional logging.

### Method
protected

### Signature
`protected void logStartupInfo(ConfigurableApplicationContext context)`

### Parameters
- **context** (ConfigurableApplicationContext) - Required - The application context.
```

--------------------------------

### start(BuildRequest request)

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/buildpack/platform/build/BuildLog.html

Logs that a build is starting.

```APIDOC
## start(BuildRequest request)

### Description
Log that a build is starting.

### Method
start

### Parameters
- `request` (BuildRequest) - Required - The build request

### Returns
void
```

--------------------------------

### AssertJ assertions on captured output

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/test/system/CapturedOutput.html

Use CapturedOutput with AssertJ to assert on captured System.out and System.err. The example checks all output for 'started', System.err for 'failed', and System.out for 'ok'.

```java
assertThat(output).contains("started"); // Checks all output
assertThat(output.getErr()).contains("failed"); // Only checks System.err
assertThat(output.getOut()).contains("ok"); // Only checks System.out
```

--------------------------------

### start(LogLevel, List<String>)

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/docker/compose/core/DockerCompose.html

Runs docker compose start with additional arguments to start services, waiting until all containers are started and healthy.

```APIDOC
## start(LogLevel, List<String>)

### Description
Run `docker compose start` to start services. Waits until all containers are started and healthy.

### Method
start

### Parameters
- `logLevel` (LogLevel) - Required - The log level used to report progress.
- `arguments` (List<String>) - Required - The arguments to pass to the start command.

### Returns
void

### Since
3.4.0

```

--------------------------------

### getFailure assertion example

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/test/context/assertj/ApplicationContextAssert.html

Obtains the failure that stopped the application context from running and makes it the object under test. Throws AssertionError if the application context started without a failure.

```java
assertThat(context).getFailure().hasMessageContaining("missing bean");
```

--------------------------------

### initialize

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/logging/logback/LogbackLoggingSystem.html

Fully initializes the logging system with the given configuration location and log file.

```APIDOC
## initialize

### Description
Fully initialize the logging system.

### Method
initialize

### Signature
`public void initialize(LoggingInitializationContext initializationContext, String configLocation, LogFile logFile)`

### Overrides
`initialize` in class `AbstractLoggingSystem`

### Parameters
- `initializationContext` (LoggingInitializationContext) - Required - the logging initialization context
- `configLocation` (String) - Required - a log configuration location or `null` if default initialization is required
- `logFile` (LogFile) - Required - the log output file that should be written or `null` for console only output

### Returns
void
```

--------------------------------

### hasSingleBean example

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/test/context/assertj/ApplicationContextAssert.html

Verifies that the application context (or ancestors) contains a single bean of the given type. Throws AssertionError if the context did not start, has no beans of the type, or has multiple beans.

```java
assertThat(context).hasSingleBean(Foo.class);
```

--------------------------------

### initialize(LoggingInitializationContext, String, LogFile)

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/logging/LoggingSystem.html

Fully initializes the logging system with the given context, configuration location, and log file.

```APIDOC
## initialize(LoggingInitializationContext, String, LogFile)

### Description
Fully initializes the logging system.

### Method
public void initialize(LoggingInitializationContext initializationContext, String configLocation, LogFile logFile)

### Parameters
- `initializationContext` (LoggingInitializationContext) - Required - The logging initialization context.
- `configLocation` (String) - Required - A log configuration location or `null` if default initialization is required.
- `logFile` (LogFile) - Required - The log output file that should be written or `null` for console only output.
```

--------------------------------

### Kotlin @PulsarReader example

Source: https://docs.spring.io/spring-boot/3.5/reference/messaging/pulsar.html

Kotlin component using @PulsarReader to consume messages from the 'someTopic' topic, starting from the earliest message. Requires Apache Pulsar infrastructure and relies on a PulsarReaderFactory.

```kotlin
import org.springframework.pulsar.annotation.PulsarReader
import org.springframework.stereotype.Component

@Component
class MyBean {

	@PulsarReader(topics = ["someTopic"], startMessageId = "earliest")
	fun processMessage(content: String?) {
		// ...
	}

}
```

--------------------------------

### applicationStartup(ApplicationStartup applicationStartup)

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/builder/SpringApplicationBuilder.html

Configure the ApplicationStartup to be used with the ApplicationContext for collecting startup metrics.

```APIDOC
## applicationStartup(ApplicationStartup applicationStartup)

### Description
Configure the ApplicationStartup to be used with the ApplicationContext for collecting startup metrics.

### Method
`SpringApplicationBuilder applicationStartup(ApplicationStartup applicationStartup)`

### Parameters
- **applicationStartup** (ApplicationStartup) - Required - The ApplicationStartup to use.

### Returns
- **SpringApplicationBuilder** - The builder instance for chaining.

```

--------------------------------

### Java @PulsarReader example

Source: https://docs.spring.io/spring-boot/3.5/reference/messaging/pulsar.html

Java component using @PulsarReader to consume messages from the 'someTopic' topic, starting from the earliest message. Requires Apache Pulsar infrastructure and relies on a PulsarReaderFactory.

```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) {
		// ...
	}

}
```

--------------------------------

### logStartupInfo(boolean logStartupInfo)

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/builder/SpringApplicationBuilder.html

Flag to indicate the startup information should be logged.

```APIDOC
## logStartupInfo(boolean logStartupInfo)

### Description
Flag to indicate the startup information should be logged.

### Method
`SpringApplicationBuilder logStartupInfo(boolean logStartupInfo)`

### Parameters
- **logStartupInfo** (boolean) - Required - Whether to log startup info.

### Returns
- **SpringApplicationBuilder** - The builder instance for chaining.

```

--------------------------------

### logStartupInfo(boolean logStartupInfo)

Source: https://docs.spring.io/spring-boot/3.5/api/java/org/springframework/boot/builder/SpringApplicationBuilder.html

Flag to indicate the startup information should be logged.

```APIDOC
## logStartupInfo(boolean logStartupInfo)

### Description
Flag to indicate the startup information should be logged.

### Method
logStartupInfo

### Signature
public SpringApplicationBuilder logStartupInfo(boolean logStartupInfo)

### Parameters
- **logStartupInfo** (boolean) - Required - The flag to set. Default true.

### Returns
- **SpringApplicationBuilder** - The current builder
```

--------------------------------

### Cloud Foundry Deployment Output

Source: https://docs.spring.io/spring-boot/3.5/how-to/deployment/cloud.html

Example output from `cf push` showing the buildpack download and application startup. The output indicates the application is live when 'App started' appears.

```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
```

--------------------------------

### Check Spring Boot CLI version

Source: https://docs.spring.io/spring-boot/3.5/cli/using-the-cli.html

Running `spring version` prints the installed Spring Boot CLI version. The example output shows `Spring CLI v3.5.16`.

```shell
$ spring version
Spring CLI v3.5.16

```
Tokens:
Raw