fl-foundation/com.quickplay.vstb7.http

Package-level declarations

Types

interface Call<RequestBody : Any, ResponseBody : Any> : Cloneable

Represents a request that has been prepared for execution. A call can be canceled. As this object represents a single request/response pair (stream), it cannot be executed twice.

Callback

interface Callback<ReqBody : Any, ResBody : Any>

The callback interface for an asynchronous execution of a Call instance.

CallInterruptedException

class CallInterruptedException(val message: String, val cause: Throwable? = null, val errorfulCause: Error? = null) : HttpClientException

An exception raised if the Call under execution was interrupted for some reason See the underlying HttpClientException.cause for more information

EdgeServiceError

@JsonClass(generateAdapter = true)

data class EdgeServiceError(val header: Header)

Represents service call response payload failure with error condition { "header": { "source": "024-04", "code": -1, "message": "Failure", "system_time": 1726123052106, "tracking_id": "58646716-23d4-498a-aded-1f9e69bca936", "errors": { "code": "40250404", "description": "Item not found" } } }

EdgeServiceProxyError

@JsonClass(generateAdapter = true)

data class EdgeServiceProxyError(val code: String, val errorCode: Int, val type: String, val message: String)

Represents service call response proxy payload with error condition e.g. { "code": "InvalidPTokenError", "errorCode": 201, "type": "CLIENT_ERROR", "message": "Not Authorized" }

ErrorDetail

@JsonClass(generateAdapter = true)

data class ErrorDetail(val code: String, val description: String)

FormRequestBody

interface FormRequestBody

Represents An x-www-form-urlencoded Request Body The Form body is appropriately encoded before sending to Server

Header

@JsonClass(generateAdapter = true)

data class Header(val source: String, val code: Int, val message: String, val systemTime: Long, val trackingId: String, val errors: List<ErrorDetail>?)

HttpClient

interface HttpClient : Call.Factory

The Client that is responsible for constructing a Call based on a Request and return an appropriate Response

HttpClientException

sealed class HttpClientException : Exception

Base class for all types of Exception raised while executing a Call The exception can either have an underlying exceptional cause or erroneous errorfulCause.

HttpLogLevel

enum HttpLogLevel : Enum<HttpLogLevel>

Enables Request / Response Logging

HttpServerSentEventClient

class HttpServerSentEventClient(connectionTimeout: Long = DEFAULT_CONNECTION_TIMEOUT_SECONDS, readTimeout: Long = DEFAULT_READ_TIMEOUT_MINUTES, sseSourceUrl: String)

Custom implementation of OkHttpClient that handles Server Sent Events.

Request

interface Request<RequestBody>

Represents a Http Request

Response

interface Response<RespBody>

Represents a HTTP Response

ResponseBody

interface ResponseBody

Represents a Http raw response body if appropriate for the corresponding method.

ResponseDeserializationException

class ResponseDeserializationException(val message: String, val cause: Throwable? = null, val errorfulCause: Error? = null) : HttpClientException

An exception raised if the Response deserialization failed See the underlying HttpClientException.cause for more information

Properties

defaultLogger

val defaultLogger: Logger

INVALID_REQUEST_MSG

const val INVALID_REQUEST_MSG: String

isRunningHTTPClientUnitTests

var isRunningHTTPClientUnitTests: Boolean

Functions

awaitResult

suspend fun <ReqBody : Any, ResBody : Any> Call<ReqBody, ResBody>.awaitResult(): Result<ResBody, HttpClientException>

Convenience function to catch any Exception and return it as a Failure Result This is useful, if we want to use when classes in processing result

buildWith

fun <ReqBody : Any> Request.Builder<ReqBody>.buildWith(request: Request<ReqBody>)

An extension Request.Builder that builds a new Request upon the passed request object.

callWith

inline fun <ReqBody : Any, ResBody : Any> Call.Factory.callWith(noinline builder: Request.Builder<ReqBody>.() -> Unit): Call<ReqBody, ResBody>

Constructs a call with the passed Request Builder instance. The Request and Response Types are passed as reified Generic Parameters.

errorCategory

fun HttpClientException.errorCategory(): Int

An extension to get Error Category for a particular HttpClientException