equinox-compose/com.tecknobit.equinoxcompose.network/EquinoxRequester

EquinoxRequester

abstract class EquinoxRequester( host: String, userId: String? = null, userToken: String? = null, debugMode: Boolean = false, connectionTimeout: Long = DEFAULT_REQUEST_TIMEOUT, connectionErrorMessage: String, byPassSSLValidation: Boolean = false) : Requester

The EquinoxRequester class is useful to communicate with backend based on the SpringBoot framework with the requests pre-implemented

Author

N7ghtm4r3 - Tecknobit

Since

1.0.6

Parameters

host

The host address where is running the backend

userId

The user identifier

userToken

The user token

debugMode

Whether the requester is still in development and who is developing needs the log of the requester's workflow, if it is enabled all the details of the requests sent and the errors occurred will be printed in the console

connectionTimeout

Time to keep alive request then throw the connection refused error

connectionErrorMessage

The error to send when a connection error occurred

byPassSSLValidation

Whether bypass the SSL certificates validation, this for example when is a self-signed the certificate USE WITH CAUTION

Constructors

EquinoxRequester

constructor(host: String, userId: String? = null, userToken: String? = null, debugMode: Boolean = false, connectionTimeout: Long = DEFAULT_REQUEST_TIMEOUT, connectionErrorMessage: String, byPassSSLValidation: Boolean = false)

Properties

byPassSSLValidation

protected val byPassSSLValidation: Boolean

connectionErrorMessage

protected val connectionErrorMessage: String

connectionTimeout

protected val connectionTimeout: Long

debugMode

protected var debugMode: Boolean

host

protected var host: String

initHost

private val initHost: () -> Unit

interceptorAction

protected var interceptorAction: () -> Unit?

ktorClient

protected val ktorClient: HttpClient

loggerMutex

private val loggerMutex: Mutex

mustValidateCertificates

protected var mustValidateCertificates: Boolean

userId

protected var userId: String?

userToken

protected var userToken: String?

Functions

assembleCustomEndpointPath

protected fun assembleCustomEndpointPath(customEndpoint: String, subEndpoint: String = ""): String

Method used to assemble the endpoint to make the request to the custom controllers

assembleUsersEndpointPath

protected fun assembleUsersEndpointPath(endpoint: String = ""): String

Method used to assemble the endpoint to make the request to the users controller

attachInterceptorOnRequest

fun attachInterceptorOnRequest(interceptor: () -> Unit)

changeEmail

open suspend fun changeEmail(newEmail: String): JsonObject

Method used to request the to change the email of the user

changeHost

open override fun changeHost(host: String)

Method used to change, during the runtime for example when the session changed, the host address to make the requests

changeLanguage

open suspend fun changeLanguage(newLanguage: String): JsonObject

Method used to request the to change the language of the user

changePassword

open suspend fun changePassword(newPassword: String): JsonObject

Method used to request the to change the password of the user

changeProfilePic

open suspend fun changeProfilePic(profilePicName: String, profilePicBytes: ByteArray): JsonObject

Method used to request the to change the profile pic of the user

clearSession

open fun clearSession()

connectionErrorMessage

protected fun connectionErrorMessage(): JsonObject

createPaginationQuery

protected fun createPaginationQuery(page: Int, pageSize: Int): JsonObject

deleteAccount

open suspend fun deleteAccount(): JsonObject

Method used to request the to delete the account of the user

execDelete

protected suspend fun execDelete(endpoint: String, headers: Map<String, Any>, query: JsonObject?, payload: JsonObject?): JsonObject

execGet

protected suspend fun execGet(endpoint: String, headers: Map<String, Any>, query: JsonObject?): JsonObject

execMultipartRequest

protected suspend fun execMultipartRequest(endpoint: String, headers: Map<String, Any>, query: JsonObject?, payload: PartData): JsonObject

protected suspend fun execMultipartRequest(endpoint: String, headers: Map<String, Any>, query: JsonObject?, payload: List<PartData>): JsonObject

execPatch

protected suspend fun execPatch(endpoint: String, headers: Map<String, Any>, query: JsonObject?, payload: JsonObject): JsonObject

execPost

protected suspend fun execPost(endpoint: String, headers: Map<String, Any>, query: JsonObject?, payload: JsonObject): JsonObject

execPut

protected suspend fun execPut(endpoint: String, headers: Map<String, Any>, query: JsonObject?, payload: JsonObject): JsonObject

execRequest

private suspend fun execRequest( method: RequestMethod, endpoint: String, headers: Map<String, Any>, query: JsonObject?, payload: JsonObject?): JsonObject

getDynamicAccountData

suspend fun getDynamicAccountData(): JsonObject

Method used to request the dynamic data of the user

getSignInPayload

protected open fun getSignInPayload(email: String, password: String, vararg custom: Any?): JsonObject

Method used to create the payload for the signIn request.

getSignUpPayload

protected open fun getSignUpPayload( serverSecret: String, name: String, surname: String, email: String, password: String, language: String, vararg custom: Any?): JsonObject

Method used to create the payload for the signUp request.

interceptRequest

protected fun interceptRequest()

logError

private fun logError(exception: Exception)

logHeaders

private fun logHeaders(headers: Map<String, Any>)

logQuery

private fun logQuery(query: JsonObject?)

logRequestInfo

private suspend fun logRequestInfo( requestUrl: String, headers: Map<String, Any>, query: JsonObject?, requestPayloadInfo: () -> Unit, response: JsonObject?)

prepareRequest

private fun HttpRequestBuilder.prepareRequest(headers: Map<String, Any>, contentType: ContentType?, query: JsonObject?, payload: () -> Unit?)

prettyPrint

private fun JsonObject.prettyPrint()

setUserCredentials

fun setUserCredentials(userId: String?, userToken: String?)

signIn

open suspend fun signIn(email: String, password: String, vararg custom: Any?): JsonObject

Method used to request the to sign in the Equinox's system

signUp

suspend fun signUp( serverSecret: String, name: String, surname: String, email: String, password: String, language: String, vararg custom: Any?): JsonObject

Method used to request the to sign up in the Equinox's system