com.gemalto.idp.mobile.authentication.mode.biofingerprint

Class BioFingerprintAuthService

java.lang.Object

com.gemalto.idp.mobile.authentication.mode.biofingerprint.BioFingerprintAuthService

All Implemented Interfaces:

AuthService

public class BioFingerprintAuthService
extends java.lang.Object
implements AuthService

A class that represents BioFingerprint authentication service. This is an entry point to BioFingerprint library.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
static BioFingerprintAuthService	create(AuthenticationModule module)
BioFingerprintAuthMode	getAuthMode() Get authentication mode reference corresponding to this service.
BioFingerprintContainer	getBioFingerprintContainer() Get instance or BioFingerprintContainer which will be used for fingerprint verification.
boolean	isConfigured() Indicates if the authentication mode is configured and ready for use.
boolean	isSupported() Indicates if the authentication mode is supported by the hardware.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static BioFingerprintAuthService create(AuthenticationModule module)

getAuthMode

public BioFingerprintAuthMode getAuthMode()

Get authentication mode reference corresponding to this service.

Specified by:

getAuthMode in interface AuthService

Returns:

current auth mode.

isSupported

public boolean isSupported()

Indicates if the authentication mode is supported by the hardware. This should be always checked before using BioFingerprint functionalities. Skipping this check is not encouraged and it may crash your application when executing on a device which is below Android M or with no fingerprint sensor.

Specified by:

isSupported in interface AuthService

Returns:

true if supported, else return false.

isConfigured

public boolean isConfigured()

Indicates if the authentication mode is configured and ready for use. For example, a user may need to configure the OS to use a particular feature, such as bio-fingerprint, before this authentication mode can be used.

Specified by:

isConfigured in interface AuthService

Returns:

true if configured, else return false.

getBioFingerprintContainer

public BioFingerprintContainer getBioFingerprintContainer()

Get instance or BioFingerprintContainer which will be used for fingerprint verification.

Returns:

bioFingerprintContainer