kohttp

alltypes

open class BodyContext

BodyContext(type: String?)
fun bytes(content: ByteArray): RequestBody
fun file(content: File): RequestBody
fun form(content: String): RequestBody
fun form(init: Form.() -> Unit): RequestBody
fun json(content: String): RequestBody
fun json(init: Json.() -> Unit): RequestBody
fun string(content: String): RequestBody

interface ClientBuilder : ForkClientBuilder

abstract var authenticator: Authenticator
abstract var certificatePinner: CertificatePinner
abstract var connectionPool: ConnectionPool
abstract var connectionSpecs: List<ConnectionSpec>
abstract var cookieJar: CookieJar
abstract var dispatcher: Dispatcher
abstract var eventListenerFactory: Factory
abstract var hostnameVerifier: HostnameVerifier
abstract var protocols: List<Protocol>
abstract var proxy: Proxy?
abstract var proxyAuthenticator: Authenticator
abstract var proxySelector: ProxySelector
abstract var socketFactory: SocketFactory
abstract var sslSocketFactory: SSLSocketFactory

class CookieContext

CookieContext()
infix fun String.to(v: Any): Unit

data class EagerResponse

EagerResponse(request: Request, protocol: Protocol, code: Int, message: String, handshake: Handshake?, headers: List<Header>, body: String?, networkResponse: Response?, cacheResponse: Response?, priorResponse: Response?, sentRequestAtMillis: Long, receivedResponseAtMillis: Long)
val body: String?
val cacheResponse: Response?
val code: Int
val handshake: Handshake?
val headers: List<Header>
val message: String
val networkResponse: Response?
val priorResponse: Response?
val protocol: Protocol
val receivedResponseAtMillis: Long
val request: Request
val sentRequestAtMillis: Long

interface ForkClientBuilder

abstract var cache: Cache?
abstract var connectTimeout: Long
abstract var dns: Dns
abstract var followRedirects: Boolean
abstract var followSslRedirects: Boolean
abstract var interceptors: List<Interceptor>
open fun interceptors(block: InterceptorsDsl.() -> Unit): Unit
abstract var networkInterceptors: List<Interceptor>
abstract var pingInterval: Long
abstract var readTimeout: Long
abstract var retryOnConnectionFailure: Boolean
abstract var writeTimeout: Long

class Form

Form()
fun addEncoded(k: String, v: String): Unit
fun makeBody(): FormBody
infix fun String.to(v: Any): Unit

typealias FormDataPart = Triple<String, String?, RequestBody>
data class Header

Header(name: String, value: String)
val name: String
val value: String

class HeaderContext

HeaderContext()
fun cookie(init: CookieContext.() -> Unit): Unit
infix fun String.to(v: Any): Unit

sealed class HttpContext : IHttpContext

open fun header(init: HeaderContext.() -> Unit): Unit
var host: String
open fun makeBody(): RequestBody
open fun makeHeaders(): Builder
open fun makeRequest(): Request
open fun makeUrl(): Builder
open fun param(init: ParamContext.() -> Unit): Unit
var path: String?
var port: Int?
var scheme: String

class HttpDeleteContext : HttpPostContext

HttpDeleteContext()

@DslMarker annotation class HttpDslMarker

HttpDslMarker()

class HttpGetContext : HttpContext

HttpGetContext()

class HttpHeadContext : HttpContext

HttpHeadContext()

class HttpPatchContext : HttpPostContext

HttpPatchContext()

open class HttpPostContext : HttpContext

HttpPostContext(method: Method = POST)
fun body(contentType: String? = null, init: BodyContext.() -> RequestBody): Unit
open fun makeBody(): RequestBody
fun multipartBody(contentType: String? = null, init: MultipartBodyContext.() -> Unit): Unit

class HttpPutContext : HttpPostContext

HttpPutContext()

class InterceptorsDsl

InterceptorsDsl(interceptors: MutableList<Interceptor> = mutableListOf())
fun list(): List<Interceptor>
operator fun Interceptor.unaryPlus(): Unit

class Json

Json()
fun json(init: Json.() -> Unit): Json
infix fun String.to(obj: List<*>): Unit
infix fun String.to(str: String?): Unit
infix fun String.to(num: Number?): Unit
infix fun String.to(json: Json?): Unit
infix fun String.to(bool: Boolean?): Unit
fun toString(): String

class LoggingInterceptor : Interceptor

LoggingInterceptor(log: (String) -> Unit = ::println)
fun intercept(chain: Chain): Response

enum class Method

DELETE
GET
HEAD
PATCH
POST
PUT

class MultipartBodyContext

MultipartBodyContext(type: String?)
fun build(): MultipartBody
fun form(name: String, file: File): FormDataPart
fun form(name: String, filename: String, content: ByteArray): FormDataPart
operator fun FormDataPart.unaryPlus(): Unit

class ParamContext

ParamContext()
infix fun String.to(v: Any?): Unit

class RetryInterceptor : Interceptor

RetryInterceptor(failureThreshold: Int = 3, invocationTimeout: Long = 0, ratio: Int = 1, errorStatuses: List<Int> = listOf(503, 504))
fun intercept(chain: Chain): Response

class SigningInterceptor : Interceptor

SigningInterceptor(parameterName: String, signer: HttpUrl.() -> String)
fun intercept(chain: Chain): Response

class UploadContext : IHttpContext

UploadContext(context: HttpPostContext = HttpPostContext())
fun bytes(filename: String, content: ByteArray): Unit
fun file(content: File): Unit
fun file(content: URI): Unit
fun url(url: URL): Unit
fun url(url: String): Unit

java.io.File

fun File.upload(destination: URL): Response
fun File.upload(destination: String): Response
fun File.uploadAsync(destination: URL): Deferred<Response>
fun File.uploadAsync(destination: String): Deferred<Response>

java.net.URI

fun URI.upload(destination: URL): Response
fun URI.upload(destination: String): Response
fun URI.uploadAsync(destination: URL): Deferred<Response>
fun URI.uploadAsync(destination: String): Deferred<Response>

kotlin.String

fun String.asyncHttpGet(client: Factory = defaultHttpClient): Deferred<Response>
fun String.httpGet(client: Factory = defaultHttpClient): Response
fun String.httpGetAsync(client: Factory = defaultHttpClient): Deferred<Response>

okhttp3.Headers

fun Headers.asSequence(): Sequence<Header>

okhttp3.OkHttpClient

fun OkHttpClient.fork(block: ForkClientBuilder.() -> Unit): OkHttpClient

okhttp3.Response

fun Response.asJson(): JsonNode
fun Response.asStream(): InputStream?
fun Response.asString(): String?
fun Response.eager(): EagerResponse

package io.github.rybalkinsd.kohttp.client

interface ClientBuilder : ForkClientBuilder

abstract var authenticator: Authenticator
abstract var certificatePinner: CertificatePinner
abstract var connectionPool: ConnectionPool
abstract var connectionSpecs: List<ConnectionSpec>
abstract var cookieJar: CookieJar
abstract var dispatcher: Dispatcher
abstract var eventListenerFactory: Factory
abstract var hostnameVerifier: HostnameVerifier
abstract var protocols: List<Protocol>
abstract var proxy: Proxy?
abstract var proxyAuthenticator: Authenticator
abstract var proxySelector: ProxySelector
abstract var socketFactory: SocketFactory
abstract var sslSocketFactory: SSLSocketFactory

interface ForkClientBuilder

abstract var cache: Cache?
abstract var connectTimeout: Long
abstract var dns: Dns
abstract var followRedirects: Boolean
abstract var followSslRedirects: Boolean
abstract var interceptors: List<Interceptor>
open fun interceptors(block: InterceptorsDsl.() -> Unit): Unit
abstract var networkInterceptors: List<Interceptor>
abstract var pingInterval: Long
abstract var readTimeout: Long
abstract var retryOnConnectionFailure: Boolean
abstract var writeTimeout: Long

fun client(block: ClientBuilder.() -> Unit): OkHttpClient
val defaultHttpClient: OkHttpClient
okhttp3.OkHttpClient

fun OkHttpClient.fork(block: ForkClientBuilder.() -> Unit): OkHttpClient

package io.github.rybalkinsd.kohttp.client.dsl

class InterceptorsDsl

InterceptorsDsl(interceptors: MutableList<Interceptor> = mutableListOf())
fun list(): List<Interceptor>
operator fun Interceptor.unaryPlus(): Unit

package io.github.rybalkinsd.kohttp.configuration

const val DEFAULT_REQUEST_AMOUNT: Int

package io.github.rybalkinsd.kohttp.dsl

fun httpDelete(client: Factory = defaultHttpClient, init: HttpDeleteContext.() -> Unit): Response
fun httpGet(client: Factory = defaultHttpClient, init: HttpGetContext.() -> Unit): Response
fun httpHead(client: Factory = defaultHttpClient, init: HttpHeadContext.() -> Unit): Response
fun httpPatch(client: Factory = defaultHttpClient, init: HttpPatchContext.() -> Unit): Response
fun httpPost(client: Factory = defaultHttpClient, init: HttpPostContext.() -> Unit): Response
fun httpPut(client: Factory = defaultHttpClient, init: HttpPutContext.() -> Unit): Response
fun upload(client: Factory = defaultHttpClient, init: UploadContext.() -> Unit): Response

package io.github.rybalkinsd.kohttp.dsl.async

fun asyncHttpGet(client: Factory = defaultHttpClient, init: HttpGetContext.() -> Unit): Deferred<Response>
fun httpDeleteAsync(client: Factory = defaultHttpClient, init: HttpDeleteContext.() -> Unit): Deferred<Response>
fun httpGetAsync(client: Factory = defaultHttpClient, init: HttpGetContext.() -> Unit): Deferred<Response>
fun httpHeadAsync(client: Factory = defaultHttpClient, init: HttpHeadContext.() -> Unit): Deferred<Response>
fun httpPatchAsync(client: Factory = defaultHttpClient, init: HttpPatchContext.() -> Unit): Deferred<Response>
fun httpPostAsync(client: Factory = defaultHttpClient, init: HttpPostContext.() -> Unit): Deferred<Response>
fun httpPutAsync(client: Factory = defaultHttpClient, init: HttpPutContext.() -> Unit): Deferred<Response>
fun uploadAsync(client: Factory = defaultHttpClient, init: UploadContext.() -> Unit): Deferred<Response>

package io.github.rybalkinsd.kohttp.dsl.context

open class BodyContext

BodyContext(type: String?)
fun bytes(content: ByteArray): RequestBody
fun file(content: File): RequestBody
fun form(content: String): RequestBody
fun form(init: Form.() -> Unit): RequestBody
fun json(content: String): RequestBody
fun json(init: Json.() -> Unit): RequestBody
fun string(content: String): RequestBody

class CookieContext

CookieContext()
infix fun String.to(v: Any): Unit

typealias FormDataPart = Triple<String, String?, RequestBody>
class HeaderContext

HeaderContext()
fun cookie(init: CookieContext.() -> Unit): Unit
infix fun String.to(v: Any): Unit

sealed class HttpContext : IHttpContext

open fun header(init: HeaderContext.() -> Unit): Unit
var host: String
open fun makeBody(): RequestBody
open fun makeHeaders(): Builder
open fun makeRequest(): Request
open fun makeUrl(): Builder
open fun param(init: ParamContext.() -> Unit): Unit
var path: String?
var port: Int?
var scheme: String

class HttpDeleteContext : HttpPostContext

HttpDeleteContext()

@DslMarker annotation class HttpDslMarker

HttpDslMarker()

class HttpGetContext : HttpContext

HttpGetContext()

class HttpHeadContext : HttpContext

HttpHeadContext()

class HttpPatchContext : HttpPostContext

HttpPatchContext()

open class HttpPostContext : HttpContext

HttpPostContext(method: Method = POST)
fun body(contentType: String? = null, init: BodyContext.() -> RequestBody): Unit
open fun makeBody(): RequestBody
fun multipartBody(contentType: String? = null, init: MultipartBodyContext.() -> Unit): Unit

class HttpPutContext : HttpPostContext

HttpPutContext()

enum class Method

DELETE
GET
HEAD
PATCH
POST
PUT

class MultipartBodyContext

MultipartBodyContext(type: String?)
fun build(): MultipartBody
fun form(name: String, file: File): FormDataPart
fun form(name: String, filename: String, content: ByteArray): FormDataPart
operator fun FormDataPart.unaryPlus(): Unit

class ParamContext

ParamContext()
infix fun String.to(v: Any?): Unit

class UploadContext : IHttpContext

UploadContext(context: HttpPostContext = HttpPostContext())
fun bytes(filename: String, content: ByteArray): Unit
fun file(content: File): Unit
fun file(content: URI): Unit
fun url(url: URL): Unit
fun url(url: String): Unit

package io.github.rybalkinsd.kohttp.ext

data class EagerResponse

EagerResponse(request: Request, protocol: Protocol, code: Int, message: String, handshake: Handshake?, headers: List<Header>, body: String?, networkResponse: Response?, cacheResponse: Response?, priorResponse: Response?, sentRequestAtMillis: Long, receivedResponseAtMillis: Long)
val body: String?
val cacheResponse: Response?
val code: Int
val handshake: Handshake?
val headers: List<Header>
val message: String
val networkResponse: Response?
val priorResponse: Response?
val protocol: Protocol
val receivedResponseAtMillis: Long
val request: Request
val sentRequestAtMillis: Long

data class Header

Header(name: String, value: String)
val name: String
val value: String

java.io.File

fun File.upload(destination: URL): Response
fun File.upload(destination: String): Response
fun File.uploadAsync(destination: URL): Deferred<Response>
fun File.uploadAsync(destination: String): Deferred<Response>

java.net.URI

fun URI.upload(destination: URL): Response
fun URI.upload(destination: String): Response
fun URI.uploadAsync(destination: URL): Deferred<Response>
fun URI.uploadAsync(destination: String): Deferred<Response>

kotlin.String

fun String.asyncHttpGet(client: Factory = defaultHttpClient): Deferred<Response>
fun String.httpGet(client: Factory = defaultHttpClient): Response
fun String.httpGetAsync(client: Factory = defaultHttpClient): Deferred<Response>

okhttp3.Headers

fun Headers.asSequence(): Sequence<Header>

okhttp3.Response

fun Response.asJson(): JsonNode
fun Response.asStream(): InputStream?
fun Response.asString(): String?
fun Response.eager(): EagerResponse

fun HttpContext.url(url: URL): Unit
fun HttpContext.url(url: String): Unit

package io.github.rybalkinsd.kohttp.interceptors

class LoggingInterceptor : Interceptor

LoggingInterceptor(log: (String) -> Unit = ::println)
fun intercept(chain: Chain): Response

class RetryInterceptor : Interceptor

RetryInterceptor(failureThreshold: Int = 3, invocationTimeout: Long = 0, ratio: Int = 1, errorStatuses: List<Int> = listOf(503, 504))
fun intercept(chain: Chain): Response

class SigningInterceptor : Interceptor

SigningInterceptor(parameterName: String, signer: HttpUrl.() -> String)
fun intercept(chain: Chain): Response

package io.github.rybalkinsd.kohttp.util

class Form

Form()
fun addEncoded(k: String, v: String): Unit
fun makeBody(): FormBody
infix fun String.to(v: Any): Unit

class Json

Json()
fun json(init: Json.() -> Unit): Json
infix fun String.to(obj: List<*>): Unit
infix fun String.to(str: String?): Unit
infix fun String.to(num: Number?): Unit
infix fun String.to(json: Json?): Unit
infix fun String.to(bool: Boolean?): Unit
fun toString(): String

fun json(init: Json.() -> Unit): String