Uses of Interface
org.springframework.web.servlet.function.RouterFunction
Package
Description
Support for testing Spring MVC applications via
WebTestClient
with MockMvc
for server request
handling.Contains built-in
MockMvcBuilder
implementations.Provides the types that make up Spring's functional web framework for Servlet environments.
Classes supporting the
org.springframework.web.servlet.function
package.-
Uses of RouterFunction in org.springframework.test.web.servlet.client
Modifier and TypeMethodDescriptionMockMvcWebTestClient.bindToRouterFunction
(RouterFunction<?>... routerFunctions) Begin creating aWebTestClient
by providing theRouterFunction
instance(s) to handle requests with. -
Uses of RouterFunction in org.springframework.test.web.servlet.setup
Modifier and TypeMethodDescriptionstatic RouterFunctionMockMvcBuilder
MockMvcBuilders.routerFunctions
(RouterFunction<?>... routerFunctions) Build aMockMvc
instance by registering one or moreRouterFunction
instances and configuring Spring MVC infrastructure programmatically.ModifierConstructorDescriptionprotected
RouterFunctionMockMvcBuilder
(RouterFunction<?>... routerFunctions) -
Uses of RouterFunction in org.springframework.web.servlet.function
Modifier and TypeMethodDescriptiondefault RouterFunction<T>
RouterFunction.and
(RouterFunction<T> other) Return a composed routing function that first invokes this function, and then invokes theother
function (of the same response typeT
) if this route had no result.default RouterFunction<T>
RouterFunction.andNest
(RequestPredicate predicate, RouterFunction<T> routerFunction) Return a composed routing function that routes to the given router function if this route does not match and the given request predicate applies.default RouterFunction<?>
RouterFunction.andOther
(RouterFunction<?> other) Return a composed routing function that first invokes this function, and then invokes theother
function (of a different response type) if this route had no result.default RouterFunction<T>
RouterFunction.andRoute
(RequestPredicate predicate, HandlerFunction<T> handlerFunction) Return a composed routing function that routes to the given handler function if this route does not match and the given request predicate applies.RouterFunctions.Builder.build()
Builds theRouterFunction
.static <T extends ServerResponse>
RouterFunction<T>RouterFunctions.changeParser
(RouterFunction<T> routerFunction, PathPatternParser parser) Changes thePathPatternParser
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 RouterFunction<ServerResponse>
RouterFunctions.resource
(RequestPredicate predicate, Resource resource) Route requests that match the given predicate to the given resource.static RouterFunction<ServerResponse>
RouterFunctions.resource
(RequestPredicate predicate, Resource resource, BiConsumer<Resource, HttpHeaders> headersConsumer) Route requests that match the given predicate to the given resource.static RouterFunction<ServerResponse>
Route requests that match the given pattern to resources relative to the given root location.static RouterFunction<ServerResponse>
RouterFunctions.resources
(String pattern, Resource location, BiConsumer<Resource, 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<Resource>> lookupFunction) Route to resources using the provided lookup function.static RouterFunction<ServerResponse>
RouterFunctions.resources
(Function<ServerRequest, Optional<Resource>> lookupFunction, BiConsumer<Resource, HttpHeaders> headersConsumer) Route to resources using the provided lookup function.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.default RouterFunction<T>
RouterFunction.withAttribute
(String name, Object value) Return a new routing function with the given attribute.default RouterFunction<T>
RouterFunction.withAttributes
(Consumer<Map<String, Object>> attributesConsumer) Return a new routing function with attributes manipulated with the given consumer.Modifier and TypeMethodDescriptionRouterFunctions.Builder.add
(RouterFunction<ServerResponse> routerFunction) Adds the given route to this builder.default RouterFunction<T>
RouterFunction.and
(RouterFunction<T> other) Return a composed routing function that first invokes this function, and then invokes theother
function (of the same response typeT
) if this route had no result.default RouterFunction<T>
RouterFunction.andNest
(RequestPredicate predicate, RouterFunction<T> routerFunction) Return a composed routing function that routes to the given router function if this route does not match and the given request predicate applies.default RouterFunction<?>
RouterFunction.andOther
(RouterFunction<?> other) Return a composed routing function that first invokes this function, and then invokes theother
function (of a different response type) if this route had no result.static <T extends ServerResponse>
RouterFunction<T>RouterFunctions.changeParser
(RouterFunction<T> routerFunction, PathPatternParser parser) Changes thePathPatternParser
on the given router 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.void
RouterFunctions.Visitor.unknown
(RouterFunction<?> routerFunction) Receive notification of an unknown router function.Modifier and TypeMethodDescriptionRouterFunctions.Builder.nest
(RequestPredicate predicate, Supplier<RouterFunction<ServerResponse>> routerFunctionSupplier) Route to the supplied router function if the given request predicate applies.RouterFunctions.Builder.path
(String pattern, Supplier<RouterFunction<ServerResponse>> routerFunctionSupplier) Route to the supplied router function if the given path prefix pattern applies. -
Uses of RouterFunction in org.springframework.web.servlet.function.support
Modifier and TypeMethodDescriptionRouterFunctionMapping.getRouterFunction()
Return the configuredRouterFunction
.Modifier and TypeMethodDescriptionvoid
RouterFunctionMapping.setRouterFunction
(RouterFunction<?> routerFunction) Set the router function to map to.ModifierConstructorDescriptionRouterFunctionMapping
(RouterFunction<?> routerFunction) Create aRouterFunctionMapping
with the givenRouterFunction
.