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

CoRouterFunctionDsl

class 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

Constructors

<init>

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

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

Functions

accept

fun accept(mediaType: MediaType, f: suspend (ServerRequest) -> ServerResponse): Unit

Route to the given handler function if the given accept predicate applies.

fun accept(vararg mediaType: 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!

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!

contentType

fun contentType(mediaType: MediaType, f: suspend (ServerRequest) -> 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!

DELETE

fun DELETE(pattern: String, f: suspend (ServerRequest) -> ServerResponse): Unit

Route to the given handler function if the given DELETE predicate applies.

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.

from

fun from(other: ServerResponse): BodyBuilder!

GET

fun GET(pattern: String, f: suspend (ServerRequest) -> ServerResponse): Unit

Route to the given handler function if the given request predicate applies.

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: suspend (ServerRequest) -> ServerResponse): Unit

Route to the given handler function if the given request predicate applies.

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: suspend (ServerRequest) -> 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: suspend (ServerRequest) -> ServerResponse): Unit

Route to the given handler function if the given request predicate applies.

operator fun String.invoke(f: suspend (ServerRequest) -> 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: suspend (ServerRequest) -> 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(r: CoRouterFunctionDsl.() -> 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(r: CoRouterFunctionDsl.() -> 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<*>!

not

operator fun RequestPredicate.not(): RequestPredicate

Return a predicate that represents the logical negation of this predicate.

notFound

fun notFound(): HeadersBuilder<*>!

ok

fun ok(): BodyBuilder!

OPTIONS

fun OPTIONS(pattern: String, f: suspend (ServerRequest) -> ServerResponse): Unit

Route to the given handler function if the given OPTIONS predicate applies.

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: suspend (ServerRequest) -> ServerResponse): Unit

Route to the given handler function if the given PATCH predicate applies.

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: suspend (ServerRequest) -> 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: suspend (ServerRequest) -> ServerResponse): Unit
fun pathExtension(predicate: (String) -> Boolean, f: suspend (ServerRequest) -> 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!

POST

fun POST(pattern: String, f: suspend (ServerRequest) -> ServerResponse): Unit

Route to the given handler function if the given POST predicate applies.

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: suspend (ServerRequest) -> ServerResponse): Unit

Route to the given handler function if the given PUT predicate applies.

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: suspend (ServerRequest) -> 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: suspend (ServerRequest) -> 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!

status

fun status(status: HttpStatus): BodyBuilder!
fun status(status: Int): BodyBuilder!

temporaryRedirect

fun temporaryRedirect(location: URI): BodyBuilder!

unprocessableEntity

fun unprocessableEntity(): BodyBuilder!