http4k-core/org.http4k.core

Package-level declarations

Types

data class Accept(val contentTypes: List<QualifiedContent>)

See https://www.rfc-editor.org/rfc/rfc9110.html#name-accept

Body

interface Body : Closeable

If this Body is NOT being returned to the caller (via a Server implementation or otherwise), close() should be called.

BodyMode

sealed class BodyMode : Function1<InputStream, Body>

BodyMode represents a choice between working lazily with streams or eagerly storing the body contents in memory.

ContentEncodingName

@JvmInline

value class ContentEncodingName(val value: String)

See https://www.iana.org/assignments/http-parameters/http-parameters.xhtml#content-coding

ContentType

data class ContentType(val value: String, val directives: Parameters = emptyList())

Credentials

data class Credentials(val user: String, val password: String)

Exactly

data class Exactly<T>(val value: T) : SimpleRange<T>

Filter

fun interface Filter : Function1<HttpHandler, HttpHandler>

Headers

typealias Headers = Parameters

HttpHandler

typealias HttpHandler = (request: Request) -> Response

HttpMessage

interface HttpMessage : Closeable

HttpMessages are designed to be immutable, so any mutation methods return a modified copy of the message.

HttpTransaction

data class HttpTransaction(val request: Request, val response: Response, val duration: Duration, val labels: Map<String, String> = defaultLabels(request, response), val start: Instant) : ProtocolTransaction<Response>

MemoryBody

data class MemoryBody(val payload: ByteBuffer) : Body

Represents a body that is backed by an in-memory ByteBuffer. Closing this has no effect.

MemoryRequest

data class MemoryRequest(val method: Method, val uri: Uri, val headers: Headers = listOf(), val body: Body = EMPTY, val version: String = HTTP_1_1, val source: RequestSource? = null) : Request

MemoryResponse

data class MemoryResponse(val status: Status, val headers: Headers = listOf(), val body: Body = EMPTY, val version: String = HTTP_1_1) : Response

Method

enum Method : Enum<Method>

MimeTypes

class MimeTypes

Parameter

typealias Parameter = Pair<String, String?>

Parameters

typealias Parameters = List<Parameter>

PriorityList

data class PriorityList<T>(val ranges: List<Weighted<T>>)

A weighted list of content ranges of type T.

ProtocolTransaction

interface ProtocolTransaction<ProtocolResponse>

QualifiedContent

data class QualifiedContent(val content: ContentType, val priority: Double = 1.0)

Request

interface Request : HttpMessage

RequestContext

class ~~RequestContext~~(val id: UUID = UUID.randomUUID())

RequestContexts

class ~~RequestContexts~~(storeId: String? = null) : Store<RequestContext>

In-memory RequestContext store. Override the storeId to use multiple stores in one app.

RequestSource

data class RequestSource(val address: String, val port: Int? = 0, val scheme: String? = null)

Response

interface Response : HttpMessage

SimpleRange

sealed interface SimpleRange<in T>

A SimpleRange is either a value of some type, T, or a wildcard, represented in headers as "*", and matching any value of T. The value is constrained to being represented in HTTP headers by a single token, with no parameters.

Status

class Status : ProtocolStatus

Store

interface ~~Store~~<OUT> : LensInjector<OUT, Request> , LensExtractor<Request, OUT>

StreamBody

class StreamBody(val stream: InputStream, val length: Long? = null) : Body

Represents a body that is backed by a (lazy) InputStream. Operating with StreamBody has a number of potential gotchas:

Uri

data class Uri(val scheme: String, val userInfo: String, val host: String, val port: Int?, val path: String, val query: String, val fragment: String) : Comparable<Uri>

UriTemplate

data class UriTemplate

UriValue

typealias UriValue = AbstractValue<Uri>

Custom values4k extensions.

UriValueFactory