Android Initialization

Jump to: Kotlin, Java

Initialize a UMFAClient instance from the ZSM module by creating an instance of the ZSMConfig class with the necessary configuration parameters such as host_url, application_id, and consumer_id. Then, use the UMFAClient constructor to create the instance, which is required for performing all Universal MFA operations.

Custom logging can be defined when initializing the UMFAClient object. If a custom logging function is not provided, a default logging method is used. This method uses Android's built-in logging methods and maps to the LogLevel enum defined within the API.

Kotlin

Usage

 private fun initializeZSM() {
        val config = ZSMConfig(JSONObject().apply {
            put("host_url", hostUrl.value)
            put("application_id", applicationId.value)
            put("consumer_id", consumerId.value)
            put("authentication_host", authenticationHost.value)
            put("api_key", apiKey.value)

            logLevel = LogLevel.TRACE // Set the lowest level of logging
            logging = { _, message ->
                Log.d("Custom log", message)
            }
        })

        val client = UMFAClient(context, config)
    }

Returns

The initialized UMFAClient instance.

Configuration Parameters

Initialize the ZSMConfig object with the required configuration.

Parameters

Configuring Logging

The ZSM SDK provides flexible logging configuration options. You can set the log level and provide a custom logging implementation to route log messages to your application's logging infrastructure.

Setting Log Level

You can set the log level either during initial configuration or after creating the ZSMConfig object:

// Option 1: During initialization
val config = ZSMConfig(JSONObject().apply {
    put("host_url", hostUrl)
    put("application_id", applicationId)
    put("consumer_id", consumerId)
    // Set log level directly in the config
    put("log_level", "TRACE")
})

// Option 2: After initialization
config.logLevel = LogLevel.TRACE

Custom Logging Implementation

You can provide a custom logging function that receives both the log level and message. This allows you to integrate with your application's logging infrastructure:

// Set custom logging function
config.logging = { level, message ->
    // Format the log message as needed
    val formattedMessage = "$level - $message"
    
    // Route to your logging system
    when (level) {
        LogLevel.TRACE -> Log.v("ZSM", formattedMessage)
        LogLevel.DEBUG -> Log.d("ZSM", formattedMessage)
        LogLevel.INFO -> Log.i("ZSM", formattedMessage)
        LogLevel.WARN -> Log.w("ZSM", formattedMessage)
        LogLevel.ERROR, LogLevel.FATAL -> Log.e("ZSM", formattedMessage)
    }
}

The logging function is called with two parameters:

• level: A LogLevel enum value indicating the severity
• message: The log message as a String

Log Levels

enum class LogLevel(val value: Int) {
    TRACE(-1),
    DEBUG(0),
    INFO(1),
    WARN(2),
    ERROR(3),
    FATAL(4)
}

Returns

The initialized ZSMConfig object.

Java

The Java-friendly API allows the methods to be called using lambdas for seamless integration.

Usage

ZSMConfig config = new ZSMConfig(new JSONObject()
                    .put("host_url", this.getHostUrl())
                    .put("application_id", "########-####-####-####-############")
                    .put("consumer_id", this.getConsumerId())
                    .put("api_key", this.getApiKey())
                    .put("authentication_host", this.getApplicationHost())
            );

config.setLogLevel(LogLevel.TRACE); // Set the lowest level of logging
config.setLogging((level, message) -> {
    Log.d("Custom log", message);
});
UMFAClient client = new UMFAClient(context, config);

Returns

The initialized UMFAClient instance.

ZSMConfig Properties

Configuring Logging

The ZSM SDK provides flexible logging configuration options. You can set the log level and provide a custom logging implementation to route log messages to your application's logging infrastructure.

Setting Log Level

You can set the log level either during initial configuration or after creating the ZSMConfig object:

// Option 1: During initialization
JSONObject configJson = new JSONObject()
    .put("host_url", hostUrl)
    .put("application_id", applicationId)
    .put("consumer_id", consumerId)
    // Set log level directly in the config
    .put("log_level", "TRACE");

ZSMConfig config = new ZSMConfig(configJson);

// Option 2: After initialization
config.setLogLevel(LogLevel.TRACE);

Custom Logging Implementation

You can provide a custom logging function that receives both the log level and message. This allows you to integrate with your application's logging infrastructure:

// Set custom logging function
config.setLogging((level, message) -> {
    // Format the log message as needed
    String formattedMessage = level + " - " + message;
    
    // Route to your logging system
    switch (level) {
        case TRACE:
            Log.v("ZSM", formattedMessage);
            break;
        case DEBUG:
            Log.d("ZSM", formattedMessage);
            break;
        case INFO:
            Log.i("ZSM", formattedMessage);
            break;
        case WARN:
            Log.w("ZSM", formattedMessage);
            break;
        case ERROR:
        case FATAL:
            Log.e("ZSM", formattedMessage);
            break;
    }
});

The logging function is called with two parameters:

• level: A LogLevel enum value indicating the severity
• message: The log message as a String

Log Levels

enum LogLevel {
    TRACE(-1),
    DEBUG(0),
    INFO(1),
    WARN(2),
    ERROR(3),
    FATAL(4);
}

Returns

The initialized ZSMConfig object.