rest_tools/com.hexagonkt.rest.tools/HttpClientTool

HttpClientTool

data class HttpClientTool( val adapter: HttpClientPort, val url: String? = null, val httpContentType: ContentType? = null, val httpAccept: List<ContentType> = emptyList(), val httpHeaders: Map<String, *> = emptyMap<String, Any>(), val sslSettings: SslSettings? = SslSettings(), val handler: HttpHandler? = serializeHandler, val authorization: Authorization? = null, val followRedirects: Boolean = false)

Constructors

HttpClientTool

constructor( adapter: HttpClientPort, url: String? = null, mediaType: MediaType, accept: List<MediaType> = emptyList(), headers: Map<String, *> = emptyMap<String, Any>(), sslSettings: SslSettings? = SslSettings(), handler: HttpHandler? = serializeHandler)

constructor( adapter: HttpClientPort, url: String? = null, httpContentType: ContentType? = null, httpAccept: List<ContentType> = emptyList(), httpHeaders: Map<String, *> = emptyMap<String, Any>(), sslSettings: SslSettings? = SslSettings(), handler: HttpHandler? = serializeHandler, authorization: Authorization? = null, followRedirects: Boolean = false)

Types

Companion

object Companion

Properties

adapter

val adapter: HttpClientPort

attributes

val attributes: Map<String, *>

authorization

val authorization: Authorization? = null

body

val body: Any

contentType

val contentType: ContentType?

val cookies: Map<String, Cookie>

followRedirects

val followRedirects: Boolean = false

handler

val handler: HttpHandler?

headers

val headers: Headers

httpAccept

val httpAccept: List<ContentType>

httpContentType

val httpContentType: ContentType? = null

httpHeaders

val httpHeaders: Map<String, *>

request

val request: HttpRequest

response

val response: HttpResponsePort

sslSettings

val sslSettings: SslSettings?

status

val status: HttpStatus

url

val url: String? = null

Functions

assertBody

fun assertBody(body: Any)

assertBodyContains

fun assertBodyContains(vararg texts: String)

assertContentType

fun assertContentType(mediaType: MediaType)

fun assertContentType(contentType: ContentType)

assertOk

fun assertOk()

assertStatus

fun assertStatus(status: HttpStatus)

fun assertStatus(statusType: HttpStatusType)

assertSuccess

fun assertSuccess()

delete

fun delete( path: Pair<String, Map<String, Any>>, body: Any = "", formParameters: List<FormParameter> = emptyList(), headers: Map<String, *> = emptyMap<String, Any>(), parts: List<HttpPart> = emptyList(), contentType: ContentType? = settings.contentType, accept: List<ContentType> = settings.accept): HttpResponsePort

fun delete( path: String = "/", body: Any = "", formParameters: List<FormParameter> = emptyList(), headers: Map<String, *> = emptyMap<String, Any>(), parts: List<HttpPart> = emptyList(), contentType: ContentType? = settings.contentType, accept: List<ContentType> = settings.accept): HttpResponsePort

get

fun get( path: Pair<String, Map<String, Any>>, body: Any = "", formParameters: List<FormParameter> = emptyList(), headers: Map<String, *> = emptyMap<String, Any>(), parts: List<HttpPart> = emptyList(), contentType: ContentType? = settings.contentType, accept: List<ContentType> = settings.accept): HttpResponsePort

fun get( path: String = "/", body: Any = "", formParameters: List<FormParameter> = emptyList(), headers: Map<String, *> = emptyMap<String, Any>(), parts: List<HttpPart> = emptyList(), contentType: ContentType? = settings.contentType, accept: List<ContentType> = settings.accept): HttpResponsePort

options

fun options( path: Pair<String, Map<String, Any>>, body: Any = "", formParameters: List<FormParameter> = emptyList(), headers: Map<String, *> = emptyMap<String, Any>(), parts: List<HttpPart> = emptyList(), contentType: ContentType? = settings.contentType, accept: List<ContentType> = settings.accept): HttpResponsePort

fun options( path: String = "/", body: Any = "", formParameters: List<FormParameter> = emptyList(), headers: Map<String, *> = emptyMap<String, Any>(), parts: List<HttpPart> = emptyList(), contentType: ContentType? = settings.contentType, accept: List<ContentType> = settings.accept): HttpResponsePort

patch

fun patch( path: Pair<String, Map<String, Any>>, body: Any = "", formParameters: List<FormParameter> = emptyList(), headers: Map<String, *> = emptyMap<String, Any>(), parts: List<HttpPart> = emptyList(), contentType: ContentType? = settings.contentType, accept: List<ContentType> = settings.accept): HttpResponsePort

fun patch( path: String = "/", body: Any = "", formParameters: List<FormParameter> = emptyList(), headers: Map<String, *> = emptyMap<String, Any>(), parts: List<HttpPart> = emptyList(), contentType: ContentType? = settings.contentType, accept: List<ContentType> = settings.accept): HttpResponsePort

post

fun post( path: Pair<String, Map<String, Any>>, body: Any = "", formParameters: List<FormParameter> = emptyList(), headers: Map<String, *> = emptyMap<String, Any>(), parts: List<HttpPart> = emptyList(), contentType: ContentType? = settings.contentType, accept: List<ContentType> = settings.accept): HttpResponsePort

fun post( path: Pair<String, Map<String, Any>>, formParameters: List<FormParameter> = emptyList(), headers: Map<String, *> = emptyMap<String, Any>(), parts: List<HttpPart> = emptyList(), contentType: ContentType? = settings.contentType, accept: List<ContentType> = settings.accept, body: () -> Any): HttpResponsePort

fun post( path: String = "/", body: Any = "", formParameters: List<FormParameter> = emptyList(), headers: Map<String, *> = emptyMap<String, Any>(), parts: List<HttpPart> = emptyList(), contentType: ContentType? = settings.contentType, accept: List<ContentType> = settings.accept): HttpResponsePort

fun post( path: String = "/", formParameters: List<FormParameter> = emptyList(), headers: Map<String, *> = emptyMap<String, Any>(), parts: List<HttpPart> = emptyList(), contentType: ContentType? = settings.contentType, accept: List<ContentType> = settings.accept, body: () -> Any): HttpResponsePort

put

fun put( path: Pair<String, Map<String, Any>>, formParameters: List<FormParameter> = emptyList(), parts: List<HttpPart> = emptyList(), contentType: ContentType? = settings.contentType, accept: List<ContentType> = settings.accept, body: () -> Any): HttpResponsePort

fun put( path: Pair<String, Map<String, Any>>, body: Any = "", formParameters: List<FormParameter> = emptyList(), headers: Map<String, *> = emptyMap<String, Any>(), parts: List<HttpPart> = emptyList(), contentType: ContentType? = settings.contentType, accept: List<ContentType> = settings.accept): HttpResponsePort

fun put( path: String = "/", body: Any = "", formParameters: List<FormParameter> = emptyList(), headers: Map<String, *> = emptyMap<String, Any>(), parts: List<HttpPart> = emptyList(), contentType: ContentType? = settings.contentType, accept: List<ContentType> = settings.accept): HttpResponsePort

fun put( path: String = "/", formParameters: List<FormParameter> = emptyList(), headers: Map<String, *> = emptyMap<String, Any>(), parts: List<HttpPart> = emptyList(), contentType: ContentType? = settings.contentType, accept: List<ContentType> = settings.accept, body: () -> Any): HttpResponsePort

request

fun request(block: HttpClientTool.() -> Unit)

start

fun start()

stop

fun stop()

trace

fun trace( path: Pair<String, Map<String, Any>>, body: Any = "", formParameters: List<FormParameter> = emptyList(), headers: Map<String, *> = emptyMap<String, Any>(), parts: List<HttpPart> = emptyList(), contentType: ContentType? = settings.contentType, accept: List<ContentType> = settings.accept): HttpResponsePort

fun trace( path: String = "/", body: Any = "", formParameters: List<FormParameter> = emptyList(), headers: Map<String, *> = emptyMap<String, Any>(), parts: List<HttpPart> = emptyList(), contentType: ContentType? = settings.contentType, accept: List<ContentType> = settings.accept): HttpResponsePort