Skip to content

Basic Authentication Store

BasicAuthStoreStep persists/rereads/erases the user credential data provided by BasicAuthStep. This step has to be executed after the successful initialization of the application store. This means that there is no secure store (except the passcodePolicyStore) in the onboarding flow before the execution of the SecureStoreStep.

Input Parameters

Mandatory input parameters:

  • application store – Properly initialized and opened application store implementation typically provided by the StoreManagerStep and can be accessed using the getApplicationStore method of the OnboardingContext.

  • context – Specifies the android context initiating the flow, such as the caller Activity. This setting has to be provided on the initial FlowContext.

Output Parameters

The output of the step is always in the application store.

Using BasicAuthStoreStep

  1. Set the application store in the flowContext.

    1
      flowContext.setApplicationStore(secureStore);
    
  2. Initiate the step:

    1
      BasicAuthStoreStep basicAuthStoreStep = new BasicAuthStoreStep();
    
  3. Specify the execute method's FlowActionHandler parameter's "onFailure" and "onSuccess" behaviour:

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
        flowManagerService.execute(flow, flowContext, new FlowActionHandler() {
                @Override
                public void onFailure(Throwable t) {
                    //set the status, update the caller activity
                }
    
                @Override
                public void onSuccess(FlowContext result) {
                    //set the status, update the caller activity
                    //read the result
                }
            });
    

Behaviour of BasicAuthStoreStep

In case of the onboard scenario, this step persists the user credential (username, password) data in the application store.

In case of the restore scenario, this step makes available the persisted user credential data for the basic authorization requests. During the execution of the step, no data is read from the application store. Only a reference to the store is set and, during network communication, this reference is used by the foundation layer to restore the user credential.

In case of the reset scenario, the persisted user credential is deleted from the application store.