| Package | Description | 
|---|---|
| org.springframework.web.servlet.function | Provides the types that make up Spring's functional web framework for Servlet environments. | 
| Modifier and Type | Interface and 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. | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | EntityResponse<T>Entity-specific subtype of  ServerResponsethat exposes entity data. | 
| interface  | RenderingResponseRendering-specific subtype of  ServerResponsethat exposes model and template data. | 
| Modifier and Type | Method and Description | 
|---|---|
| default <S extends ServerResponse> | RouterFunction. filter(HandlerFilterFunction<T,S> filterFunction)Filter all handler functions routed by this function with the given
 filter function. | 
| static <T extends ServerResponse> | RouterFunctions. nest(RequestPredicate predicate,
    RouterFunction<T> routerFunction)Route to the given router function if the given request predicate applies. | 
| static <T extends ServerResponse> | 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  ServerResponseon a given exception. | 
| static <T extends ServerResponse> | 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. 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. 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> | RouterFunctions. route(RequestPredicate predicate,
     HandlerFunction<T> handlerFunction)Route to the given handler function if the given request predicate applies. | 
| Modifier and Type | Method and Description | 
|---|---|
| ServerResponse | ServerResponse.BodyBuilder. body(Object body)Set the body of the response to the given  Objectand return it. | 
| <T> ServerResponse | ServerResponse.BodyBuilder. body(T body,
    ParameterizedTypeReference<T> bodyType)Set the body of the response to the given  Objectand 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,
      Map<String,?> model)Render the template with the given  nameusing the givenmodel. | 
| ServerResponse | ServerResponse.BodyBuilder. render(String name,
      Object... modelAttributes)Render the template with the given  nameusing the givenmodelAttributes. | 
| Modifier and Type | Method and Description | 
|---|---|
| RouterFunction<ServerResponse> | RouterFunctions.Builder. build()Builds the  RouterFunction. | 
| 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. | 
| 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. | 
| static RouterFunction<ServerResponse> | RouterFunctions. resources(Function<ServerRequest,Optional<Resource>> lookupFunction)Route to resources using the provided lookup function. | 
| static RouterFunction<ServerResponse> | RouterFunctions. resources(String pattern,
         Resource location)Route requests that match the given pattern to resources relative to the given root location. | 
| Modifier and Type | Method and Description | 
|---|---|
| static ServerResponse.BodyBuilder | ServerResponse. from(ServerResponse other)Create a builder with the status code and headers of the given response. | 
| Modifier and Type | Method and 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  DELETErequests
 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  DELETErequests
 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 HTTP  GETrequests
 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  GETrequests
 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 HTTP  HEADrequests
 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  HEADrequests
 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 HTTP  OPTIONSrequests
 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  OPTIONSrequests
 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 HTTP  PATCHrequests
 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  PATCHrequests
 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 HTTP  POSTrequests
 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  POSTrequests
 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 HTTP  PUTrequests
 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  PUTrequests
 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. |