http4k-core/org.http4k.routing

Package-level declarations

Types

PathMethod

class PathMethod(path: String, method: Method)

RequestWithRoute

interface RequestWithRoute : Request

ResourceLoader

fun interface ResourceLoader

Looks up contents of a resource path.

ResponseWithRoute

interface ResponseWithRoute : Response

RoutedRequest

data class RoutedRequest(delegate: Request, val xUriTemplate: UriTemplate) : Request, RequestWithRoute

RoutedResponse

class RoutedResponse(delegate: Response, val xUriTemplate: UriTemplate) : Response, ResponseWithRoute

Router

interface Router

Matches requests for routing purposes.

RouterDescription

data class RouterDescription(val description: String, val children: List<RouterDescription> = listOf())

RouterMatch

sealed class RouterMatch : Comparable<RouterMatch>

The result of a matching operation. May or may not contain a matched HttpHandler.

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.

StaticRoutingHttpHandler

data class StaticRoutingHttpHandler(pathSegments: String, resourceLoader: ResourceLoader, extraFileExtensionToContentTypes: Map<String, ContentType>, filter: Filter = Filter.NoOp) : RoutingHttpHandler

Properties

Fallback

val Fallback: Router

Functions

and

fun Method.and(that: Router): Router

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

asRouter

fun Method.asRouter(): Router

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

Convert any predicate on a request into a router

bind

infix fun String.bind(action: HttpHandler): RoutingHttpHandler

infix fun String.bind(method: Method): PathMethod

infix fun String.bind(httpHandler: RoutingHttpHandler): RoutingHttpHandler

infix fun Method.bind(httpHandler: HttpHandler): RoutingHttpHandler

infix fun Method.bind(routingHandler: RoutingHttpHandler): RoutingHttpHandler

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

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

body

@JvmName(name = "bodyMatches")

fun body(fn: (String) -> Boolean): Router

Ensure body string matches predicate

fun body(fn: (Body) -> Boolean): Router

Ensure body matches predicate

friendlyToString

fun RouterDescription.friendlyToString(indent: Int = 0): String

header

fun header(name: String, fn: (String) -> Boolean): Router

fun header(name: String, value: String): Router

Apply routing predicate to a header

headers

fun headers(vararg names: String): Router

Ensure all headers are present

path

fun Request.path(name: String): String?

queries

fun queries(vararg names: String): Router

Ensure all queries are present

query

fun query(name: String, fn: (String) -> Boolean): Router

fun query(name: String, value: String): Router

Apply routing predicate to a query

reverseProxy

fun reverseProxy(vararg hostToHandler: Pair<String, HttpHandler>): HttpHandler

Simple Reverse Proxy which will split and direct traffic to the appropriate HttpHandler based on the content of the Host header

reverseProxyRouting

fun reverseProxyRouting(vararg hostToHandler: Pair<String, HttpHandler>): RoutingHttpHandler

Simple Reverse Proxy. Exposes routing.

routes

fun routes(vararg list: Pair<Method, HttpHandler>): RoutingHttpHandler

fun routes(vararg list: RoutingHttpHandler): RoutingHttpHandler

fun routes(routers: List<RoutingHttpHandler>): RoutingHttpHandler

singlePageApp

fun singlePageApp(resourceLoader: ResourceLoader = ResourceLoader.Classpath("/public"), vararg extraFileExtensionToContentTypes: Pair<String, ContentType>): RoutingHttpHandler

For SPAs we serve static content as usual, or fall back to the index page. The resource loader is configured to look at /public package (on the Classpath).

static

fun static(resourceLoader: ResourceLoader = Classpath(), vararg extraFileExtensionToContentTypes: Pair<String, ContentType>): RoutingHttpHandler

Serve static content using the passed ResourceLoader. Note that for security, by default ONLY mime-types registered in mime.types (resource file) will be served. All other types are registered as application/octet-stream and are not served.

webJars

fun webJars(): RoutingHttpHandler

Serve WebJar contents from the classpath. Just install the dependencies and add this line to your routes().