0.0.0

commons/com.pingidentity.mfa.commons/BaseMfaClient

BaseMfaClient

abstract class BaseMfaClient(val config: MfaConfiguration, val storage: MfaStorage? = null) : MfaClient

Base abstract class for MFA client implementations. This class provides common functionality for all MFA clients.

Parameters

config

The configuration for this MFA client.

storage

The storage implementation to use. If null, no storage will be used.

Constructors

constructor(config: MfaConfiguration, storage: MfaStorage? = null)

Properties

override val config: MfaConfiguration

lateinit var httpClient: HttpClient

HTTP client for making network requests.

protected var isInitialized: Boolean

Flag indicating whether this client has been initialized.

var logger: Logger

Logger instance for logging messages. This can be overridden by subclasses to use a different logger.

protected val storage: MfaStorage? = null

Functions

checkInitialized

protected fun checkInitialized()

Check if the client is initialized and throw an exception if it's not.

open suspend override fun close()

Clean up resources used by the MFA client. This method closes the storage client, http client, and performs any additional cleanup.

protected fun initHttp(timeout: Duration)

Initializes the HTTP client for making network requests. This method is called by initializeClient of the client implementation.

open suspend override fun initialize()

Initialize the MFA client with the given configuration. This method initializes the storage client if one is provided.

initializeClient

protected abstract suspend fun initializeClient()

Additional initialization for specific client implementations. This method is called by initialize after the storage client is initialized. Subclasses should override this method to perform additional initialization.