CoRouterFunctionDsl
Provide a WebFlux.fn RouterFunction Coroutines Kotlin DSL created by coRouter { }
in order to be able to write idiomatic Kotlin code.
Author
Sebastien Deleuze
Since
5.2
Functions
Return a RequestPredicate that tests if the request's accept } header is compatible with any of the given media types.
Route to the given handler function if the given accept predicate applies.
Merge externally defined router functions into this one.
Filter the response object for all routes created by this builder with the given response processing function. Filters are typically used to address cross-cutting concerns, such as logging, security, etc.
Return a composed request predicate that tests against both this predicate (String processed as a path predicate) AND the other predicate. When evaluating the composed predicate, if this predicate is false
, then the other predicate is not evaluated.
Filter the request object for all routes created by this builder with the given request processing function. Filters are typically used to address cross-cutting concerns, such as logging, security, etc.
Return a RequestPredicate that tests if the request's content type is included by any of the given media types.
Route to the given handler function if the given contentType predicate applies.
Allow to provide the default CoroutineContext, potentially dynamically based on the incoming ServerRequest.
Return a RequestPredicate that matches if request's HTTP method is DELETE
and the given pattern
matches against the request path.
Adds a route to the given handler function that handles all HTTP DELETE
requests that match the given pattern.
Filters all routes created by this router with the given filter function. Filter functions are typically used to address cross-cutting concerns, such as logging, security, etc.
Return a RequestPredicate that matches if request's HTTP method is GET
and the given pattern
matches against the request path.
Adds a route to the given handler function that handles all HTTP GET
requests that match the given pattern.
Return a RequestPredicate that matches if request's HTTP method is HEAD
and the given pattern
matches against the request path.
Adds a route to the given handler function that handles all HTTP HEAD
requests that match the given pattern.
Return a RequestPredicate that tests the request's headers against the given headers predicate.
Route to the given handler function if the given headers predicate applies.
Route to the given handler function if the given predicate (String processed as a path predicate) applies.
Route to the given handler function if the given request predicate applies.
Return a RequestPredicate that tests against the given HTTP method.
Route to the given handler function if the given method predicate applies.
Route to the given router function if the given request predicate (String processed as a path predicate) applies. This method can be used to create nested routes, where a group of routes share a common path (prefix), header, or other request predicate.
Route to the given router function if the given request predicate applies. This method can be used to create nested routes, where a group of routes share a common path (prefix), header, or other request predicate.
Return a predicate that represents the logical negation of this predicate.
Filters all exceptions that match the predicate by applying the given response provider function.
Return a RequestPredicate that matches if request's HTTP method is OPTIONS
and the given pattern
matches against the request path.
Adds a route to the given handler function that handles all HTTP OPTIONS
requests that match the given pattern.
Return a composed request predicate that tests against both this predicate (String processed as a path predicate) OR the other predicate. When evaluating the composed predicate, if this predicate is true
, then the other predicate is not evaluated.
Return a RequestPredicate that matches if request's HTTP method is PATCH
and the given pattern
matches against the request path.
Adds a route to the given handler function that handles all HTTP PATCH
requests that match the given pattern.
Return a RequestPredicate that tests the request path against the given path pattern.
Route to the given handler function if the given path predicate applies.
Return a RequestPredicate that matches if the request's path matches the given predicate.
Return a RequestPredicate that matches if the request's path has the given extension.
Route to the given handler function if the given pathExtension predicate applies.
Return a RequestPredicate that matches if request's HTTP method is POST
and the given pattern
matches against the request path.
Adds a route to the given handler function that handles all HTTP POST
requests that match the given pattern.
Return a RequestPredicate that matches if request's HTTP method is PUT
and the given pattern
matches against the request path.
Adds a route to the given handler function that handles all HTTP PUT
requests that match the given pattern.
Return a RequestPredicate that tests the request's query parameter of the given name against the given predicate.
Route to the given handler function if the given queryParam predicate applies.
Route to resources using the provided lookup function. If the lookup function provides a Resource for the given request, it will be it will be exposed using a HandlerFunction that handles GET, HEAD, and OPTIONS requests.
Route requests that match the given pattern to resources relative to the given root location.
Add an attribute with the given name and value to the last route built with this builder.
Manipulate the attributes of the last route built with the given consumer.