com.gemalto.idp.mobile.authentication.mode.face

Class FaceAuthService

java.lang.Object

com.gemalto.idp.mobile.authentication.mode.face.FaceAuthService

All Implemented Interfaces:

AuthService

public class FaceAuthService
extends java.lang.Object
implements AuthService

An interface that represents Facial authentication service. This is an entry point to Facial library.

Since:

4.2

Method Summary

Modifier and Type	Method and Description
void	configureLicense(FaceAuthLicense faceAuthLicense, FaceAuthLicenseConfigurationCallback faceAuthLicenseConfigurationCallback) Configure license.
static FaceAuthService	create(AuthenticationModule module) Create face authentication service which is the entry point of face authentication feature.
FaceAuthMode	getAuthMode() Get authentication mode reference corresponding to this service.
FaceAuthFactory	getFaceAuthFactory() Get FaceAuthFactory for Face object creation
void	initialize(FaceAuthInitializeCallback callback) Initialize the biometric face engine.
boolean	isConfigured() Indicates if the authentication mode is configured and ready for use.
boolean	isInitialized() Indicates if the library has been initialized.
boolean	isLicenseConfigured() Deprecated.
boolean	isSupported() Indicates if the authentication mode is supported by the hardware and OS.
boolean	reset() Cleanup the data associated with FaceID.
static void	setContext(android.content.Context context) Deprecated.
void	uninitialize() Uninitialize the biometric face engine.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static FaceAuthService create(AuthenticationModule module)

Create face authentication service which is the entry point of face authentication feature.

Parameters:

module -

Returns:

faceAuthService

setContext

@Deprecated
public static void setContext(android.content.Context context)

Deprecated.

This method is deprecated starting from 4.5. This method is now empty (do nothing) It is not necessary to call this function since the context can use ApplicationContext, which has been provided through ApplicationContextHolder

initialize

public void initialize(FaceAuthInitializeCallback callback)

Initialize the biometric face engine. This operation must be done before any other face operations. This is an asynchronous method that will takes times in seconds. Upon completion of the initialization, the callback will be invoked. Please take note that context must be set previously by calling setContext(Context).

Parameters:

callback - callback to be invoked upon completion of this operation

configureLicense

public void configureLicense(FaceAuthLicense faceAuthLicense,
                             FaceAuthLicenseConfigurationCallback faceAuthLicenseConfigurationCallback)

Configure license. This API is always required for license retrieval when the license is expired. It will check if there is existing license and the validity before sending HTTP request to request the license. If the existing license is still valid, there is no HTTP request.

Parameters:

faceAuthLicense - the FaceAuthLicense

faceAuthLicenseConfigurationCallback - callback to be invoked upon completion of this operation

Throws:

IdpAuthException

isLicenseConfigured

@Deprecated
public boolean isLicenseConfigured()

Deprecated.

Deprecated! Indicates if the license has been configured. It is deprecated since SDK must be able to re-request the license automatically when it is expired. SDK do not store entitlementId value on persistent storage, hence @{link configureLicense(FaceAuthLicense, FaceAuthLicenseConfigurationCallback) is always required to be called

Returns:

false always

uninitialize

public void uninitialize()

Uninitialize the biometric face engine. Face operations will no longer work before initialize is called again.

isInitialized

public boolean isInitialized()

Indicates if the library has been initialized.

Returns:

true if it has been initialized

getFaceAuthFactory

public FaceAuthFactory getFaceAuthFactory()

Get FaceAuthFactory for Face object creation

Returns:

Factory instance

getAuthMode

public FaceAuthMode 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 and OS. This should be always checked before using Face Authentication functionalities. Skipping this check is not encouraged and it may crash your application when executing on a device which is below Android 4.4.

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 face template needs to be enrolled before this authentication mode can be used.

Specified by:

isConfigured in interface AuthService

Returns:

true if configured, else return false.

reset

public boolean reset()
              throws IdpException

Cleanup the data associated with FaceID. The license file will be preserved. Re-enrolment of face template is required.

Returns:

true if rest is successful.

Throws:

IdpException - failure during cleanup. Refer to error code and error message for the details.

Since:

4.9.0

See Also:

IdpCore.reset()