spring-framework / org.springframework.web.reactive.function.server / RouterFunctionDsl

RouterFunctionDsl

class RouterFunctionDsl

Provide a WebFlux.fn RouterFunction Reactive Kotlin DSL created by router { } in order to be able to write idiomatic Kotlin code.

Author
Sebastien Deleuze

Author
Yevhenii Melnyk

Since
5.0

Constructors

<init>

RouterFunctionDsl(init: RouterFunctionDsl.() -> Unit)

Provide a WebFlux.fn RouterFunction Reactive Kotlin DSL created by router { } in order to be able to write idiomatic Kotlin code.

Functions

accept	`fun accept(mediaType: MediaType, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` Route to the given handler function if the given accept predicate applies. `fun accept(vararg mediaTypes: MediaType): RequestPredicate` Return a RequestPredicate that tests if the request's accept header is compatible with any of the given media types.
accepted	`fun accepted(): BodyBuilder` Create a builder with an 202 Accepted status.
add	`fun add(routerFunction: RouterFunction<ServerResponse>): Unit` Merge externally defined router functions into this one.
after	`fun after(responseProcessor: (ServerRequest, ServerResponse) -> ServerResponse): Unit` 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.
and	`infix fun RequestPredicate.and(other: String): RequestPredicate` Return a composed request predicate that tests against both this predicate AND the other predicate (String processed as a path predicate). When evaluating the composed predicate, if this predicate is `false`, then the other predicate is not evaluated. `infix fun String.and(other: RequestPredicate): RequestPredicate` 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. `infix fun RequestPredicate.and(other: RequestPredicate): RequestPredicate` Return a composed request predicate that tests against both this predicate AND the other predicate. When evaluating the composed predicate, if this predicate is `false`, then the other predicate is not evaluated.
badRequest	`fun badRequest(): BodyBuilder` Create a builder with a 400 Bad Request status.
before	`fun before(requestProcessor: (ServerRequest) -> ServerRequest): Unit` 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.
contentType	`fun contentType(mediaTypes: MediaType, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` Route to the given handler function if the given contentType predicate applies. `fun contentType(vararg mediaTypes: MediaType): RequestPredicate` Return a RequestPredicate that tests if the request's content type is included by any of the given media types.
created	`fun created(location: URI): BodyBuilder` Create a new builder with a 201 Created status and a location header set to the given URI.
DELETE	`fun DELETE(pattern: String, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` `fun DELETE(pattern: String, predicate: RequestPredicate, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` Adds a route to the given handler function that handles all HTTP `DELETE` requests that match the given pattern. `fun DELETE(pattern: String): RequestPredicate` Return a RequestPredicate that matches if request's HTTP method is `DELETE` and the given `pattern` matches against the request path.
filter	`fun filter(filterFunction: (ServerRequest, (ServerRequest) -> Mono<ServerResponse>) -> Mono<ServerResponse>): Unit` 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.
from	`fun from(other: ServerResponse): BodyBuilder` Create a builder with the status code and headers of the given response.
GET	`fun GET(pattern: String, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` Adds a route to the given handler function that handles all HTTP `GET` requests that match the given pattern. `fun GET(pattern: String, predicate: RequestPredicate, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` Adds a route to the given handler function that handles all HTTP `GET` requests that match the given pattern and predicate. `fun GET(pattern: String): RequestPredicate` Return a RequestPredicate that matches if request's HTTP method is `GET` and the given pattern matches against the request path.
HEAD	`fun HEAD(pattern: String, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` `fun HEAD(pattern: String, predicate: RequestPredicate, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` Adds a route to the given handler function that handles all HTTP `HEAD` requests that match the given pattern. `fun HEAD(pattern: String): RequestPredicate` Return a RequestPredicate that matches if request's HTTP method is `HEAD` and the given `pattern` matches against the request path.
headers	`fun headers(headersPredicate: (Headers) -> Boolean, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` Route to the given handler function if the given headers predicate applies. `fun headers(headersPredicate: (Headers) -> Boolean): RequestPredicate` Return a RequestPredicate that tests the request's headers against the given headers predicate.
invoke	`operator fun RequestPredicate.invoke(f: (ServerRequest) -> Mono<out ServerResponse>): Unit` Route to the given handler function if the given request predicate applies. `operator fun String.invoke(f: (ServerRequest) -> Mono<out ServerResponse>): Unit` Route to the given handler function if the given predicate (String processed as a path predicate) applies.
method	`fun method(httpMethod: HttpMethod, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` Route to the given handler function if the given method predicate applies. `fun method(httpMethod: HttpMethod): RequestPredicate` Return a RequestPredicate that tests against the given HTTP method.
nest	`fun RequestPredicate.nest(init: RouterFunctionDsl.() -> Unit): Unit` 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. `fun String.nest(init: RouterFunctionDsl.() -> Unit): Unit` 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.
noContent	`fun noContent(): HeadersBuilder<*>` Create a builder with a 204 No Content status.
not	`operator fun RequestPredicate.not(): RequestPredicate` Return a predicate that represents the logical negation of this predicate.
notFound	`fun notFound(): HeadersBuilder<*>` Create a builder with a 404 Not Found status.
ok	`fun ok(): BodyBuilder` Create a builder with the status set to 200 OK.
onError	`fun onError(predicate: (Throwable) -> Boolean, responseProvider: (Throwable, ServerRequest) -> Mono<ServerResponse>): Unit` `fun <E : Throwable> onError(responseProvider: (Throwable, ServerRequest) -> Mono<ServerResponse>): Unit` Filters all exceptions that match the predicate by applying the given response provider function.
OPTIONS	`fun OPTIONS(pattern: String, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` `fun OPTIONS(pattern: String, predicate: RequestPredicate, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` Adds a route to the given handler function that handles all HTTP `OPTIONS` requests that match the given pattern. `fun OPTIONS(pattern: String): RequestPredicate` Return a RequestPredicate that matches if request's HTTP method is `OPTIONS` and the given `pattern` matches against the request path.
or	`infix fun RequestPredicate.or(other: String): RequestPredicate` Return a composed request predicate that tests against both this predicate OR the other predicate (String processed as a path predicate). When evaluating the composed predicate, if this predicate is `true`, then the other predicate is not evaluated. `infix fun String.or(other: RequestPredicate): RequestPredicate` 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. `infix fun RequestPredicate.or(other: RequestPredicate): RequestPredicate` Return a composed request predicate that tests against both this predicate OR the other predicate. When evaluating the composed predicate, if this predicate is `true`, then the other predicate is not evaluated.
PATCH	`fun PATCH(pattern: String, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` `fun PATCH(pattern: String, predicate: RequestPredicate, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` Adds a route to the given handler function that handles all HTTP `PATCH` requests that match the given pattern and predicate. `fun PATCH(pattern: String): RequestPredicate` Return a RequestPredicate that matches if request's HTTP method is `PATCH` and the given `pattern` matches against the request path.
path	`fun path(pattern: String, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` Route to the given handler function if the given path predicate applies. `fun path(pattern: String): RequestPredicate` Return a RequestPredicate that tests the request path against the given path pattern.
pathExtension	`fun pathExtension(extension: String, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` `fun pathExtension(predicate: (String) -> Boolean, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` Route to the given handler function if the given pathExtension predicate applies. `fun pathExtension(extension: String): RequestPredicate` Return a RequestPredicate that matches if the request's path has the given extension. `fun pathExtension(predicate: (String) -> Boolean): RequestPredicate` Return a RequestPredicate that matches if the request's path matches the given predicate.
permanentRedirect	`fun permanentRedirect(location: URI): BodyBuilder` Create a builder with a 308 Permanent Redirect status and a location header set to the given URI.
POST	`fun POST(pattern: String, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` `fun POST(pattern: String, predicate: RequestPredicate, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` Adds a route to the given handler function that handles all HTTP `POST` requests that match the given pattern. `fun POST(pattern: String): RequestPredicate` Return a RequestPredicate that matches if request's HTTP method is `POST` and the given `pattern` matches against the request path.
PUT	`fun PUT(pattern: String, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` `fun PUT(pattern: String, predicate: RequestPredicate, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` Adds a route to the given handler function that handles all HTTP `PUT` requests that match the given pattern. `fun PUT(pattern: String): RequestPredicate` Return a RequestPredicate that matches if request's HTTP method is `PUT` and the given `pattern` matches against the request path.
queryParam	`fun queryParam(name: String, predicate: (String) -> Boolean, f: (ServerRequest) -> Mono<out ServerResponse>): Unit` Route to the given handler function if the given queryParam predicate applies. `fun queryParam(name: String, predicate: (String) -> Boolean): RequestPredicate` Return a RequestPredicate that tests the request's query parameter of the given name against the given predicate.
resources	`fun resources(path: String, location: Resource): Unit` Route requests that match the given pattern to resources relative to the given root location. `fun resources(lookupFunction: (ServerRequest) -> Mono<Resource>): Unit` 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.
seeOther	`fun seeOther(location: URI): BodyBuilder` Create a builder with a 303 See Other status and a location header set to the given URI.
status	`fun status(status: HttpStatus): BodyBuilder` `fun status(status: Int): BodyBuilder` Create a builder with the given HTTP status.
temporaryRedirect	`fun temporaryRedirect(location: URI): BodyBuilder` Create a builder with a 307 Temporary Redirect status and a location header set to the given URI.
unprocessableEntity	`fun unprocessableEntity(): BodyBuilder` Create a builder with an 422 Unprocessable Entity status.