http/com.hexagonkt.http.model

Package-level declarations

TODO

Types

data class Authorization(val type: String, val value: String)

data class ContentType(val mediaType: MediaType, val boundary: String? = null, val charset: Charset? = null, val q: Double? = null)

data class Cookie(val name: String, val value: String, val maxAge: Long = -1, val secure: Boolean = false, val path: String = "/", val httpOnly: Boolean = true, val domain: String = "", val sameSite: Boolean = true, val expires: Instant? = null)

FormParameter

data class FormParameter(val name: String, val values: List<String>) : HttpField

FormParameters

data class FormParameters(val httpFields: Map<String, FormParameter>) : Map<String, FormParameter>

Header

data class Header(val name: String, val values: List<String>) : HttpField

Headers

data class Headers(val httpFields: Map<String, Header>) : Map<String, Header>

HttpBase

interface HttpBase

HttpCall

data class HttpCall(val request: HttpRequestPort = HttpRequest(), val response: HttpResponsePort = HttpResponse())

HttpField

interface HttpField

HTTP multi-value field. Used in headers, query parameters and form parameters.

HttpMessage

interface HttpMessage : HttpBase

HttpMethod

enum HttpMethod : Enum<HttpMethod>

Supported HTTP methods.

HttpPart

data class HttpPart(val name: String, val body: Any, val headers: Headers = Headers(), val contentType: ContentType? = null, val size: Long = -1L, val submittedFileName: String? = null) : HttpBase

HttpProtocol

enum HttpProtocol : Enum<HttpProtocol>

Supported HTTP protocols.

HttpRequest

data class HttpRequest(val method: HttpMethod = GET, val protocol: HttpProtocol = HTTP, val host: String = "localhost", val port: Int = 80, val path: String = "", val queryParameters: QueryParameters = QueryParameters(), val headers: Headers = Headers(), val body: Any = "", val parts: List<HttpPart> = emptyList(), val formParameters: FormParameters = FormParameters(), val cookies: List<Cookie> = emptyList(), val contentType: ContentType? = null, val certificateChain: List<X509Certificate> = emptyList(), val accept: List<ContentType> = emptyList(), val contentLength: Long = -1L, val authorization: Authorization? = null) : HttpRequestPort

HttpRequestPort

interface HttpRequestPort : HttpMessage

HttpResponse

data class HttpResponse(val body: Any = "", val headers: Headers = Headers(), val contentType: ContentType? = null, val cookies: List<Cookie> = emptyList(), val status: HttpStatus = NOT_FOUND_404, val contentLength: Long = -1L, val onConnect: WsSession.() -> Unit = {}, val onBinary: WsSession.(data: ByteArray) -> Unit = {}, val onText: WsSession.(text: String) -> Unit = {}, val onPing: WsSession.(data: ByteArray) -> Unit = {}, val onPong: WsSession.(data: ByteArray) -> Unit = {}, val onClose: WsSession.(status: Int, reason: String) -> Unit = { _, _ -> }) : HttpResponsePort

HttpResponsePort

interface HttpResponsePort : HttpMessage

HttpStatus

data class HttpStatus(val code: Int, val type: HttpStatusType = when (code) { in 100..199 -> INFORMATION in 200..299 -> SUCCESS in 300..399 -> REDIRECTION in 400..499 -> CLIENT_ERROR in 500..599 -> SERVER_ERROR else -> throw IllegalArgumentException(INVALID_CODE_ERROR_MESSAGE + code) })

HttpStatusType

enum HttpStatusType : Enum<HttpStatusType>

QueryParameter