com.gemalto.idp.mobile.fasttrack

Class FastTrackException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.gemalto.idp.mobile.fasttrack.FastTrackException

All Implemented Interfaces:

Serializable

public class FastTrackException
extends Exception

This exception class covers all of the errors in FastTrack library.

To identify the error, integrator can use the pre-defined error codes in this class. More over, the message string also contains information of the real error code from the Core API.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	BIO_FINGERPRINT_NOT_CONFIGURED Deprecated.
static int	BIO_FINGERPRINT_NOT_SUPPORTED Deprecated.
static int	BIOMETRIC_HW_UNAVAILABLE Biometric hardware is unavailable on the device.
static int	BIOMETRIC_NO_HARDWARE No biometric hardware on the device.
static int	BIOMETRIC_NOT_ENROLLED Biometric is not enrolled on the device.
static int	DEVICE_FINGERPRINT Device Fingerprint failure, most likely due to invalid configuration on CustomData
static int	DEVICE_FINGERPRINT_IDENTICAL Failed to update the token fingerprint because the old and new fingerprint are identical.
static int	INTERNAL_ERROR Internal Error, most likely due to internal storage
static int	INVALID_ARGUMENT This error occurs when the caller passed an invalid argument (e.g.
static int	MESSENGER_INVALID_REGISTRATION_CODE Messenger Operation failed.
static int	MESSENGER_INVALID_REQUEST_PARAMETER Messenger Operation failed.
static int	MESSENGER_NETWORK_FAILURE OOB reported error due to the communication issue.
static int	OTP_GENERATION_FAILURE Failed in generating OTP.
static int	OTP_PIN_RULE_VIOLATION Violation of Pin Rule on changePin operation
static int	OTP_PROVISION_FAILURE Failed in provision Token.
static int	OTP_SETTINGS_NOT_FOUND OTP Settings not found.
static int	TRANSACTION_SIGNING_DEOBFUSCATION_FAILURE Messenger Operation failure related to Transaction Signing due to failure on obfuscation Check the value being passed when calling FastTrack.Builder.withMspObfuscationKeys(List)
static int	TRANSACTION_SIGNING_INVALID_DATA Messenger Operation failure related to Transaction Signing due to invalid data either on request or response.
static int	TRANSACTION_SIGNING_INVALID_SIGNATURE Messenger Operation failure related to Transaction Signing due to invalid signature.

Constructor Summary

Constructors

Constructor and Description
FastTrackException(int code, com.gemalto.idp.mobile.core.IdpException cause)
FastTrackException(int code, String message)
FastTrackException(int code, Throwable cause)
FastTrackException(int code, Throwable cause, String message, Object... args) Creates a new exception with domain, code, causing exception and error message.

Method Summary

Modifier and Type	Method and Description
int	getCode() Get the code of the exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_ARGUMENT

public static final int INVALID_ARGUMENT

This error occurs when the caller passed an invalid argument (e.g. null or empty string) into a function

See Also:

Constant Field Values

INTERNAL_ERROR

public static final int INTERNAL_ERROR

Internal Error, most likely due to internal storage

See Also:

Constant Field Values

DEVICE_FINGERPRINT

public static final int DEVICE_FINGERPRINT

Device Fingerprint failure, most likely due to invalid configuration on CustomData

See Also:

Constant Field Values

DEVICE_FINGERPRINT_IDENTICAL

public static final int DEVICE_FINGERPRINT_IDENTICAL

Failed to update the token fingerprint because the old and new fingerprint are identical.

Since:

5.4.0

See Also:

MobileProtector.updateDeviceFingerprintSource(String, byte[], MobileFingerprintSource), Constant Field Values

OTP_PROVISION_FAILURE

public static final int OTP_PROVISION_FAILURE

Failed in provision Token. Please check Configuration again and make sure device is connected to Internet

See Also:

Constant Field Values

OTP_GENERATION_FAILURE

public static final int OTP_GENERATION_FAILURE

Failed in generating OTP. It may happens due to internal error of the library

See Also:

Constant Field Values

OTP_PIN_RULE_VIOLATION

public static final int OTP_PIN_RULE_VIOLATION

Violation of Pin Rule on changePin operation

See Also:

Constant Field Values

OTP_SETTINGS_NOT_FOUND

public static final int OTP_SETTINGS_NOT_FOUND

OTP Settings not found. If OTP has been provisioned previously using Core API (of the Mobile Protector SDK), please invoke any of the following APIs

• OathMobileProtector.persistDcvvSettings(String, DcvvSettings)
• OathMobileProtector.persistHotpSettings(String, HotpSettings)
• OathMobileProtector.persistOcraSettings(String, OcraSettings)
• OathMobileProtector.persistTotpSettings(String, TotpSettings)
• CapMobileProtector.persistCapSettings(String, CapSettings)

See Also:

Constant Field Values

BIO_FINGERPRINT_NOT_SUPPORTED

@Deprecated
public static final int BIO_FINGERPRINT_NOT_SUPPORTED

Deprecated.

BioFingerprint is not supported by the device.

See Also:

Constant Field Values

BIO_FINGERPRINT_NOT_CONFIGURED

@Deprecated
public static final int BIO_FINGERPRINT_NOT_CONFIGURED

Deprecated.

BioFingerprint is not enrolled on the device.

See Also:

Constant Field Values

MESSENGER_INVALID_REGISTRATION_CODE

public static final int MESSENGER_INVALID_REGISTRATION_CODE

Messenger Operation failed. It can be caused by:

• Registration to the OOB server failed: The registration code is not valid for the user ID.
• Registration to the OOB server failed: The registration process expired.

Client application actions:

• Display error message.
• For registration code is not valid, Instruct end user to check his/her registration code and try again (note there may be limited number of attempts). Instruct end user, if the problem persists, to contact his/her customer care to check the validity of his/her registration code.
• For registration code expired, Instruct end user to contact his/her customer care to re-initialize the registration process.

See Also:

Constant Field Values

MESSENGER_INVALID_REQUEST_PARAMETER

public static final int MESSENGER_INVALID_REQUEST_PARAMETER

Messenger Operation failed. It can be caused by:

• Invalid public key that can be cause by invalid encoding, wrong length, wrong key usage, etc.
• Client id that send to the server is invalid or has not yet been registered.
• Specified domain name is invalid
• Specified application id is invalid

See Also:

Constant Field Values

MESSENGER_NETWORK_FAILURE

public static final int MESSENGER_NETWORK_FAILURE

OOB reported error due to the communication issue.

• The device is not connected to the network or connection is poor.
• Issue associated with client-server configuration such as server certificate.
• The service is not available, server is down.

Application developer actions:

• Ensure network connection available.
• Ensure OOB server is up and running.

Client application actions:

• Display error message.
• Instruct end user to enable some network connection (WiFi, GSM Data, ...), wait it to become really connected and repeat the operation.

See Also:

Constant Field Values

TRANSACTION_SIGNING_INVALID_DATA

public static final int TRANSACTION_SIGNING_INVALID_DATA

Messenger Operation failure related to Transaction Signing due to invalid data either on request or response. It can be caused by:

• Bad frame data
• Not supported frame
• Not supported device

See Also:

Constant Field Values

TRANSACTION_SIGNING_INVALID_SIGNATURE

public static final int TRANSACTION_SIGNING_INVALID_SIGNATURE

Messenger Operation failure related to Transaction Signing due to invalid signature. Check the value being passed when calling FastTrack.Builder.withMspVerificationKeys(List)

See Also:

Constant Field Values

TRANSACTION_SIGNING_DEOBFUSCATION_FAILURE

public static final int TRANSACTION_SIGNING_DEOBFUSCATION_FAILURE

Messenger Operation failure related to Transaction Signing due to failure on obfuscation Check the value being passed when calling FastTrack.Builder.withMspObfuscationKeys(List)

See Also:

Constant Field Values

BIOMETRIC_NO_HARDWARE

public static final int BIOMETRIC_NO_HARDWARE

No biometric hardware on the device.

Since:

5.4.0

See Also:

Constant Field Values

BIOMETRIC_HW_UNAVAILABLE

public static final int BIOMETRIC_HW_UNAVAILABLE

Biometric hardware is unavailable on the device.

Since:

5.4.0

See Also:

Constant Field Values

BIOMETRIC_NOT_ENROLLED

public static final int BIOMETRIC_NOT_ENROLLED

Biometric is not enrolled on the device.

Since:

5.4.0

See Also:

Constant Field Values

Constructor Detail

FastTrackException

public FastTrackException(int code,
                          Throwable cause)

FastTrackException

public FastTrackException(int code,
                          String message)

FastTrackException

public FastTrackException(int code,
                          com.gemalto.idp.mobile.core.IdpException cause)

FastTrackException

public FastTrackException(int code,
                          Throwable cause,
                          String message,
                          Object... args)

Creates a new exception with domain, code, causing exception and error message.

Parameters:

code - The error code.

cause - The nested exception causing this exception.

message - The message following String.format(Locale, String, Object...) } syntax.

args - The optional formatting arguments.

Method Detail

getCode

public int getCode()

Get the code of the exception.

Returns:

The exception code.