java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - com.thalesgroup.tmgsdk.TMGClientException

All Implemented Interfaces:

Serializable
```
public class TMGClientException
extends Exception
```
TMGClientException is a generic exception class which is used to handle all TMG SDK errors. TMGClientException provides exceptionType to get the cause of the error.

Since:

1.0

Version:

1.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ATTESTATION_ERROR`	Android attestation issues.
`static int`	`AUTHENTICATION_FAILURE_CANCEL`	Authentication failure.
`static int`	`CRYPTO_ERROR`	Issues with the keys generated from Android keystore system.
`static int`	`DEVICE_AUTHENTICATION_NOT_SUPPORTED`	Biometric Authentication is not available in the device.
`static int`	`ERROR_DEBUG_SDK_USED`	For security reason, Debug SDK variant cannot be used in the released app.
`static int`	`INVALID_DEVICE_AUTHENTICATION_PARAM`	Missing `FragmentActivity` in the parameter.
`static int`	`INVALID_IDV_METHOD`	The IDV method provided is invalid.
`static int`	`INVALID_OTP`	The OTP provided is not in the correct format.
`static int`	`INVALID_PARAMETERS`	Some of the configuration parameters such as provisioned tokens are invalid.
`static int`	`INVALID_TOKEN_ID`	The Visa Provisioned Token Id provided is either null or empty.
`static int`	`ISSUER_AUTHENTICATION_REQUIRED`	Issuer authentication required.
`static int`	`JSON_PARSING_ERROR`	Error parsing the JSON structure.
`static int`	`KEYSTORE_ERROR`	Key is permanently invalidated.
`static int`	`SERVER_ERROR`	Represents the server error code between 401 and 599 (exludes 429, 503, and those that has been defined.
`static int`	`SERVER_ERROR_CRYPTO_ERROR`	Crypto server error due to keystore issue.
`static int`	`SERVER_ERROR_EXPIRED_OTP`	The end user enters an expired OTP value.
`static int`	`SERVER_ERROR_IDV_NOT_AVAILABLE`	Selected an invalid IDV method.
`static int`	`SERVER_ERROR_INVALID_TOKEN_STATE`	Invalid token state on the server side.
`static int`	`SERVER_ERROR_NO_SESSION_FOUND`	The session was not found, expired, or terminated.
`static int`	`SERVER_ERROR_RETRY_LIMIT_EXCEEDED`	The authentication has exceeded the number of attempts allowed.
`static int`	`SERVER_ERROR_TOO_MANY_REQUESTS`	Server is unable to process the request as it is overwhelmed by too many requests.
`static int`	`SERVER_ERROR_WRONG_OTP`	The end user enters an incorrect OTP value.
`static int`	`SERVER_IS_NOT_ACCESSIBLE`	Connection issues.
`static int`	`SERVER_RETRYABLE`	This error code represents a server error that is retryable because there is a temporary network issue.
`static int`	`STORAGE_ERROR`	The device authentication method is not found in the storage.
`static int`	`TOKEN_ALREADY_BOUNDED`	The token is already bounded or in pending activation.
`static int`	`TOKEN_DEVICE_BINDING_DECLINED`	The token provided for device binding is declined.
`static int`	`TOKEN_DEVICE_BINDING_PENDING`	The token provided for create binding process is in pending state.
`static int`	`TOKEN_NOT_BOUNDED`	The token provided is not bound with the device.

Constructor Summary

Constructors
Constructor Description

TMGClientException(int errorCode, String message)

TMGClientException(int errorCode, Throwable e)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

int getErrorCode()
Returns the error code.

String getMessage()
Returns the error message.
- Methods inherited from class java.lang.Throwable
  addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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
  - AUTHENTICATION_FAILURE_CANCEL
```
public static final int AUTHENTICATION_FAILURE_CANCEL
```
    Authentication failure. The device (Biometric) authentication was canceled.
    
    Since:
    
    v1.0.1
    
    See Also:
    
    Constant Field Values
  - DEVICE_AUTHENTICATION_NOT_SUPPORTED
```
public static final int DEVICE_AUTHENTICATION_NOT_SUPPORTED
```
    Biometric Authentication is not available in the device.
    Please set up your Android Settings.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - SERVER_IS_NOT_ACCESSIBLE
```
public static final int SERVER_IS_NOT_ACCESSIBLE
```
    Connection issues.
    Please check your network connection and try again.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - SERVER_ERROR_CRYPTO_ERROR
```
public static final int SERVER_ERROR_CRYPTO_ERROR
```
    Crypto server error due to keystore issue.
    Please try again or you can log the error report and send it to Thales.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - SERVER_ERROR_INVALID_TOKEN_STATE
```
public static final int SERVER_ERROR_INVALID_TOKEN_STATE
```
    Invalid token state on the server side.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - SERVER_ERROR_IDV_NOT_AVAILABLE
```
public static final int SERVER_ERROR_IDV_NOT_AVAILABLE
```
    Selected an invalid IDV method.
    Please select another IDV method.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - SERVER_ERROR_NO_SESSION_FOUND
```
public static final int SERVER_ERROR_NO_SESSION_FOUND
```
    The session was not found, expired, or terminated.
    Call VisaCTFHelper.createBinding again to continue.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - SERVER_ERROR_WRONG_OTP
```
public static final int SERVER_ERROR_WRONG_OTP
```
    The end user enters an incorrect OTP value.
    Please try again.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - SERVER_ERROR_EXPIRED_OTP
```
public static final int SERVER_ERROR_EXPIRED_OTP
```
    The end user enters an expired OTP value.
    Please try again.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - SERVER_ERROR_RETRY_LIMIT_EXCEEDED
```
public static final int SERVER_ERROR_RETRY_LIMIT_EXCEEDED
```
    The authentication has exceeded the number of attempts allowed.
    Please try again.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - SERVER_ERROR
```
public static final int SERVER_ERROR
```
    Represents the server error code between 401 and 599 (exludes 429, 503, and those that has been defined.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - SERVER_ERROR_TOO_MANY_REQUESTS
```
public static final int SERVER_ERROR_TOO_MANY_REQUESTS
```
    Server is unable to process the request as it is overwhelmed by too many requests.
    Please try again.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - SERVER_RETRYABLE
```
public static final int SERVER_RETRYABLE
```
    This error code represents a server error that is retryable because there is a temporary network issue.
    Please try again.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - CRYPTO_ERROR
```
public static final int CRYPTO_ERROR
```
    Issues with the keys generated from Android keystore system.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - INVALID_PARAMETERS
```
public static final int INVALID_PARAMETERS
```
    Some of the configuration parameters such as provisioned tokens are invalid.
    Please try again.
    
    Since:
    
    v1.0.1
    
    See Also:
    
    Constant Field Values
  - INVALID_DEVICE_AUTHENTICATION_PARAM
```
public static final int INVALID_DEVICE_AUTHENTICATION_PARAM
```
    Missing FragmentActivity in the parameter.
    
    Since:
    
    v1.0.1
    
    See Also:
    
    Constant Field Values
  - STORAGE_ERROR
```
public static final int STORAGE_ERROR
```
    The device authentication method is not found in the storage. Check if the token details have selected a valid CVM method.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - TOKEN_NOT_BOUNDED
```
public static final int TOKEN_NOT_BOUNDED
```
    The token provided is not bound with the device.
    Please complete the create binding process.
    
    Since:
    
    v1.0.1
    
    See Also:
    
    Constant Field Values
  - TOKEN_DEVICE_BINDING_PENDING
```
public static final int TOKEN_DEVICE_BINDING_PENDING
```
    The token provided for create binding process is in pending state.
    Please complete the create binding process.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - TOKEN_DEVICE_BINDING_DECLINED
```
public static final int TOKEN_DEVICE_BINDING_DECLINED
```
    The token provided for device binding is declined.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - INVALID_IDV_METHOD
```
public static final int INVALID_IDV_METHOD
```
    The IDV method provided is invalid.
    
    Since:
    
    v1.0.1
    
    See Also:
    
    Constant Field Values
  - ISSUER_AUTHENTICATION_REQUIRED
```
public static final int ISSUER_AUTHENTICATION_REQUIRED
```
    Issuer authentication required.
    Please use IDVSession.selectIdvMethod().
    
    Since:
    
    v1.0.1
    
    See Also:
    
    Constant Field Values
  - INVALID_OTP
```
public static final int INVALID_OTP
```
    The OTP provided is not in the correct format. The OTP should not be null, empty or more than 8 digits.
    
    Since:
    
    v1.0.1
    
    See Also:
    
    Constant Field Values
  - JSON_PARSING_ERROR
```
public static final int JSON_PARSING_ERROR
```
    Error parsing the JSON structure.
    
    Since:
    
    v1.0.1
    
    See Also:
    
    Constant Field Values
  - INVALID_TOKEN_ID
```
public static final int INVALID_TOKEN_ID
```
    The Visa Provisioned Token Id provided is either null or empty.
    
    Since:
    
    v1.0.1
    
    See Also:
    
    Constant Field Values
  - KEYSTORE_ERROR
```
public static final int KEYSTORE_ERROR
```
    Key is permanently invalidated.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - ERROR_DEBUG_SDK_USED
```
public static final int ERROR_DEBUG_SDK_USED
```
    For security reason, Debug SDK variant cannot be used in the released app.
    Please ensure that released app only uses release SDK variant.
    
    Since:
    
    v3.0.0
    
    See Also:
    
    Constant Field Values
  - ATTESTATION_ERROR
```
public static final int ATTESTATION_ERROR
```
    Android attestation issues.
    
    Since:
    
    v3.0.0
    
    See Also:
    
    Constant Field Values
  - TOKEN_ALREADY_BOUNDED
```
public static final int TOKEN_ALREADY_BOUNDED
```
    The token is already bounded or in pending activation.
    
    Since:
    
    v3.0.0
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TMGClientException
```
public TMGClientException(int errorCode,
                          String message)
```
  - TMGClientException
```
public TMGClientException(int errorCode,
                          @NonNull
                          Throwable e)
```
- Method Detail
  - getMessage
```
public String getMessage()
```
    Returns the error message.
    
    Overrides:
    
    getMessage in class Throwable
  - getErrorCode
```
public int getErrorCode()
```
    Returns the error code.

Constructor	Description
`TMGClientException(int errorCode, String message)`
`TMGClientException(int errorCode, Throwable e)`

Modifier and Type	Method	Description
`int`	`getErrorCode()`	Returns the error code.
`String`	`getMessage()`	Returns the error message.

Class TMGClientException

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Field Detail

AUTHENTICATION_FAILURE_CANCEL

DEVICE_AUTHENTICATION_NOT_SUPPORTED

SERVER_IS_NOT_ACCESSIBLE

SERVER_ERROR_CRYPTO_ERROR

SERVER_ERROR_INVALID_TOKEN_STATE

SERVER_ERROR_IDV_NOT_AVAILABLE

SERVER_ERROR_NO_SESSION_FOUND

SERVER_ERROR_WRONG_OTP

SERVER_ERROR_EXPIRED_OTP

SERVER_ERROR_RETRY_LIMIT_EXCEEDED

SERVER_ERROR

SERVER_ERROR_TOO_MANY_REQUESTS

SERVER_RETRYABLE

CRYPTO_ERROR

INVALID_PARAMETERS

INVALID_DEVICE_AUTHENTICATION_PARAM

STORAGE_ERROR

TOKEN_NOT_BOUNDED

TOKEN_DEVICE_BINDING_PENDING

TOKEN_DEVICE_BINDING_DECLINED

INVALID_IDV_METHOD

ISSUER_AUTHENTICATION_REQUIRED

INVALID_OTP

JSON_PARSING_ERROR

INVALID_TOKEN_ID

KEYSTORE_ERROR

ERROR_DEBUG_SDK_USED

ATTESTATION_ERROR

TOKEN_ALREADY_BOUNDED

Constructor Detail

TMGClientException

TMGClientException

Method Detail

getMessage

getErrorCode