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 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: 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 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(): ServerResponse.BodyBuilder

before

fun before(requestProcessor: (ServerRequest) -> ServerRequest)

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(vararg mediaTypes: MediaType): RequestPredicate

Return a RequestPredicate that tests if the request's content type is included by any of the given media types.

fun contentType(mediaType: MediaType, f: (ServerRequest) -> ServerResponse)

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

created

fun created(location: URI): ServerResponse.BodyBuilder

DELETE

fun DELETE(f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP DELETE requests.

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.

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

Adds a route to the given handler function that handles all HTTP DELETE requests that match the given pattern.

fun DELETE(predicate: RequestPredicate, f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP DELETE requests that match the given predicate.

fun DELETE(pattern: String, predicate: RequestPredicate, f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP DELETE requests that match the given pattern and predicate.

filter

fun filter(filterFunction: (ServerRequest, (ServerRequest) -> ServerResponse) -> ServerResponse)

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): ServerResponse.BodyBuilder

GET

fun GET(f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP GET requests.

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.

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

Adds a route to the given handler function that handles all HTTP GET requests that match the given pattern.

fun GET(predicate: RequestPredicate, f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP GET requests that match the given predicate.

fun GET(pattern: String, predicate: RequestPredicate, f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP GET requests that match the given pattern and predicate.

HEAD

fun HEAD(f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP HEAD requests.

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.

fun HEAD(pattern: String, f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP HEAD requests that match the given pattern.

fun HEAD(predicate: RequestPredicate, f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP HEAD requests that match the given predicate.

fun HEAD(pattern: String, predicate: RequestPredicate, f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP HEAD requests that match the given pattern and predicate.

headers

fun headers(headersPredicate: (ServerRequest.Headers) -> Boolean): RequestPredicate

Return a RequestPredicate that tests the request's headers against the given headers predicate.

fun headers(headersPredicate: (ServerRequest.Headers) -> Boolean, f: (ServerRequest) -> ServerResponse)

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

invoke

operator fun String.invoke(f: (ServerRequest) -> ServerResponse)

Route to the given handler function if the given predicate (String processed as a path predicate) applies.

operator fun RequestPredicate.invoke(f: (ServerRequest) -> ServerResponse)

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

method

fun method(httpMethod: HttpMethod): RequestPredicate

Return a RequestPredicate that tests against the given HTTP method.

fun method(httpMethod: HttpMethod, f: (ServerRequest) -> ServerResponse)

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

nest

fun String.nest(r: RouterFunctionDsl.() -> 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.

fun RequestPredicate.nest(r: RouterFunctionDsl.() -> 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.

noContent

fun noContent(): ServerResponse.HeadersBuilder<*>

not

operator fun RequestPredicate.not(): RequestPredicate

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

notFound

fun notFound(): ServerResponse.HeadersBuilder<*>

fun ok(): ServerResponse.BodyBuilder

onError

inline fun <E : Throwable> onError(noinline responseProvider: (Throwable, ServerRequest) -> ServerResponse)

fun onError(predicate: (Throwable) -> Boolean, responseProvider: (Throwable, ServerRequest) -> ServerResponse)

Filters all exceptions that match the predicate by applying the given response provider function.

OPTIONS

fun OPTIONS(f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP OPTIONS requests.

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.

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

Adds a route to the given handler function that handles all HTTP OPTIONS requests that match the given pattern.

fun OPTIONS(predicate: RequestPredicate, f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP OPTIONS requests that match the given predicate.

fun OPTIONS(pattern: String, predicate: RequestPredicate, f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP OPTIONS requests that match the given pattern and predicate.

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: 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 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.

param

fun param(name: String, predicate: (String) -> Boolean): RequestPredicate

Return a RequestPredicate that tests the request's query parameter of the given name against the given predicate.

fun param(name: String, predicate: (String) -> Boolean, f: (ServerRequest) -> ServerResponse)

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

PATCH

fun PATCH(f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP PATCH requests.

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.

fun PATCH(pattern: String, f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP PATCH requests that match the given pattern.

fun PATCH(predicate: RequestPredicate, f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP PATCH requests that match the given predicate.

fun PATCH(pattern: String, predicate: RequestPredicate, f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP PATCH requests that match the given pattern and predicate.

path

fun path(pattern: String): RequestPredicate

Return a RequestPredicate that tests the request path against the given path pattern.

fun path(pattern: String, f: (ServerRequest) -> ServerResponse)

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

pathExtension

fun pathExtension(predicate: (String) -> Boolean): RequestPredicate

Return a RequestPredicate that matches if the request's path matches the given predicate.

fun pathExtension(extension: String): RequestPredicate

Return a RequestPredicate that matches if the request's path has the given extension.

fun pathExtension(predicate: (String) -> Boolean, f: (ServerRequest) -> ServerResponse)

fun pathExtension(extension: String, f: (ServerRequest) -> ServerResponse)

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

permanentRedirect

fun permanentRedirect(location: URI): ServerResponse.BodyBuilder

POST

fun POST(f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP POST requests.

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.

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

Adds a route to the given handler function that handles all HTTP POST requests that match the given pattern.

fun POST(predicate: RequestPredicate, f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP POST requests that match the given predicate.

fun POST(pattern: String, predicate: RequestPredicate, f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP POST requests that match the given pattern and predicate.

PUT

fun PUT(f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP PUT requests.

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.

fun PUT(pattern: String, f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP PUT requests that match the given pattern.

fun PUT(predicate: RequestPredicate, f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP PUT requests that match the given predicate.

fun PUT(pattern: String, predicate: RequestPredicate, f: (ServerRequest) -> ServerResponse)

Adds a route to the given handler function that handles all HTTP PUT requests that match the given pattern and predicate.

resources

fun resources(lookupFunction: (ServerRequest) -> Resource?)

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.

fun resources(path: String, location: Resource)

Route requests that match the given pattern to resources relative to the given root location.

seeOther

fun seeOther(location: URI): ServerResponse.BodyBuilder

status

fun status(status: Int): ServerResponse.BodyBuilder

fun status(status: HttpStatusCode): ServerResponse.BodyBuilder

temporaryRedirect

fun temporaryRedirect(location: URI): ServerResponse.BodyBuilder

unprocessableEntity

fun unprocessableEntity(): ServerResponse.BodyBuilder

withAttribute

fun withAttribute(name: String, value: Any)

Add an attribute with the given name and value to the last route built with this builder.

withAttributes

fun withAttributes(attributesConsumer: (MutableMap<String, Any>) -> Unit)

Manipulate the attributes of the last route built with the given consumer.