Spring Framework

https://docs.spring.io/spring-framework/docs/current/
Admin
Spring Framework is a comprehensive, open-source application framework for building Java-based...
Tokens:9,241,831
Snippets:131,275
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### start()

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/client/ReactorClientHttpRequestFactory.html

Starts the component.

```APIDOC
## Method: start()

### Description
Starts this component.

### Method Signature
`public void start()`

### Parameters
None.

### Usage Example
```java
factory.start();
```
```

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

### start()

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/socket/messaging/WebSocketStompClient.html

Starts the WebSocket client component.

```APIDOC
## start()

### Description
Starts this component. Should not throw an exception if the component is already running. In the case of a container, this will propagate a hard start signal to all components that apply, even to non-auto-startup components.

### Method
public void start()
```

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

### start()

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/socket/client/ConnectionManagerSupport.html

Start the WebSocket connection.

```APIDOC
## Method: start()

### Description
Start the WebSocket connection. This method is final and will call startInternal().

```

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

### start

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/jms/connection/SingleConnectionFactory.html

Initializes the underlying shared connection on start.

```APIDOC
## start

### Description
Initializes the underlying shared connection on start.

### Method
start

### Signature
public void start()
```

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

### start()

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/util/backoff/ExponentialBackOff.html

Starts a new back off execution.

```APIDOC
## start()

### Description
Starts a new back off execution.

### Method
Method

### Signature
`public BackOffExecution start()`

### Returns
- **BackOffExecution** - A fresh `BackOffExecution` ready to be used.

### Specified by
`start` in interface `BackOff`
```

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

### start()

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/test/context/transaction/TestTransaction.html

Starts a new test-managed transaction.

```APIDOC
## start()

### Description
Starts a new test-managed transaction. Only call this method if `end()` has been called or if no transaction has been previously started.

### Method
`public static void start()`

### Throws
- `IllegalStateException` - if the transaction context could not be retrieved or if a transaction is already active for the current test

### See Also
- `isActive()`
- `end()`
```

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

### start()

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/Lifecycle.html

Starts the component synchronously, propagating the start signal to all applicable components in a container.

```APIDOC
## void start()

### Description
Start this component, typically in a synchronous fashion, such that the component is fully started upon return of this method. Consider implementing `SmartLifecycle` and its `start(Runnable)` variant when asynchronous start behavior is necessary. Note that this start notification is not guaranteed to come before initialization: On regular shutdown, `Lifecycle` beans will first receive a stop notification before the general destruction callbacks are being propagated; however, on hot refresh during a context's lifetime or on aborted refresh attempts, a given bean's destroy method will be called without any consideration of stop signals upfront. Should not throw an exception if the component is already running. In the case of a container, this will propagate the start signal to all components that apply.

### Method
start

### Signature
void start()

### Parameters
None

### Returns
void

### See Also
- `SmartLifecycle.start(Runnable)`
- `InitializingBean.afterPropertiesSet()`
```

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

### start()

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/support/DefaultLifecycleProcessor.html

Starts all registered beans that implement Lifecycle and are not already running. Beans implementing SmartLifecycle are started within their phase, ordered from lowest to highest value. Beans not implementing SmartLifecycle are started in the default phase 0.

```APIDOC
## start()

### Description
Starts all registered beans that implement `Lifecycle` and are not already running. Beans implementing `SmartLifecycle` are started within their phase, ordered from lowest to highest value. Beans not implementing `SmartLifecycle` are started in the default phase 0. A bean declared as a dependency of another bean will be started before the dependent bean regardless of the declared phase.

### Method
`public void start()`

### Parameters
None

### Returns
`void`

### See Also
- `SmartLifecycle.isAutoStartup()`
```

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

### start()

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/socket/sockjs/client/WebSocketTransport.html

Starts the transport component as part of the lifecycle management.

```APIDOC
## start

### Description
Starts this component. Should not throw an exception if the component is already running.

### Method
`public void start()`

### Returns
No return value.
```

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

### start()

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/jms/listener/DefaultMessageListenerContainer.html

Starts the listener container, resetting any stop callback.

```APIDOC
## start()

### Description
Overridden to reset the stop callback, if any.

### Method
start

### Parameters
None

### Return Type
void
```

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

### start()

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/support/DefaultLifecycleProcessor.html

Starts all registered beans that implement Lifecycle and are not already running. This method is called during context refresh or explicit start.

```APIDOC
## start()

### Description
Starts all registered beans that implement `Lifecycle` and are not already running.

### Method
`void start()`

### Parameters
None.

### Return Value
None.

### Exceptions
None specified.

### Usage Example
```java
DefaultLifecycleProcessor processor = new DefaultLifecycleProcessor();
processor.start();
```
```

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

### ApplicationStartup

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/index-files/index-1.html

Instruments the application startup phase using steps.

```APIDOC
## ApplicationStartup

### Description
Instruments the application startup phase using `steps`.
```

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

### MockMvc setup and perform example

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/test/web/servlet/MockMvc.html

Shows the main entry point for server-side Spring MVC test support. It sets up a MockMvc instance from a WebApplicationContext and performs a GET request to "/form", asserting the status, content type, and forwarded URL.

```java
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
import static org.springframework.test.web.servlet.setup.MockMvcBuilders.*;

// ...

WebApplicationContext wac = ...;

MockMvc mockMvc = webAppContextSetup(wac).build();

mockMvc.perform(get("/form"))
    .andExpectAll(
        status().isOk(),
        content().contentType("text/html"),
        forwardedUrl("/WEB-INF/layouts/main.jsp")
    );

```

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

### void start()

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/socket/sockjs/client/JettyXhrTransport.html

Starts this transport, initializing any resources needed for operation.

```APIDOC
## Method: start

### Description
Starts the transport, making it ready to handle connections.

### Returns
void
```

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

### start(String)

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/util/StopWatch.html

Starts a named task in the StopWatch. This method must be called before stop() or timing methods to get valid results.

```APIDOC
## start(String)

### Description
Start a named task. The results are undefined if `stop()` or timing methods are called without invoking this method first.

### Method
`public void start(String taskName) throws IllegalStateException`

### Parameters
- `taskName` (String) - Required - The name of the task to start.

### Throws
- `IllegalStateException`

### See Also
- `start()`
- `stop()`
```

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

### GET with pattern and predicate

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/reactive/function/server/RouterFunctions.Builder.html

Adds a route for GET requests that match both a path pattern and a predicate. The example routes GET requests for "/user" that accept JSON to the listUsers method in userController.

```java
RouterFunction<ServerResponse> route =
    RouterFunctions.route()
        .GET("/user", RequestPredicates.accept(MediaType.APPLICATION_JSON), userController::listUsers)
        .build();
```

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

### matchStart(String pattern, String path)

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/util/AntPathMatcher.html

Matches the given path against the corresponding part of the given pattern, according to this PathMatcher's matching strategy.

```APIDOC
## matchStart(String pattern, String path)

### Description
Matches the given path against the corresponding part of the given pattern, according to this PathMatcher's matching strategy.

### Method
`boolean matchStart(String pattern, String path)`

### Parameters
- **pattern** (String) - Required - The pattern to match.
- **path** (String) - Required - The path to match.

### Returns
- **boolean** - true if the path matches the start of the pattern.

### Example
```java
boolean matched = matcher.matchStart("/a/**", "/a/b");
```
```

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

### getTcpClient()

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/messaging/simp/stomp/StompBrokerRelayMessageHandler.html

Gets the configured TCP client. Returns null if not configured and the handler is not started.

```APIDOC
## Method: getTcpClient()

### Description
Gets the configured TCP client. Returns null if not configured and the handler is not started.

### Return Type
@Nullable TcpOperations<byte[]>

```

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

### HttpMethod.name()

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/HttpMethod.html

Returns the name of this method, for example, "GET", "POST".

```APIDOC
## HttpMethod.name()

### Description
Return the name of this method, for example, "GET", "POST".

### Method
GET

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response (200)
- **String** - The name of the method

#### Response Example
```json
"GET"
```
```

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

### WebApplicationInitializer.onStartup

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/WebApplicationInitializer.html

Documentation for the WebApplicationInitializer interface and its onStartup method.

```APIDOC
## [INTERFACE] WebApplicationInitializer

### Description
Interface to be implemented in Servlet 3.0+ environments in order to configure the ServletContext programmatically -- as opposed to (or possibly in conjunction with) the traditional web.xml-based approach.

### Method
onStartup

### Signature
void onStartup(jakarta.servlet.ServletContext servletContext) throws jakarta.servlet.ServletException

### Parameters
- **servletContext** (jakarta.servlet.ServletContext) - Required - The ServletContext to initialize

### Throws
- **jakarta.servlet.ServletException** - if any call against the given ServletContext throws a ServletException

### Description
Configure the given ServletContext with any servlets, filters, listeners context-params and attributes necessary for initializing this web application.
```

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

### isDeferred()

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/core/ReactiveTypeDescriptor.html

Indicates whether the underlying operation is deferred and needs to be started explicitly, for example, via subscribing.

```APIDOC
## isDeferred()

### Description
Whether the underlying operation is deferred and needs to be started explicitly, for example, via subscribing (or similar), or whether it is triggered without the consumer having any control.

### Method
public boolean isDeferred()

### Returns
- **boolean** - `true` if the operation is deferred, `false` otherwise.

### Since
5.2.7

```

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

### Async exchange with asyncExchange

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/test/web/servlet/assertj/MockMvcTester.html

Shows how to use asyncExchange() to get the result of an asynchronous request immediately and assert that it has started.

```java
// perform a POST on /save and assert an asynchronous request has started
assertThat(mvc.post().uri("/save").asyncExchange()).request().hasAsyncStarted();

```

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

### scheduleWithFixedDelay(Runnable task, Duration delay)

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/scheduling/concurrent/ThreadPoolTaskScheduler.html

Schedules the given Runnable task to start as soon as possible and invoke it with the given delay between the completion of one execution and the start of the next. Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

```APIDOC
## scheduleWithFixedDelay(Runnable task, Duration delay)

### Description
Schedules the given Runnable task to start as soon as possible and invoke it with the given delay between the completion of one execution and the start of the next. Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

### Method
scheduleWithFixedDelay

### Signature
public ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Duration delay)

### Parameters
- **task** (Runnable) - Required - The Runnable to execute whenever the trigger fires
- **delay** (Duration) - Required - The delay between the completion of one execution and the start of the next

### Returns
- **ScheduledFuture<?>** - A ScheduledFuture representing pending execution of the task
```

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

### matchStart(String pattern, String path)

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/util/AntPathMatcher.html

Matches the start of a path against a pattern.

```APIDOC
## matchStart(String pattern, String path)

### Description
Matches the given path against the corresponding part of the given pattern, determining whether the pattern matches at least as far as the given base path goes.

### Method
matchStart

### Signature
`public boolean matchStart(String pattern, String path)`

### Parameters
- **pattern** (String) - Required - The pattern to match against.
- **path** (String) - Required - The path to test.

### Returns
- **boolean** - true if the supplied path matched, false otherwise.

### Interface
PathMatcher

### Example
```java
boolean startMatched = matcher.matchStart("/foo/**", "/foo/bar");
```
```

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

### start()

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/jca/endpoint/GenericMessageEndpointManager.html

Activates the configured message endpoint.

```APIDOC
## start()

### Description
Activates the configured message endpoint.

### Method
INVOKE

### Endpoint
GenericMessageEndpointManager.start()

```

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

### Perform async request and get MvcResult

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/test/web/servlet/request/MockMvcRequestBuilders.html

First step of async dispatch: perform a request that starts async processing and capture the MvcResult.

```java
MvcResult mvcResult = this.mockMvc.perform(get("/1"))
.andExpect(request().asyncStarted())
.andReturn();
```

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

### retrieve() examples: toEntity and bodyToMono

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/reactive/function/client/WebClient.RequestHeadersSpec.html

Two examples from the retrieve() method documentation: the first extracts a ResponseEntity with status, headers, and body using toEntity(Person.class); the second extracts only the body using bodyToMono(Person.class). Both use the same request setup and are shown as alternatives for the same workflow.

```java
Mono<ResponseEntity<Person>> entityMono = client.get()
    .uri("/persons/1")
    .accept(MediaType.APPLICATION_JSON)
    .retrieve()
    .toEntity(Person.class);
```

```java
Mono<Person> entityMono = client.get()
    .uri("/persons/1")
    .accept(MediaType.APPLICATION_JSON)
    .retrieve()
    .bodyToMono(Person.class);
```

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

### CorsRegistration allowedMethods(String... methods)

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/servlet/config/annotation/CorsRegistration.html

Sets the HTTP methods to allow, for example "GET", "POST", etc.

```APIDOC
## Method: allowedMethods(String... methods)

### Description
Sets the HTTP methods to allow for cross-origin requests.

### Parameters
- **methods** (String...) - Required - The HTTP methods to allow (e.g., "GET", "POST").

### Returns
This CorsRegistration instance for method chaining.
```

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

### ApplicationStartup.DEFAULT

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/core/metrics/class-use/ApplicationStartup.html

Default "no op" ApplicationStartup implementation.

```APIDOC
## ApplicationStartup.DEFAULT

### Description
Default "no op" ApplicationStartup implementation.

### Method
GET

### Endpoint
ApplicationStartup.DEFAULT

### Parameters
None

### Response
#### Success Response
- **ApplicationStartup** - The default no-op ApplicationStartup.

#### Response Example
```java
ApplicationStartup startup = ApplicationStartup.DEFAULT;
```
```

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

### ApplicationStartup Interface

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/core/metrics/ApplicationStartup.html

Documentation for the ApplicationStartup interface, including its start method and DEFAULT field.

```APIDOC
## Interface ApplicationStartup

### Description
Instruments the application startup phase using steps. The core container and its infrastructure components can use the ApplicationStartup to mark steps during the application startup and collect data about the execution context or their processing time.

### Method
start(String name)

### Signature
StartupStep start(String name)

### Parameters
- **name** (String) - Required - The step name. A step name describes the current action or phase. This technical name should be "." namespaced and can be reused to describe other instances of the same step during application startup.

### Returns
StartupStep - A new step that marks the beginning of the step.

### Field
- **DEFAULT** (static final ApplicationStartup) - Default "no op" ApplicationStartup implementation. This variant is designed for minimal overhead and does not record data.
```

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

### isDeferred()

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/core/ReactiveTypeDescriptor.html

Indicates whether the underlying operation is deferred and needs to be started explicitly, for example, via subscribing, or whether it is triggered without the consumer having any control.

```APIDOC
## isDeferred()

### Description
Indicates whether the underlying operation is deferred and needs to be started explicitly, for example, via subscribing, or whether it is triggered without the consumer having any control.

### Method
boolean

### Returns
boolean - true if the operation is deferred, false otherwise.
```

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

### router DSL example with UserHandler routes

Source: https://docs.spring.io/spring-framework/docs/current/kdoc-api/spring-webflux/org.springframework.web.reactive.function.server/router.html

Creates a RouterFunction<ServerResponse> using the Reactive router Kotlin DSL. The example defines a @Configuration class with a @Bean method that nests routes for TEXT_HTML and APPLICATION_JSON content types, mapping GET and POST endpoints to handler methods.

```kotlin
@Configuration
class RouterConfiguration {

	@Bean
	fun mainRouter(userHandler: UserHandler) = router {
		accept(TEXT_HTML).nest {
			(GET("/user/") or GET("/users/")).invoke(userHandler::findAllView)
			GET("/users/{login}", userHandler::findViewById)
		}
		accept(APPLICATION_JSON).nest {
			(GET("/api/user/") or GET("/api/users/")).invoke(userHandler::findAll)
			POST("/api/users/", userHandler::create)
		}
	}

}
```

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

### initialize()

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/scheduling/concurrent/ExecutorConfigurationSupport.html

Set up the ExecutorService.

```APIDOC
## initialize()

### Description
Set up the ExecutorService.

### Method
initialize

### Signature
public void initialize()
```

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

### Using ThrowingSupplier.of with exception wrapper

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/util/function/ThrowingSupplier.html

Creates a ThrowingSupplier where the get() method wraps checked exceptions using a custom exception wrapper. The example shows usage with Optional.orElseGet() and a method reference.

```java
optional.orElseGet(ThrowingSupplier.of(Example::methodThatCanThrowCheckedException, IllegalStateException::new));
```

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

### start

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/client/reactive/ReactorClientHttpConnector.html

Start this component. Should not throw an exception if the component is already running.

```APIDOC
## start

### Description
Start this component. Should not throw an exception if the component is already running. In the case of a container, this will propagate a hard start signal to all components that apply, even to non-auto-startup components.

### Method
start

### Parameters
None

### Returns
void
```

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

### FACTORY_BEAN_PREFIX

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/beans/factory/BeanFactory.html

Used to dereference a `FactoryBean` instance and distinguish it from beans _created_ by the FactoryBean. For example, if the bean named `myJndiObject` is a FactoryBean, getting `&myJndiObject` will return the factory, not the instance returned by the factory.

```APIDOC
## FACTORY_BEAN_PREFIX

### Description
Used to dereference a `FactoryBean` instance and distinguish it from beans _created_ by the FactoryBean. For example, if the bean named `myJndiObject` is a FactoryBean, getting `&myJndiObject` will return the factory, not the instance returned by the factory.

### Field
`static final String FACTORY_BEAN_PREFIX`
```

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

### onStartup(ServletContext)

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/context/AbstractContextLoaderInitializer.html

The onStartup method is the main entry point for configuring the servlet context during web application startup. It is called by the servlet container and delegates to the registerContextLoaderListener method.

```APIDOC
## onStartup(ServletContext)

### Description
Configures the given ServletContext with any servlets, filters, listeners, context-params, and attributes necessary for initializing the web application. This method is specified by the WebApplicationInitializer interface.

### Method
onStartup

### Signature
public void onStartup(jakarta.servlet.ServletContext servletContext) throws jakarta.servlet.ServletException

### Parameters
- **servletContext** (jakarta.servlet.ServletContext) - Required - The ServletContext to initialize.

### Throws
- **jakarta.servlet.ServletException** - If any call against the given ServletContext throws a ServletException.
```

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

### getResourceByPath(String path)

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/support/FileSystemXmlApplicationContext.html

Resolves resource paths as file system paths. Note that even if a given path starts with a slash, it will get interpreted as relative to the current VM working directory.

```APIDOC
## Method: getResourceByPath(String path)

### Description
Resolves resource paths as file system paths. Note that even if a given path starts with a slash, it will get interpreted as relative to the current VM working directory. This is consistent with the semantics in a Servlet container.

### Method
protected Resource getResourceByPath(String path)

### Signature
`protected Resource getResourceByPath(String path)`

### Parameters
- **path** (String) - Required - The path to the resource.

### Returns
- **Resource** - The Resource handle.

### Overrides
- `getResourceByPath` in class `DefaultResourceLoader`

### See Also
- `AbstractRefreshableWebApplicationContext.getResourceByPath(String)`
```

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

### getReadHints(ResolvableType, ResolvableType, ServerHttpRequest, ServerHttpResponse)

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/codec/DecoderHttpMessageReader.html

Get additional hints for decoding for example based on the server request or annotations from controller method parameters. By default, delegate to the decoder if it is an instance of HttpMessageDecoder.

```APIDOC
## getReadHints(ResolvableType, ResolvableType, ServerHttpRequest, ServerHttpResponse)

### Description
Get additional hints for decoding for example based on the server request or annotations from controller method parameters. By default, delegate to the decoder if it is an instance of HttpMessageDecoder.

### Method
getReadHints

### Signature
protected Map<String,Object> getReadHints(ResolvableType actualType, ResolvableType elementType, ServerHttpRequest request, ServerHttpResponse response)

### Parameters
- **actualType** (ResolvableType) - Required - The actual type of the target method parameter
- **elementType** (ResolvableType) - Required - The type of Objects in the output stream
- **request** (ServerHttpRequest) - Required - The current request
- **response** (ServerHttpResponse) - Required - The current response

### Returns
- **Map<String,Object>** - Additional hints for decoding
```

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

### start()

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/client/ReactorClientHttpRequestFactory.html

Starts this component as part of the Lifecycle interface. Should not throw an exception if the component is already running.

```APIDOC
## start()

### Description
Start this component. Should not throw an exception if the component is already running. In the case of a container, this will propagate a hard start signal to all components that apply, even to non-auto-startup components.

### Method
start

```

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

### setAllowedMethods

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/cors/CorsConfiguration.html

Sets the HTTP methods to allow, for example, `"GET"`, `"POST"`, `"PUT"`, etc. The special value `"*"` allows all methods. The `Access-Control-Allow-Methods` response header is set either to the configured method or to `"*"`. If not set, only `"GET"` and `"HEAD"` are allowed.

```APIDOC
## setAllowedMethods

### Description
Sets the HTTP methods to allow, for example, `"GET"`, `"POST"`, `"PUT"`, etc. The special value `"*"` allows all methods. The `Access-Control-Allow-Methods` response header is set either to the configured method or to `"*"`. If not set, only `"GET"` and `"HEAD"` are allowed.

### Method
POST

### Endpoint
CorsConfiguration.setAllowedMethods(List<String> allowedMethods)

### Parameters
#### Request Body
- **allowedMethods** (List<String>) - Required - The HTTP methods to allow.

### Response
#### Success Response
No return value.
```

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

### getApplicationStartup()

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/ConfigurableApplicationContext.html

Returns the ApplicationStartup for this application context.

```APIDOC
## getApplicationStartup()

### Description
Returns the ApplicationStartup for this application context.

### Method
getApplicationStartup

### Parameters
None

### Return
ApplicationStartup
```

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

### scheduleAtFixedRate(Runnable task, Duration period)

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/scheduling/concurrent/ThreadPoolTaskScheduler.html

Schedules the given Runnable task to start as soon as possible and invoke it with the given period. Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

```APIDOC
## scheduleAtFixedRate(Runnable task, Duration period)

### Description
Schedules the given Runnable task to start as soon as possible and invoke it with the given period. Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

### Method
scheduleAtFixedRate

### Signature
public ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Duration period)

### Parameters
- **task** (Runnable) - Required - The Runnable to execute whenever the trigger fires
- **period** (Duration) - Required - The interval between successive executions of the task

### Returns
- **ScheduledFuture<?>** - A ScheduledFuture representing pending execution of the task
```

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

### StartupStep.Tag

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/core/metrics/StartupStep.Tag.html

Documentation for the StartupStep.Tag interface, which represents a simple key/value association for storing step metadata. It defines two methods to retrieve the tag's key and value.

```APIDOC
## Interface StartupStep.Tag

### Description
Simple key/value association for storing step metadata.

### Methods

#### getKey

```java
String getKey()
```

Return the `Tag` name.

#### getValue

```java
String getValue()
```

Return the `Tag` value.
```

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

### MockRestServiceServer with RestClient

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/test/web/client/MockRestServiceServer.html

Example usage of MockRestServiceServer with RestClient. It binds to a RestClient.Builder, sets up an expectation for a GET request to /hotels/42, responds with JSON, and verifies the expectation. Assumes static imports from MockRestRequestMatchers, MockRestResponseCreators, and ExpectedCount.

```java
RestClient.Builder clientBuilder = RestClient.builder();
MockRestServiceServer server = MockRestServiceServer.bindTo(clientBuilder).build();
RestClient restClient = clientBuilder.build();

server.expect(manyTimes(), requestTo("/hotels/42")).andExpect(method(HttpMethod.GET))
    .andRespond(withSuccess("{ \"id\" : \"42\", \"name\" : \"Holiday Inn\"}", MediaType.APPLICATION_JSON));

Hotel hotel = restClient.get().uri("/hotels/{id}", 42).retrieve().body(Hotel.class);
// Use the hotel instance...

// Verify all expectations met
server.verify();
```

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

### Kotlin get extension for PropertyResolver with Elvis operator

Source: https://docs.spring.io/spring-framework/docs/current/kdoc-api/spring-core/org.springframework.core.env/get.html

Use this extension to retrieve a property value with array-like syntax, returning a nullable String. The example shows a default fallback via the Elvis operator when the property is missing.

```kotlin
val name = env["name"] ?: "Seb"
```

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

### setUpgrade

Source: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/HttpHeaders.html

Sets the Upgrade header.

```APIDOC
## setUpgrade

### Description
Sets the (new) value of the `Upgrade` header.

### Method
void

### Parameters
- `upgrade` (String) - Optional - The upgrade value.

### Return Type
void
```
Tokens:
Raw