NSL Netclient/xyz.noisif.nsl.netclient.rest.spec/GenericRequestSpec

GenericRequestSpec

abstract class GenericRequestSpec : RequestSpec, RequestView

Inheritors

Constructors

protected constructor(clientRegistry: ClientRegistry<RestClientGroupConfig>, url: String, method: HttpMethod, serializerRegistry: SerializerRegistry<MessageSerializer>)

Properties

abortedResponse

protected open var abortedResponse: RestResponse<out Any>

body

protected open var body: Any

clientGroup

protected open var clientGroup: ClientGroup

clientRegistry

protected val clientRegistry: ClientRegistry<RestClientGroupConfig>

formParams

protected val formParams: Map<String, String>

headers

protected val headers: Map<String, String>

interceptors

protected val interceptors: List<RequestInterceptor>

localInterceptorsSorted

private open var localInterceptorsSorted: Boolean

log

protected val log: Logger

messageSerializer

protected open var messageSerializer: MessageSerializer

method

protected val method: HttpMethod

queryParams

protected val queryParams: Map<String, String>

requestRetryPolicy

protected open var requestRetryPolicy: RetryPolicy

requestTimeout

protected open var requestTimeout: Duration

reusableContext

protected val reusableContext: InterceptorContext

serializerOverridden

private open var serializerOverridden: Boolean

serializerRegistry

protected val serializerRegistry: SerializerRegistry<MessageSerializer>

url

protected val url: String

Functions

auth

open fun auth(scheme: AuthScheme, credentials: Array<String>): RequestSpec

basicAuth

open fun basicAuth(username: String, password: String): RequestSpec

bearerAuth

open fun bearerAuth(token: String): RequestSpec

body

open fun body(body: Any): RequestSpec

disableRetry

open fun disableRetry(): RequestSpec

formParam

open fun formParam(name: String, value: String): RequestSpec

getBody

open fun getBody(): Any

getFormParams

open fun getFormParams(): Map<String, String>

getGroup

open fun getGroup(): ClientGroup

getHeaders

open fun getHeaders(): Map<String, String>

getMethod

open fun getMethod(): HttpMethod

getQueryParams

open fun getQueryParams(): Map<String, String>

getUrl

open fun getUrl(): String

group

open fun group(clientGroup: ClientGroup): RequestSpec

header

open fun header(name: HttpHeaderName, value: HttpHeaderValue, args: Array<Any>): RequestSpec

interceptor

open fun interceptor(interceptor: RequestInterceptor): RequestSpec

isRetryableStatus

private open fun isRetryableStatus(status: HttpStatus): Boolean

onSend

protected abstract fun <T> onSend(responseType: Class<T>): RestResponse<T>

parseResponseBody

protected open fun <T> parseResponseBody(responseBytes: Array<Byte>, responseType: Class<T>): T

queryParam

open fun queryParam(name: String, value: String): RequestSpec

resolveFullUrl

protected open fun resolveFullUrl(): String

retry

open fun retry(maxRetries: Int, backoffMs: Duration): RequestSpec

open fun retry(maxRetries: Int, backoffMs: Duration, maxBackoffMs: Duration): RequestSpec

send

fun <T> send(responseType: Class<T>): RestResponse<T>

open fun send(): RestResponse<Void>

serializer

open fun serializer(format: SerializerFormat): RequestSpec

timeout

open fun timeout(timeout: Duration): RequestSpec

unsafeHeader

open fun unsafeHeader(name: HttpHeaderName, value: String): RequestSpec

updateSerializerFromPool

private open fun updateSerializerFromPool(clientGroup: ClientGroup): MessageSerializer