data class Cookie(val name: String, val value: String, val encoding: CookieEncoding = CookieEncoding.URI_ENCODING, val maxAge: Int? = null, val expires: GMTDate? = null, val domain: String? = null, val path: String? = null, val secure: Boolean = false, val httpOnly: Boolean = false, val extensions: Map<String, String?> = emptyMap())

Represents a cookie with name, content and a set of settings such as expiration, visibility and security. A cookie with neither expires nor maxAge is a session cookie.

CookieEncoding

enum CookieEncoding : Enum<CookieEncoding>

Cooke encoding strategy

Headers

interface Headers : StringValues

Represents HTTP headers as a map from case-insensitive names to collection of String values

HeadersBuilder

class HeadersBuilder(size: Int = 8) : StringValuesBuilderImpl

HeadersImpl

class HeadersImpl(values: Map<String, List<String>> = emptyMap()) : StringValuesImpl, Headers

HeadersSingleImpl

class HeadersSingleImpl(name: String, values: List<String>) : StringValuesSingleImpl, Headers

HeaderValue

data class HeaderValue(val value: String, val params: List<HeaderValueParam> = emptyList())

Represents a header value. Similar to HeaderValueWithParameters

HeaderValueParam

data class HeaderValueParam(val name: String, val value: String, val escapeValue: Boolean)

Represents a single value parameter

HeaderValueWithParameters

abstract class HeaderValueWithParameters(content: String, val parameters: List<HeaderValueParam> = emptyList())

Represents a header value that consist of content followed by parameters. Useful for headers such as Content-Type, Content-Disposition and so on.

HttpHeaders

object HttpHeaders

HttpMessage

interface HttpMessage

A message either from the client or the server, that has headers associated.

HttpMessageBuilder

interface HttpMessageBuilder

A builder message either for the client or the server, that has a headers builder associated.

HttpMethod

data class HttpMethod(val value: String)

Represents an HTTP method (verb)

HttpProtocolVersion

data class HttpProtocolVersion(val name: String, val major: Int, val minor: Int)

Represents an HTTP protocol version.

HttpStatusCode

data class HttpStatusCode(val value: Int, val description: String) : Comparable<HttpStatusCode>

Represents an HTTP status code and description.

IllegalHeaderNameException

class IllegalHeaderNameException(val headerName: String, val position: Int) : IllegalArgumentException

Thrown when an illegal header name was used. A header name should only consist from visible characters without delimiters "double quote" and the following characters: (),/:;<=>?@[\]{}.

IllegalHeaderValueException

class IllegalHeaderValueException(val headerValue: String, val position: Int) : IllegalArgumentException

Thrown when an illegal header value was used. A header value should only consist from visible characters, spaces and/or HTAB (0x09).

LinkHeader

class LinkHeader(uri: String, params: List<HeaderValueParam>) : HeaderValueWithParameters

Represents a Link header value as per RFC 5988

Parameters

interface Parameters : StringValues

Represents HTTP parameters as a map from case-insensitive names to collection of String values

ParametersBuilder

interface ParametersBuilder : StringValuesBuilder

ParametersBuilderImpl

class ParametersBuilderImpl(size: Int = 8) : StringValuesBuilderImpl, ParametersBuilder

ParametersImpl

class ParametersImpl(values: Map<String, List<String>> = emptyMap()) : StringValuesImpl, Parameters

ParametersSingleImpl

class ParametersSingleImpl(name: String, values: List<String>) : StringValuesSingleImpl, Parameters

RangesSpecifier

data class RangesSpecifier(val unit: String = RangeUnits.Bytes.unitToken, val ranges: List<ContentRange>)

Range specifier for partial content requests (RFC 2616 sec 14.35.1)

RangeUnits

enum RangeUnits : Enum<RangeUnits>

Possible content range units: bytes and none

RequestConnectionPoint

interface RequestConnectionPoint

Represents request address information is used to make a call. There are at least two possible instances: "local" is how we see request at the server application and "actual" is what we can recover from proxy provided headers.

UnsafeHeaderException

class UnsafeHeaderException(header: String) : IllegalArgumentException

Thrown when an attempt to set unsafe header detected. A header is unsafe if listed in HttpHeaders.UnsafeHeadersList.

Url

class Url

Represents an immutable URL

URLBuilder

class URLBuilder(protocol: URLProtocol? = null, var host: String = "", port: Int = DEFAULT_PORT, user: String? = null, password: String? = null, pathSegments: List<String> = emptyList(), parameters: Parameters = Parameters.Empty, fragment: String = "", var trailingQuery: Boolean = false)

A URL builder with all mutable components

URLDecodeException

class URLDecodeException(message: String) : Exception

URL decoder exception

URLParserException

class URLParserException(urlString: String, cause: Throwable) : IllegalStateException

Thrown when failed to parse URL

URLProtocol

data class URLProtocol(val name: String, val defaultPort: Int)

Represents URL protocol

Properties

authority

val URLBuilder.authority: String

URLBuilder authority.

val Url.authority: String

Url authority.

DEFAULT_PORT

const val DEFAULT_PORT: Int = 0

Select default port value from protocol.

encodedPath

var URLBuilder.encodedPath: String

fullPath

val Url.fullPath: String

Full encoded path with query string but without domain, port and schema

hostWithPort

val Url.hostWithPort: String

Host:port pair, not normalized so port is always specified even if the port is schema's default

hostWithPortIfSpecified

val Url.hostWithPortIfSpecified: String

Returns "host:port" when port is specified. Else, returns host.

isAbsolutePath

val URLBuilder.isAbsolutePath: Boolean

val Url.isAbsolutePath: Boolean

Checks if Url has absolute path.

isRelativePath

val URLBuilder.isRelativePath: Boolean

val Url.isRelativePath: Boolean

Checks if Url has absolute path.

origin

expect val URLBuilder.Companion.origin: String

Hostname of current origin.

actual val URLBuilder.Companion.origin: String

Hostname of current origin.

actual val URLBuilder.Companion.origin: String

Hostname of current origin.

actual val URLBuilder.Companion.origin: String

Hostname of current origin.

protocolWithAuthority

val Url.protocolWithAuthority: String

A Url protocol and authority.

Functions

append

fun StringValuesBuilder.append(name: String, value: HeaderValueWithParameters)

Append formatted header value to the builder

appendEncodedPathSegments

fun URLBuilder.appendEncodedPathSegments(vararg components: String): URLBuilder

Adds components to current encodedPath

fun URLBuilder.appendEncodedPathSegments(segments: List<String>): URLBuilder

Adds segments to current encodedPath

appendPathSegments

fun URLBuilder.appendPathSegments(vararg components: String, encodeSlash: Boolean = false): URLBuilder

Adds components to current encodedPath

fun URLBuilder.appendPathSegments(segments: List<String>, encodeSlash: Boolean = false): URLBuilder

Adds segments to current encodedPath.

appendUrlFullPath

fun Appendable.appendUrlFullPath(encodedPath: String, encodedQueryParameters: ParametersBuilder, trailingQuery: Boolean)

buildUrl

fun buildUrl(block: URLBuilder.() -> Unit): Url

Construct a Url by applying block an empty UrlBuilder.

cacheControl

fun HttpMessage.cacheControl(): List<HeaderValue>

Parse CacheControl header.

charset

fun HeaderValueWithParameters.charset(): Charset?

Extracts a Charset value from the given Content-Type, Content-Disposition or similar header value.

fun HttpMessage.charset(): Charset?

fun HttpMessageBuilder.charset(): Charset?

Parse charset from Content-Type header value.

clone

fun URLBuilder.clone(): URLBuilder

Create a copy of this builder. Modifications in a copy is not reflected in the original instance and vise-versa.

contentLength

fun HttpMessage.contentLength(): Long?

fun HttpMessageBuilder.contentLength(): Long?

Parse Content-Length header value.

contentRangeHeaderValue

fun contentRangeHeaderValue(range: LongRange?, fullLength: Long? = null, unit: RangeUnits = RangeUnits.Bytes): String

fun contentRangeHeaderValue(range: LongRange?, fullLength: Long? = null, unit: String = RangeUnits.Bytes.unitToken): String

Format Content-Range header value

contentType

fun HttpMessage.contentType(): ContentType?

fun HttpMessageBuilder.contentType(): ContentType?

Parse Content-Type header value.

fun HttpMessageBuilder.contentType(type: ContentType)

Set Content-Type header.

fun HttpMessageBuilder.cookies(): List<Cookie>

Parse Set-Cookie header value.

date

fun HttpMessage.date(): Date?

Parse Date header.

decodeCookieValue

fun decodeCookieValue(encodedValue: String, encoding: CookieEncoding): String

Decode cookie value using the specified encoding

decodeURLPart

fun String.decodeURLPart(start: Int = 0, end: Int = length, charset: Charset = Charsets.UTF_8): String

Decode percent encoded URL part within the specified range [start, end). This function is not intended to decode urlencoded forms so it doesn't decode plus character to space.

decodeURLQueryComponent