data class Call<T>(val url: String, val urlProvider: URLProvider<T>?, val concurrency: Int?, val rateOptions: RateLimitOptions?, val cookieJar: CookieJar?, val headers: Map<String, List<HeaderValue>>, val type: HttpMethod, val dataSupplier: RequestDataSupplier<T>?, val body: HttpBody<T>?, val onError: OnError?, val beforeHooks: List<BeforeHook>, val afterHooks: List<AfterHook>, val lifecycleController: LifecycleController? = null)

A build call, generally should not be built directly and should be built by using CallBuilder. This often happens automatically by using the runHttp block

CallBuilder

open class CallBuilder<T>(url: String = "")

CallDecorator

interface CallDecorator<T>

CallRunner

typealias CallRunner<T> = (Call<T>) -> Exception?

CookieJar

interface CookieJar : SimpleBeforeHook, SimpleAfterHook

DSLVisitorException

class DSLVisitorException(reason: String) : RuntimeException

EmptyBody

object EmptyBody : Body

Envelope

class Envelope<T>(message: T, maxRetries: Int = 3, expires: Instant?)

Failure

data class Failure<out E : Throwable>(val err: E) : HttpResult<Nothing, E>

Form

typealias Form = Map<String, List<String>>

FormPart

data class FormPart(val key: String, val value: FormTypes)

FormRequestBody

class FormRequestBody(val form: Map<String, List<String>>) : Body

FormTypes

sealed class FormTypes

FullDataAfterHook

interface FullDataAfterHook : AfterHook

HeaderValue

sealed class HeaderValue

HttpBody

data class HttpBody<T>(val bodyValue: String?, val bodyValueMapper: ValueMapper<String, T>?, val rawValue: (RequestData<T>) -> InputStream?, val formData: Map<String, List<String>>?, val formMapper: ValueMapper<Map<String, List<String>>, T>?, val multipartForm: List<FormPart>?, val lazyMultipartForm: RequestData<T>.() -> List<FormPart>?, val jsonObject: Any?, val lazyJsonObject: (RequestData<T>) -> Any?)

HttpMethod

enum HttpMethod : Enum<HttpMethod>

HttpRequest

class HttpRequest(val type: HttpMethod, val url: String, val body: Body)

HttpResponse

data class HttpResponse(var uri: URI, val statusCode: Int, val headers: Map<String, List<String>>, var body: ByteArray, val requestStartTime: Instant = Instant.now(), val responseStartTime: Instant = Instant.now(), val requestDuration: Duration = Duration.ZERO)

HttpResult

sealed class HttpResult<out T, out E>

JsonRequestBody

class JsonRequestBody(val data: Any) : Body

LifecycleController

interface LifecycleController

MultipartFormRequestBody

class MultipartFormRequestBody(val form: List<FormPart>) : Body

MustVisitor

typealias MustVisitor<T, V> = (V) -> T

NumberType

class NumberType(val i: Number) : FormTypes

OnError

interface OnError

OnErrorWithState

interface OnErrorWithState : OnError

OutputFormat

interface OutputFormat

ProvidedHeaderValue

data class ProvidedHeaderValue(val lambda: (RequestData<*>) -> String) : HeaderValue

RateLimitOptions

data class RateLimitOptions(val enabled: Boolean, val count: Int, val duration: Duration)

ReplaceableValue

interface ~~ReplaceableValue~~<T, V>

RequestData

abstract class RequestData<T>

RequestDataSupplier

interface RequestDataSupplier<T>

RequestVisitor

typealias RequestVisitor<T, V> = (V, Class<*>) -> T

ResolvedFullDataAfterHook

interface ResolvedFullDataAfterHook<T> : AfterHook

Used to reify request data into its real type without requiring visitor use. Can be used incorrectly without compilation warnings - use with care.

ResolvedSessionPersistingBeforeHook

interface ResolvedSessionPersistingBeforeHook<T> : BeforeHook

Session

data class Session(val calls: List<Call<*>>, val concurrency: Int = 100, val delay: Long?, val rateOptions: RateLimitOptions)

A session that may be passed to the DSL engine to run. Generally these sessions should be created by SessionBuilder through the use of the runHttp block. Explicit instantiation should be reserved for testing only.

SessionBuilder

class SessionBuilder

SessionManager

interface SessionManager

SessionPersistingBeforeHook

interface SessionPersistingBeforeHook : BeforeHook

SimpleAfterHook

interface SimpleAfterHook : AfterHook

SimpleBeforeHook

interface SimpleBeforeHook : BeforeHook

SkipBeforeHook

interface SkipBeforeHook : BeforeHook