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
EntityResponse<T>
Entity-specific subtype ofServerResponse
that exposes entity data.interface
RenderingResponse
Rendering-specific subtype ofServerResponse
that exposes model and template data.Methods in org.springframework.web.servlet.function with type parameters of type ServerResponse Modifier and Type Method Description 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 aServerResponse
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 theServerRequest
.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 theServerResponse
.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 theServerResponse
.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 ServerResponse
ServerResponse.BodyBuilder. body(Object body)
Set the body of the response to the givenObject
and return it.<T> ServerResponse
ServerResponse.BodyBuilder. body(T body, ParameterizedTypeReference<T> bodyType)
Set the body of the response to the givenObject
and return it.ServerResponse
ServerResponse.HeadersBuilder. build()
Build the response entity with no body.ServerResponse
ServerResponse.HeadersBuilder. build(BiFunction<HttpServletRequest,HttpServletResponse,ModelAndView> writeFunction)
Build the response entity with a custom write function.ServerResponse
ServerResponse.BodyBuilder. render(String name, Object... modelAttributes)
Render the template with the givenname
using the givenmodelAttributes
.ServerResponse
ServerResponse.BodyBuilder. render(String name, Map<String,?> model)
Render the template with the givenname
using the givenmodel
.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 theRouterFunction
.default Optional<ServerResponse>
ServerRequest. checkNotModified(String etag)
Check whether the requested resource has been modified given the suppliedETag
(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 suppliedETag
(entity tag) and last-modified timestamp, as determined by the application.static RouterFunction<ServerResponse>
RouterFunctions. resources(String pattern, Resource location)
Route requests that match the given pattern to resources relative to the given root location.static RouterFunction<ServerResponse>
RouterFunctions. resources(Function<ServerRequest,Optional<Resource>> lookupFunction)
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 HTTPDELETE
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 HTTPDELETE
requests that match the given pattern and 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 HTTPGET
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 HTTPGET
requests that match the given pattern and predicate.RouterFunctions.Builder
RouterFunctions.Builder. HEAD(String pattern, HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTPHEAD
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 HTTPHEAD
requests that match the given pattern and 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 HTTPOPTIONS
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 HTTPOPTIONS
requests that match the given pattern and predicate.RouterFunctions.Builder
RouterFunctions.Builder. PATCH(String pattern, HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTPPATCH
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 HTTPPATCH
requests that match the given pattern and 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 HTTPPOST
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 HTTPPOST
requests that match the given pattern and predicate.RouterFunctions.Builder
RouterFunctions.Builder. PUT(String pattern, HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTPPUT
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 HTTPPUT
requests that match the given pattern and 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.