http4k-core/org.http4k.routing/RoutingHttpHandler

RoutingHttpHandler

interface RoutingHttpHandler : Router, Function1<request: Request, Response>

Composite HttpHandler which can potentially service many different URL patterns. Should return a 404 Response if it cannot service a particular Request.

Note that generally there should be no reason for the API user to implement this interface over and above the implementations that already exist. The interface is public only because we have not found a way to hide it from the API user in an API-consistent manner.

Inheritors

StaticRoutingHttpHandler

Properties

open val description: RouterDescription

Functions

fun Events.and(next: Events): Events

infix fun Router.and(that: Router): Router

fun (Request) -> Boolean.asRouter(description: String = unavailable.description): Router

Convert any predicate on a request into a router

fun HttpHandler.asServer(config: ServerConfig): Http4kServer

fun HttpHandler.asServlet(): HttpHandlerServlet

fun HttpHandler.asServlet(): HttpHandlerServlet

infix fun Router.bind(handler: HttpHandler): RoutingHttpHandler

infix fun Router.bind(handler: RoutingHttpHandler): RoutingHttpHandler

fun HttpHandler.debug(out: PrintStream = System.out, debugStream: Boolean = false): (request: Request) -> Response

fun RoutingHttpHandler.debug(out: PrintStream = System.out, debugStream: Boolean = false): RoutingHttpHandler

abstract operator fun invoke(request: request: Request): Response

abstract fun match(request: Request): RouterMatch

Attempt to supply an HttpHandler which can service the passed request.

fun Events.~~then~~(next: Events): (Event) -> Unit

fun HttpHandler.withAsyncApi(): AsyncHttpHandler

Convert a synchronous HttpHandler API to mimic AsyncHttpClient

abstract override fun withBasePath(new: String): RoutingHttpHandler

Returns a Router which prepends the passed base path to the logic determining the match().

abstract override fun withFilter(new: Filter): RoutingHttpHandler

Returns a Router which applies the passed Filter to all received requests before servicing them.