Your suggested change has been received. Thank you.

close
Thales Logo

All

  • All
  • CipherTrust Manager
  • CipherTrust Application Data Protection (CADP)
  • CipherTrust Application Key Management (CAKM)
  • CipherTrust Batch Data Transformation (BDT)
  • CipherTrust Cloud Key Management (CCKM)
  • CipherTrust Data Discovery and Classification (DDC)
  • CipherTrust Data Protection Gateway (DPG)
  • CipherTrust Database Protection (CDP)
  • CipherTrust Intelligent Protection (CIP)
  • CipherTrust Integrations
  • CipherTrust Migrations
  • CipherTrust RESTful Data Protection (CRDP)
  • CipherTrust Transparent Encryption (CTE)
  • CipherTrust Transparent Encryption Userspace (CTE-U)
  • CipherTrust Secrets Management (CSM)
  • CipherTrust Vaulted Tokenization (CT-V)
  • CipherTrust Vaultless Tokenization (CT-VL)
  • CTE-Linux
  • CTE-Windows
  • CTE-AIX
  • CTE-K8s
  • CTE-U
  • Crypto Command Center
  • Data Protection on Demand
  • Luna Cloud HSM
  • Luna Network HSM
  • Luna PCIe HSM
  • Luna USB HSM
  • OneWelcome Identity Platform
  • ProtectApp LUKS
  • ProtectServer 2 HSM
  • ProtectServer 3 HSM
  • SafeNet Trusted Access (STA)
  • SafeNet MobilePASS+
  • SafeNet MobilePASS+ for Android
  • SafeNet MobilePASS+ for Chrome
  • SafeNet MobilePASS+ for macOS
  • SafeNet MobilePASS+ for iOS
  • SafeNet MobilePASS+ for WatchOS
  • SafeNet MobilePASS+ for Windows
  • SafeNet Synchronization Agent
  • SafeNet Logging Agent
  • SafeNet Agent for FreeRADIUS
  • SafeNet Agent for NPS
  • SafeNet Agent for Windows Logon
  • SafeNet Authentication Service Private Cloud Edition (SAS PCE)
  • SafeNet Remote Logging Agent
  • SafeNet Keycloak Agent
  • SafeNet IDPrime Virtual (IDPV)
  • SafeNet FIDO Key Manager
  • SafeNet FIDO Key Manager for Android
  • SafeNet FIDO Key Manager for iOS
  • SafeNet FIDO Key Manager for Windows
back

Getting started with the Android SDK

Initialize the Android SDK

search
printsuggest an editpdf paneldownload

Initialize the Android SDK

If you used the sdk-configurator to generate your configuration model, as described in Configuring the client, you can use the OneginiClientBuilder#build() method to initialize the Android SDK. If you created your own implementation of the OneginiClientConfigModel, you can provide it explicitly using the OneginiClientBuilder#setConfigModel() method.

The OneginiClientBuilder constructor has three mandatory parameters:

  • applicationContext
  • OneginiCreatePinRequestHandler
  • OneginiPinAuthenticationRequestHandler

For more information about these parameters see authenticators.

public static OneginiClient getOneginiClient(final Context context) {

OneginiClient oneginiClient = OneginiClient.getInstance();
if (oneginiClient == null) {
    oneginiClient = buildSDK(context);
}
return oneginiClient;
}

private static OneginiClient buildSDK(final Context context) {
final Context applicationContext = context.getApplicationContext();
final RegistrationRequestHandler registrationRequestHandler = new RegistrationRequestHandler(applicationContext);
final CreatePinRequestHandler createPinRequestHandler = new CreatePinRequestHandler(applicationContext);
final PinAuthenticationRequestHandler pinAuthenticationRequestHandler = new PinAuthenticationRequestHandler(applicationContext);

return new OneginiClientBuilder(applicationContext, createPinRequestHandler, pinAuthenticationRequestHandler).build();
}
fun getOneginiClient(context: Context): OneginiClient = OneginiClient.getInstance() ?: buildSDK(context)

private fun buildSDK(context: Context): OneginiClient {
val applicationContext: Context = context.applicationContext
val registrationRequestHandler = RegistrationRequestHandler(applicationContext)
val createPinRequestHandler = CreatePinRequestHandler(applicationContext)
val pinAuthenticationRequestHandler = PinAuthenticationRequestHandler(applicationContext)

return OneginiClientBuilder(applicationContext, createPinRequestHandler, pinAuthenticationRequestHandler)
    .setBrowserRegistrationRequestHandler(registrationRequestHandler)
    .build()
}

copy link to clipboardStarting the Android SDK

When the user starts the application, the first method that should be called on the Android SDK is the OneGiniClient#start method. The method is responsible for asynchronous initialization of the Android SDK. The method requires a OneginiInitializationHandler in order to return initialization results and errors.

Note

The OneginiClient#start method must complete before calling subsequent Android SDK methods. Calling additional methods before OneginiClient#start completes may cause operation errors.

If an error occurs during start, the Android SDK returns onError with an OneginiInitializationError object containing the error details.

copy link to clipboardExample: initialization

// method called during app's startup
private void setupOneginiSDK() {
    final OneginiClient oneginiClient = OneginiSDK.getOneginiClient(this);
    oneginiClient.start(new OneginiInitializationHandler() {
    @Override
    public void onSuccess(final Set<UserProfile> removedUserProfiles) {
        // remove UserProfiles that were removed on the server side and proceed with you application flow
    }

    @Override
    public void onError(final OneginiInitializationError error) {
        handleInitializationErrors(error);
    }
    });
}

private void handleInitializationErrors(final OneginiInitializationError error) {
    @OneginiInitializationError.InitializationErrorType int errorType = error.getErrorType();
    switch (errorType) {
    case OneginiInitializationError.NETWORK_CONNECTIVITY_PROBLEM:
    case OneginiInitializationError.SERVER_NOT_REACHABLE:
        showToast("No internet connection.");
        break;
    case OneginiInitializationError.OUTDATED_APP:
        showToast("Please update this application in order to use it.");
        break;
    case OneginiInitializationError.OUTDATED_OS:
        showToast("Please update your Android version to use this application.");
        break;
    case OneginiInitializationError.DEVICE_DEREGISTERED:
        // in that case clear local storage from device and all user's related data
        onDeviceDeregistered();
        break;
    case OneginiInitializationError.DEVICE_REGISTRATION_ERROR:
    case OneginiInitializationError.GENERAL_ERROR:
    default:
        // Just display the error for other, less relevant errors
        displayError(error);
        break;
    }
}
// method called during app's startup
    private fun setupOneginiSDK() {
    val oneginiClient: OneginiClient = OneginiSDK.getOneginiClient(this)
    oneginiClient.start(object : OneginiInitializationHandler {
    override fun onSuccess(removedUserProfiles: Set<UserProfile>) {
        // remove UserProfiles that were removed on the server side and proceed with you application flow
    }

    override fun onError(error: OneginiInitializationError) {
        handleInitializationErrors(error)
    }
    })
}

private fun handleInitializationErrors(error: OneginiInitializationError) {
    @InitializationErrorType val errorType = error.errorType
    when (errorType) {
    OneginiInitializationError.NETWORK_CONNECTIVITY_PROBLEM,
    OneginiInitializationError.SERVER_NOT_REACHABLE ->
        showToast("No internet connection.")
    OneginiInitializationError.OUTDATED_APP ->
        showToast("Please update this application in order to use it.")
    OneginiInitializationError.OUTDATED_OS ->
        showToast("Please update your Android version to use this application.")
    OneginiInitializationError.DEVICE_DEREGISTERED ->
        // in that case clear local storage from device and all user's related data
        onDeviceDeregistered()
    OneginiInitializationError.DEVICE_REGISTRATION_ERROR,
    OneginiInitializationError.GENERAL_ERROR ->
        // Just display the error for other, less relevant errors
        displayError(error)
    else -> displayError(error)
    }
}

On this page