routers-client-ktor/dev.kaccelero.client/AbstractAPIClient

AbstractAPIClient

abstract class AbstractAPIClient(val baseUrl: String, val getTokenUseCase: IGetTokenUseCase? = null, val renewTokenUseCase: IRenewTokenUseCase? = null, val logoutUseCase: ILogoutUseCase? = null, json: Json? = null, engine: HttpClientEngine? = null, block: HttpClientConfig<*>.() -> Unit = {}) : IAPIClient

Base implementation of IAPIClient using Ktor HTTP client.

Constructors

AbstractAPIClient

constructor(baseUrl: String, getTokenUseCase: IGetTokenUseCase? = null, renewTokenUseCase: IRenewTokenUseCase? = null, logoutUseCase: ILogoutUseCase? = null, json: Json? = null, engine: HttpClientEngine? = null, block: HttpClientConfig<*>.() -> Unit = {})

Properties

baseUrl

open override val baseUrl: String

Base URL of the API.

getTokenUseCase

open override val getTokenUseCase: IGetTokenUseCase? = null

Use case to get the current token, if applicable.

logoutUseCase

open override val logoutUseCase: ILogoutUseCase? = null

Use case to log out, if applicable.

renewTokenUseCase

open override val renewTokenUseCase: IRenewTokenUseCase? = null

Use case to renew the token, if applicable.

Functions

request

open suspend override fun request(method: HttpMethod, path: String, builder: HttpRequestBuilder.() -> Unit): HttpResponse

Makes an HTTP request to the specified path with the given method and request builder. It also applies token management if the relevant use cases are provided.

shouldIncludeToken

open fun shouldIncludeToken(method: HttpMethod, path: String): Boolean

Determines whether to include the authentication token in the request. Can be overridden to customize behavior based on method and path. By default, it returns true for all requests.

shouldPropagateRequestId

open fun shouldPropagateRequestId(method: HttpMethod, path: String): Boolean

Determines whether to propagate the request ID in the request. Can be overridden to customize behavior based on method and path. By default, it returns true for all requests.