com.gallagher.security.mobileaccess.MobileAccessProvider Class Reference

Static Public Member Functions
static MobileAccess	configure (@NonNull Application application, @Nullable String databaseFilePath, @Nullable String unlockNotificationChannelId, @Nullable String bleServiceForegroundNotificationChannelId)
static synchronized MobileAccess	configure ( @NonNull Application application, @Nullable String databaseFilePath, @Nullable NotificationsConfiguration notificationsConfiguration, @NonNull EnumSet< SdkFeature > enabledFeatures, @NonNull CloudTlsValidationMode cloudTlsValidationMode, @Nullable Map< String, Object > config)
static synchronized MobileAccess	getInstance ()

Static Public Attributes
static final Long	TOTP_ALLOWABLE_TIME_WINDOW_SECONDS = 30L

Detailed Description

Provides instances of the Mobile Access API.

Member Function Documentation

configure() [1/2]

static synchronized MobileAccess com.gallagher.security.mobileaccess.MobileAccessProvider.configure ( @NonNull Application  application, @Nullable String  databaseFilePath, @Nullable NotificationsConfiguration  notificationsConfiguration, @NonNull EnumSet< SdkFeature >  enabledFeatures, @NonNull CloudTlsValidationMode  cloudTlsValidationMode, @Nullable Map< String, Object >  config  )

static

Use this method to configure the SDK before doing anything else. It is not possible to re-configure the SDK once this has been called..

Parameters

application	The android Application object
databaseFilePath	You may specify a custom file path and name for the Mobile Access SDK database. If you decide to specify a custom file path, it is recommended to put it under the Android NoBackupFiles directory - accessed via context.getNoBackupFilesDir(). If existing registrations exist, changing the database file path will make them unavailable. Make sure the database file path stays the same once deployed to user devices. A default name of 'com.gallagher.security.mobileaccess.db' is used if null is passed in for this parameter.
notificationsConfiguration	Configuration for the SDK to use when creating notifications (for example to tell you to unlock your device for access)
enabledFeatures	List of SdkFeatureSets for which features to enable status and error reporting on
cloudTlsValidationMode	Use to override the default cloud server certificate validation procedure. You should specify CloudTlsValidationMode.ANY_VALID_CERTIFICATE_REQUIRED
config	Private for Gallagher internal use. Pass null here.

                                                  {
        // Gallagher Internal Note: This is the real method that the Mobile Connect app uses, the other overloads are for compatibility with SDK users
 
        // If we have already called configure
        if (sMobileAccess != null) {
            throw new FatalError("Cannot call configure twice");
        }
 
        // Set defaults for the parameters that have been omitted
        if (databaseFilePath == null) {
            databaseFilePath = new File(application.getNoBackupFilesDir(), "com.gallagher.security.mobileaccess.db").getPath();
        }
 
        // Remove the built-in BouncyCastle we can use a version we specify
        Security.removeProvider(BouncyCastleProvider.PROVIDER_NAME);
        Security.addProvider(new BouncyCastleProvider());
 
        // Create the SDK singleton
        sMobileAccess = new DefaultMobileAccess(application, databaseFilePath, cloudTlsValidationMode, enabledFeatures, notificationsConfiguration, config);
        return sMobileAccess;
    }

configure() [2/2]

static MobileAccess com.gallagher.security.mobileaccess.MobileAccessProvider.configure ( @NonNull Application  application, @Nullable String  databaseFilePath, @Nullable String  unlockNotificationChannelId, @Nullable String  bleServiceForegroundNotificationChannelId  )

static

Convenience overload to configure the SDK for backwards compatibility

                                                                                                     {
 
        // set up the fido authenticators module
        FidoAuthenticatorsHelpers.setupAuthenticators();
 
        return configure(
                application,
                databaseFilePath,
                new NotificationsConfiguration(unlockNotificationChannelId, null, bleServiceForegroundNotificationChannelId, null),
                EnumSet.noneOf(SdkFeature.class),
                CloudTlsValidationMode.ANY_VALID_CERTIFICATE_REQUIRED,
                null);
    }

getInstance()

static synchronized MobileAccess com.gallagher.security.mobileaccess.MobileAccessProvider.getInstance ( )

static

                                                          {
        if (sMobileAccess == null) {
            throw new FatalError("Call configure before calling getInstance");
        }
 
        return sMobileAccess;
    }

---

The documentation for this class was generated from the following file:

• MobileAccessProvider.java