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

Interface BioFingerprintAuthenticationCallbacks

public interface BioFingerprintAuthenticationCallbacks

This interface gives to an application maker a capability of following fingerprint authentication process and report a user regarding the progress.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
void	onAuthenticationError(int errorCode, java.lang.CharSequence errString) This callback function is called if fingerprint authentication failed with an unrecoverable error but was completed.
void	onAuthenticationFailed() This callback function is called if fingerprint was read but could not be recognized (for example, wrong finger was put on a sensor).
void	onAuthenticationHelp(int helpCode, java.lang.CharSequence helpString) This callback function is called if a recoverable error occured during authentication.
void	onAuthenticationSucceeded() This callback function is called if authentication with a fingerprint against enrolled fingerprints was successful - a fingerprint was recognized.
void	onError(IdpException e) This callback function is called if the fingerprint is not correctly configured or an internal cryptographic error occurs.
void	onStartFPSensor() This callback function is called when the Fingerprint sensor has started listening.
void	onSuccess(BioFingerprintAuthInput bioFPAuthInput) This callback function is called if: a user succeeded to authenticate using his fingerprint an object that represents a biofingerprint data used for OTP computation was initialized successfully Now user could use the authenticated bioFingerprint Authentication Input.

Method Detail

onSuccess

void onSuccess(BioFingerprintAuthInput bioFPAuthInput)

This callback function is called if:

• a user succeeded to authenticate using his fingerprint
• an object that represents a biofingerprint data used for OTP computation was initialized successfully

Now user could use the authenticated bioFingerprint Authentication Input. eg. for OTP computation.

Parameters:

bioFPAuthInput - represents the authenticated biofingerprint authentication input object.

onStartFPSensor

void onStartFPSensor()

This callback function is called when the Fingerprint sensor has started listening.

In this callback, application developer shall instruct the user to authenticate with fingerprint. eg. a DialogFragment with message displayed.

onError

void onError(IdpException e)

This callback function is called if the fingerprint is not correctly configured or an internal cryptographic error occurs.

Parameters:

e - exception object indicating fingerprint authentication problem. An application behavior can be determined according to an exception type.

onAuthenticationError

void onAuthenticationError(int errorCode,
                           java.lang.CharSequence errString)

This callback function is called if fingerprint authentication failed with an unrecoverable error but was completed. eg. If the user has tried with an invalid fingerprint consecutively. For the list of error codes and descriptions, please, turn to:

Parameters:

errorCode - a code of error that operation failed with

errString - the description of error operation failed with.

See Also:

Section 'Constants' Please note that when under the condition where user has reached the maximum number of failed attempts permitted by the system (eg. 5 failed attempts), the sensor can be locked out for about 30 Seconds depends on the OS version and manufacturer.

onAuthenticationHelp

void onAuthenticationHelp(int helpCode,
                          java.lang.CharSequence helpString)

This callback function is called if a recoverable error occured during authentication. An error could be presented to user using dialog fragment. It gives to a user a chance of reauthenticating. For example: a finger was removed from a sensor too quickly. For the list of error codes and descriptions, please, turn to:

Parameters:

helpCode - code of message

helpString - help string

See Also:

Section 'Constants'

onAuthenticationSucceeded

void onAuthenticationSucceeded()

This callback function is called if authentication with a fingerprint against enrolled fingerprints was successful - a fingerprint was recognized.

onAuthenticationFailed

void onAuthenticationFailed()

This callback function is called if fingerprint was read but could not be recognized (for example, wrong finger was put on a sensor). In such case an error can be presented to a user through dialog fragment.