Top Description Inners Fields Constructors Methods

org.springframework.web.reactive.function.server

public abstract Class RouterFunctions

Class Inheritance

extends Object

java.lang.Object
org.springframework.web.reactive.function.server.RouterFunctions

Imports

java.util.Collections, .LinkedHashMap, .List, .Map, java.util.function.BiConsumer, .BiFunction, .Consumer, .Function, .Predicate, .Supplier, org.apache.commons.logging.Log, .LogFactory, reactor.core.publisher.Flux, .Mono, org.springframework.core.io.Resource, org.springframework.http.HttpHeaders, .HttpStatus, org.springframework.http.codec.HttpMessageWriter, org.springframework.http.server.reactive.HttpHandler, org.springframework.util.Assert, org.springframework.web.reactive.result.view.ViewResolver, org.springframework.web.server.ResponseStatusException, .ServerWebExchange, .WebHandler, org.springframework.web.server.adapter.WebHttpHandlerBuilder, org.springframework.web.util.pattern.PathPatternParser

Central entry point to Spring's functional web framework. Exposes routing functionality, such as to create a RouterFunction using a discoverable builder-style API, to create a RouterFunction given a RequestPredicate and HandlerFunction, and to do further subrouting on an existing routing function.

Additionally, this class can transform a RouterFunction into an HttpHandler, which can be run in Servlet environments, Reactor, or Undertow.

Authors: Arjen Poutsma, Sebastien Deleuze
Since: 5.0

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv abstract static class	RouterFunctions.AbstractRouterFunction<T extends ServerResponse>
pack-priv static class	RouterFunctions.AttributesRouterFunction<T extends ServerResponse>
public static interface	RouterFunctions.Builder Represents a discoverable builder for router functions.
private static class	RouterFunctions.DefaultNestedRouterFunction<T extends ServerResponse>
private static class	RouterFunctions.DefaultRouterFunction<T extends ServerResponse>
pack-priv static class	RouterFunctions.DifferentComposedRouterFunction A composed routing function that first invokes one function, and then invokes another function (of a different response type) if this route had no result.
pack-priv static class	RouterFunctions.FilteredRouterFunction< the type of the handler function to filter T extends ServerResponse, the type of the response of the function S extends ServerResponse> Filter the specified handler functions with the given filter function.
private static class	RouterFunctions.HandlerStrategiesResponseContext
private static class	RouterFunctions.ResourcesRouterFunction
private static class	RouterFunctions.RouterFunctionWebHandler
pack-priv static class	RouterFunctions.SameComposedRouterFunction< the server response type T extends ServerResponse> A composed routing function that first invokes one function, and then invokes the another function (of the same response type `T`) if this route had no result.
public static interface	RouterFunctions.Visitor Receives notifications from the logical structure of router functions.

Field Summary

Modifier and Type	Field and Description
private static final Log	logger
public static final String	MATCHING_PATTERN_ATTRIBUTE Name of the `attribute` that contains the matching pattern, as a `org.springframework.web.util.pattern.PathPattern`.
public static final String	REQUEST_ATTRIBUTE Name of the `ServerWebExchange` attribute that contains the `ServerRequest`.
public static final String	URI_TEMPLATE_VARIABLES_ATTRIBUTE Name of the `ServerWebExchange` attribute that contains the URI templates map, mapping variable names to values.

Constructor Summary

Access	Constructor and Description
public	RouterFunctions()

Method Summary

Modifier and Type	Method and Description
public static < the type of response returned by the handler function T extends ServerResponse> RouterFunction<T>	Returns: the change router function changeParser(RouterFunction<T> the router function to change the parser in routerFunction, PathPatternParser the parser to change to. parser) Changes the `PathPatternParser` on the given router function.
public static < the type of response returned by the handler function T extends ServerResponse> RouterFunction<T>	Returns: a router function that routes to `routerFunction` if `predicate` evaluates to `true` nest(RequestPredicate the predicate to test predicate, RouterFunction<T> the nested router function to delegate to if the predicate applies routerFunction) Route to the given router function if the given request predicate applies.
public static RouterFunction<ServerResponse>	Returns: a router function that routes to a resource resource(RequestPredicate predicate to match predicate, Resource the resources to serve resource) Route requests that match the given predicate to the given resource.
public static RouterFunction<ServerResponse>	Returns: a router function that routes to a resource resource(RequestPredicate predicate to match predicate, Resource the resources to serve resource, BiConsumer<Resource, HttpHeaders> provides access to the HTTP headers for served resources headersConsumer) Route requests that match the given predicate to the given resource.
public static Function<ServerRequest, Mono<Resource>>	Returns: the default resource lookup function for the given parameters. resourceLookupFunction(String the pattern to match pattern, Resource the location directory relative to which resources should be resolved location) Returns the resource lookup function used by `resources(String, Resource)`.
public static RouterFunction<ServerResponse>	Returns: a router function that routes to resources resources(String the pattern to match pattern, Resource the location directory relative to which resources should be resolved location) Route requests that match the given pattern to resources relative to the given root location.
public static RouterFunction<ServerResponse>	Returns: a router function that routes to resources resources(String the pattern to match pattern, Resource the location directory relative to which resources should be resolved location, BiConsumer<Resource, HttpHeaders> provides access to the HTTP headers for served resources headersConsumer) Route requests that match the given pattern to resources relative to the given root location.
public static RouterFunction<ServerResponse>	Returns: a router function that routes to resources resources(Function<ServerRequest, Mono<Resource>> the function to provide a `Resource` given the `ServerRequest` lookupFunction) Route to resources using the provided lookup function.
public static RouterFunction<ServerResponse>	Returns: a router function that routes to resources resources(Function<ServerRequest, Mono<Resource>> the function to provide a `Resource` given the `ServerRequest` lookupFunction, BiConsumer<Resource, HttpHeaders> provides access to the HTTP headers for served resources headersConsumer) Route to resources using the provided lookup function.
public static RouterFunctions.Builder	Returns: a router function builder route() Offers a discoverable way to create router functions through a builder-style interface.
public static < the type of response returned by the handler function T extends ServerResponse> RouterFunction<T>	Returns: a router function that routes to `handlerFunction` if `predicate` evaluates to `true` route(RequestPredicate the predicate to test predicate, HandlerFunction<T> the handler function to route to if the predicate applies handlerFunction) Route to the given handler function if the given request predicate applies.
public static HttpHandler	Returns: an HTTP handler that handles HTTP request using the given router function toHttpHandler(RouterFunction<?> the router function to convert routerFunction) Convert the given router function into a `HttpHandler`.
public static HttpHandler	Returns: an HTTP handler that handles HTTP request using the given router function toHttpHandler(RouterFunction<?> the router function to convert routerFunction, HandlerStrategies the strategies to use strategies) Convert the given router function into a `HttpHandler`, using the given strategies.
public static WebHandler	Returns: a web handler that handles web request using the given router function toWebHandler(RouterFunction<?> the router function to convert routerFunction) Convert the given router function into a `WebHandler`.
public static WebHandler	Returns: a web handler that handles web request using the given router function toWebHandler(RouterFunction<?> the router function to convert routerFunction, HandlerStrategies the strategies to use strategies) Convert the given router function into a `WebHandler`, using the given strategies.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait