http_handlers/com.hexagontk.http.handlers

Package-level declarations

This package defines server interfaces for HTTP server adapters.

Types

class AfterHandler(val handlerPredicate: HttpPredicate = HttpPredicate(), val block: HttpCallbackType) : HttpHandler, Handler<HttpCall>

BeforeHandler

class BeforeHandler(val handlerPredicate: HttpPredicate = HttpPredicate(), val block: HttpCallbackType) : HttpHandler, Handler<HttpCall>

ExceptionHandler

class ExceptionHandler<E : Exception>(val exception: KClass<E>, val block: HttpExceptionCallbackType<E>) : HttpHandler, Handler<HttpCall>

FilterHandler

class FilterHandler(val handlerPredicate: HttpPredicate = HttpPredicate(), val block: HttpCallbackType) : HttpHandler, Handler<HttpCall>

HandlerBuilder

class HandlerBuilder(var handlers: List<HttpHandler> = emptyList())

HttpCallback

interface HttpCallback : Function1<HttpContext, HttpContext>

HttpCallbackType

typealias HttpCallbackType = HttpContext.() -> HttpContext

HttpContext

class HttpContext(var event: HttpCall, var predicate: (Context<HttpCall>) -> Boolean, var nextHandlers: Array<Handler<HttpCall>> = emptyArray(), var nextHandler: Int = 0, var exception: Exception? = null, var attributes: Map<*, *> = emptyMap<Any, Any>(), var handled: Boolean = false) : Context<HttpCall>

HttpController

interface HttpController : HttpHandler

Utility to encapsulate a handler in a class. TODO

HttpExceptionCallback

interface HttpExceptionCallback<T> : Function2<HttpContext, T, HttpContext>

HttpExceptionCallbackType

typealias HttpExceptionCallbackType<T> = HttpContext.(T) -> HttpContext

HttpHandler

interface HttpHandler : Handler<HttpCall>

HttpPredicate

class HttpPredicate(val methods: Set<HttpMethod> = emptySet(), val pathPattern: PathPattern = LiteralPathPattern(), val status: Int? = null) : Function1<Context<HttpCall>, Boolean>

OnHandler

class OnHandler(val handlerPredicate: HttpPredicate = HttpPredicate(), val block: HttpCallbackType) : HttpHandler, Handler<HttpCall>

PathHandler

class PathHandler(val handlerPredicate: HttpPredicate, val handlers: List<HttpHandler>) : HttpHandler, Handler<HttpCall>

Functions

bodyToBytes

fun bodyToBytes(body: Any): ByteArray

Convert an object to a byte array. If the body class is not supported, it throws a runtime exception. IMPORTANT: Must be enclosed on a try/catch block to check runtime errors.

Delete

fun Delete(pattern: String = "", callback: HttpCallbackType): OnHandler

Get

fun Get(pattern: String = "", callback: HttpCallbackType): OnHandler

Head

fun Head(pattern: String = "", callback: HttpCallbackType): OnHandler

Options

fun Options(pattern: String = "", callback: HttpCallbackType): OnHandler

Patch

fun Patch(pattern: String = "", callback: HttpCallbackType): OnHandler

path

fun path(pattern: String = "", block: HandlerBuilder.() -> Unit): PathHandler

fun path(contextPath: String = "", handlers: List<HttpHandler>): PathHandler

Post

fun Post(pattern: String = "", callback: HttpCallbackType): OnHandler

process

fun HttpCallbackType.process(request: HttpRequest, attributes: Map<*, *> = emptyMap<Any, Any>()): HttpContext

fun HttpCallbackType.process(method: HttpMethod = GET, protocol: HttpProtocol = HTTP, host: String = "localhost", port: Int = 80, path: String = "", queryParameters: Parameters = Parameters(), headers: Headers = Headers(), body: Any = "", parts: List<HttpPart> = emptyList(), formParameters: Parameters = Parameters(), cookies: List<Cookie> = emptyList(), contentType: ContentType? = null, certificateChain: List<X509Certificate> = emptyList(), accept: List<ContentType> = emptyList(), contentLength: Long = -1L, attributes: Map<*, *> = emptyMap<Any, Any>(), authorization: Authorization? = null): HttpContext

Put

fun Put(pattern: String = "", callback: HttpCallbackType): OnHandler

Trace

fun Trace(pattern: String = "", callback: HttpCallbackType): OnHandler

fun Ws(pattern: String = "", callback: HttpCallbackType): OnHandler