# Uses of Interface
org.springframework.web.servlet.function.ServerResponse

Packages that use ServerResponse
Package
Description
org.springframework.web.servlet.function
Provides the types that make up Spring's functional web framework for Servlet environments.

## Uses of ServerResponse in org.springframework.web.servlet.function

Classes in org.springframework.web.servlet.function with type parameters of type ServerResponse
Modifier and Type
Interface
Description
`interface`
`HandlerFilterFunction<T extends ServerResponse,R extends ServerResponse>`
Represents a function that filters a handler function.
`interface`
`HandlerFilterFunction<T extends ServerResponse,R extends ServerResponse>`
Represents a function that filters a handler function.
`interface`
`HandlerFunction<T extends ServerResponse>`
Represents a function that handles a request.
`interface`
`RouterFunction<T extends ServerResponse>`
Represents a function that routes to a handler function.
Subinterfaces of ServerResponse in org.springframework.web.servlet.function
Modifier and Type
Interface
Description
`interface`
`AsyncServerResponse`
Asynchronous subtype of `ServerResponse` that exposes the future response.
`interface`
`EntityResponse<T>`
Entity-specific subtype of `ServerResponse` that exposes entity data.
`interface`
`RenderingResponse`
Rendering-specific subtype of `ServerResponse` that exposes model and template data.
Methods in org.springframework.web.servlet.function with type parameters of type ServerResponse
Modifier and Type
Method
Description
`static <T extends ServerResponse>
RouterFunction<T>`
RouterFunctions.`changeParser(RouterFunction<T> routerFunction, org.springframework.web.util.pattern.PathPatternParser parser)`
Changes the `PathPatternParser` on the given router function.
`default <S extends ServerResponse>
RouterFunction<S>`
RouterFunction.`filter(HandlerFilterFunction<T,S> filterFunction)`
Filter all handler functions routed by this function with the given filter function.
`static <T extends ServerResponse>
RouterFunction<T>`
RouterFunctions.`nest(RequestPredicate predicate, RouterFunction<T> routerFunction)`
Route to the given router function if the given request predicate applies.
`static <T extends ServerResponse>
HandlerFilterFunction<T,T>`
HandlerFilterFunction.`ofErrorHandler(Predicate<Throwable> predicate, BiFunction<Throwable,ServerRequest,T> errorHandler)`
Adapt the given predicate and response provider function to a filter function that returns a `ServerResponse` on a given exception.
`static <T extends ServerResponse>
HandlerFilterFunction<T,T>`
HandlerFilterFunction.`ofRequestProcessor(Function<ServerRequest,ServerRequest> requestProcessor)`
Adapt the given request processor function to a filter function that only operates on the `ServerRequest`.
`static <T extends ServerResponse, R extends ServerResponse>
HandlerFilterFunction<T,R>`
HandlerFilterFunction.`ofResponseProcessor(BiFunction<ServerRequest,T,R> responseProcessor)`
Adapt the given response processor function to a filter function that only operates on the `ServerResponse`.
`static <T extends ServerResponse, R extends ServerResponse>
HandlerFilterFunction<T,R>`
HandlerFilterFunction.`ofResponseProcessor(BiFunction<ServerRequest,T,R> responseProcessor)`
Adapt the given response processor function to a filter function that only operates on the `ServerResponse`.
`static <T extends ServerResponse>
RouterFunction<T>`
RouterFunctions.`route(RequestPredicate predicate, HandlerFunction<T> handlerFunction)`
Route to the given handler function if the given request predicate applies.
Methods in org.springframework.web.servlet.function that return ServerResponse
Modifier and Type
Method
Description
`static ServerResponse`
ServerResponse.`async(Object asyncResponse)`
Create a (built) response with the given asynchronous response.
`static ServerResponse`
ServerResponse.`async(Object asyncResponse, Duration timeout)`
Create a (built) response with the given asynchronous response.
`ServerResponse`
AsyncServerResponse.`block()`
Blocks indefinitely until the future response is obtained.
`ServerResponse`
ServerResponse.BodyBuilder.`body(Object body)`
Set the body of the response to the given `Object` and return it.
`<T> ServerResponse`
ServerResponse.BodyBuilder.`body(T body, org.springframework.core.ParameterizedTypeReference<T> bodyType)`
Set the body of the response to the given `Object` and return it.
`ServerResponse`
ServerResponse.HeadersBuilder.`build()`
Build the response entity with no body.
`ServerResponse`
ServerResponse.HeadersBuilder.`build(ServerResponse.HeadersBuilder.WriteFunction writeFunction)`
Build the response entity with a custom write function.
`static ServerResponse`
ServerResponse.`from(org.springframework.web.ErrorResponse response)`
Create a `ServerResponse` from the given `ErrorResponse`.
`ServerResponse`
ServerResponse.BodyBuilder.`render(String name, Object... modelAttributes)`
Render the template with the given `name` using the given `modelAttributes`.
`ServerResponse`
ServerResponse.BodyBuilder.`render(String name, Map<String,?> model)`
Render the template with the given `name` using the given `model`.
`static ServerResponse`
ServerResponse.`sse(Consumer<ServerResponse.SseBuilder> consumer)`
Create a server-sent event response.
`static ServerResponse`
ServerResponse.`sse(Consumer<ServerResponse.SseBuilder> consumer, Duration timeout)`
Create a server-sent event response.
`ServerResponse`
ServerResponse.BodyBuilder.`stream(Consumer<ServerResponse.StreamBuilder> streamConsumer)`
Create a low-level streaming response; for SSE support, see `sse(Consumer)`.
Methods in org.springframework.web.servlet.function that return types with arguments of type ServerResponse
Modifier and Type
Method
Description
`RouterFunction<ServerResponse>`
RouterFunctions.Builder.`build()`
Builds the `RouterFunction`.
`default Optional<ServerResponse>`
ServerRequest.`checkNotModified(String etag)`
Check whether the requested resource has been modified given the supplied `ETag` (entity tag), as determined by the application.
`default Optional<ServerResponse>`
ServerRequest.`checkNotModified(Instant lastModified)`
Check whether the requested resource has been modified given the supplied last-modified timestamp (as determined by the application).
`default Optional<ServerResponse>`
ServerRequest.`checkNotModified(Instant lastModified, String etag)`
Check whether the requested resource has been modified given the supplied `ETag` (entity tag) and last-modified timestamp, as determined by the application.
`static RouterFunction<ServerResponse>`
RouterFunctions.`resource(RequestPredicate predicate, org.springframework.core.io.Resource resource)`
Route requests that match the given predicate to the given resource.
`static RouterFunction<ServerResponse>`
RouterFunctions.`resource(RequestPredicate predicate, org.springframework.core.io.Resource resource, BiConsumer<org.springframework.core.io.Resource,org.springframework.http.HttpHeaders> headersConsumer)`
Route requests that match the given predicate to the given resource.
`static RouterFunction<ServerResponse>`
RouterFunctions.`resources(String pattern, org.springframework.core.io.Resource location)`
Route requests that match the given pattern to resources relative to the given root location.
`static RouterFunction<ServerResponse>`
RouterFunctions.`resources(String pattern, org.springframework.core.io.Resource location, BiConsumer<org.springframework.core.io.Resource,org.springframework.http.HttpHeaders> headersConsumer)`
Route requests that match the given pattern to resources relative to the given root location.
`static RouterFunction<ServerResponse>`
RouterFunctions.`resources(Function<ServerRequest,Optional<org.springframework.core.io.Resource>> lookupFunction)`
Route to resources using the provided lookup function.
`static RouterFunction<ServerResponse>`
RouterFunctions.`resources(Function<ServerRequest,Optional<org.springframework.core.io.Resource>> lookupFunction, BiConsumer<org.springframework.core.io.Resource,org.springframework.http.HttpHeaders> headersConsumer)`
Route to resources using the provided lookup function.
Methods in org.springframework.web.servlet.function with parameters of type ServerResponse
Modifier and Type
Method
Description
`static ServerResponse.BodyBuilder`
ServerResponse.`from(ServerResponse other)`
Create a builder with the status code and headers of the given response.
Method parameters in org.springframework.web.servlet.function with type arguments of type ServerResponse
Modifier and Type
Method
Description
`RouterFunctions.Builder`
RouterFunctions.Builder.`add(RouterFunction<ServerResponse> routerFunction)`
Adds the given route to this builder.
`RouterFunctions.Builder`
RouterFunctions.Builder.`after(BiFunction<ServerRequest,ServerResponse,ServerResponse> responseProcessor)`
Filter the response object for all routes created by this builder with the given response processing function.
`RouterFunctions.Builder`
RouterFunctions.Builder.`after(BiFunction<ServerRequest,ServerResponse,ServerResponse> responseProcessor)`
Filter the response object for all routes created by this builder with the given response processing function.
`RouterFunctions.Builder`
RouterFunctions.Builder.`DELETE(String pattern, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `DELETE` requests that match the given pattern.
`RouterFunctions.Builder`
RouterFunctions.Builder.`DELETE(String pattern, RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `DELETE` requests that match the given pattern and predicate.
`RouterFunctions.Builder`
RouterFunctions.Builder.`DELETE(HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles HTTP `DELETE` requests.
`RouterFunctions.Builder`
RouterFunctions.Builder.`DELETE(RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `DELETE` requests that match the given predicate.
`RouterFunctions.Builder`
RouterFunctions.Builder.`filter(HandlerFilterFunction<ServerResponse,ServerResponse> filterFunction)`
Filters all routes created by this builder with the given filter function.
`RouterFunctions.Builder`
RouterFunctions.Builder.`filter(HandlerFilterFunction<ServerResponse,ServerResponse> filterFunction)`
Filters all routes created by this builder with the given filter function.
`RouterFunctions.Builder`
RouterFunctions.Builder.`GET(String pattern, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `GET` requests that match the given pattern.
`RouterFunctions.Builder`
RouterFunctions.Builder.`GET(String pattern, RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `GET` requests that match the given pattern and predicate.
`RouterFunctions.Builder`
RouterFunctions.Builder.`GET(HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles HTTP `GET` requests.
`RouterFunctions.Builder`
RouterFunctions.Builder.`GET(RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `GET` requests that match the given predicate.
`RouterFunctions.Builder`
RouterFunctions.Builder.`HEAD(String pattern, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `HEAD` requests that match the given pattern.
`RouterFunctions.Builder`
RouterFunctions.Builder.`HEAD(String pattern, RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `HEAD` requests that match the given pattern and predicate.
`RouterFunctions.Builder`
RouterFunctions.Builder.`HEAD(HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles HTTP `HEAD` requests.
`RouterFunctions.Builder`
RouterFunctions.Builder.`HEAD(RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `HEAD` requests that match the given predicate.
`RouterFunctions.Builder`
RouterFunctions.Builder.`nest(RequestPredicate predicate, Supplier<RouterFunction<ServerResponse>> routerFunctionSupplier)`
Route to the supplied router function if the given request predicate applies.
`RouterFunctions.Builder`
RouterFunctions.Builder.`onError(Class<? extends Throwable> exceptionType, BiFunction<Throwable,ServerRequest,ServerResponse> responseProvider)`
Filters all exceptions of the given type by applying the given response provider function.
`RouterFunctions.Builder`
RouterFunctions.Builder.`onError(Predicate<Throwable> predicate, BiFunction<Throwable,ServerRequest,ServerResponse> responseProvider)`
Filters all exceptions that match the predicate by applying the given response provider function.
`RouterFunctions.Builder`
RouterFunctions.Builder.`OPTIONS(String pattern, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `OPTIONS` requests that match the given pattern.
`RouterFunctions.Builder`
RouterFunctions.Builder.`OPTIONS(String pattern, RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `OPTIONS` requests that match the given pattern and predicate.
`RouterFunctions.Builder`
RouterFunctions.Builder.`OPTIONS(HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles HTTP `OPTIONS` requests.
`RouterFunctions.Builder`
RouterFunctions.Builder.`OPTIONS(RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `OPTIONS` requests that match the given predicate.
`RouterFunctions.Builder`
RouterFunctions.Builder.`PATCH(String pattern, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `PATCH` requests that match the given pattern.
`RouterFunctions.Builder`
RouterFunctions.Builder.`PATCH(String pattern, RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `PATCH` requests that match the given pattern and predicate.
`RouterFunctions.Builder`
RouterFunctions.Builder.`PATCH(HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles HTTP `PATCH` requests.
`RouterFunctions.Builder`
RouterFunctions.Builder.`PATCH(RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `PATCH` requests that match the given predicate.
`RouterFunctions.Builder`
RouterFunctions.Builder.`path(String pattern, Supplier<RouterFunction<ServerResponse>> routerFunctionSupplier)`
Route to the supplied router function if the given path prefix pattern applies.
`RouterFunctions.Builder`
RouterFunctions.Builder.`POST(String pattern, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `POST` requests that match the given pattern.
`RouterFunctions.Builder`
RouterFunctions.Builder.`POST(String pattern, RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `POST` requests that match the given pattern and predicate.
`RouterFunctions.Builder`
RouterFunctions.Builder.`POST(HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles HTTP `POST` requests.
`RouterFunctions.Builder`
RouterFunctions.Builder.`POST(RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `POST` requests that match the given predicate.
`RouterFunctions.Builder`
RouterFunctions.Builder.`PUT(String pattern, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `PUT` requests that match the given pattern.
`RouterFunctions.Builder`
RouterFunctions.Builder.`PUT(String pattern, RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `PUT` requests that match the given pattern and predicate.
`RouterFunctions.Builder`
RouterFunctions.Builder.`PUT(HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles HTTP `PUT` requests.
`RouterFunctions.Builder`
RouterFunctions.Builder.`PUT(RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all HTTP `PUT` requests that match the given predicate.
`RouterFunctions.Builder`
RouterFunctions.Builder.`route(RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)`
Adds a route to the given handler function that handles all requests that match the given predicate.