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

All Implemented Interfaces:

Serializable
```
public class TMGClientException
extends Exception
```
TMGClientException is generic exception class to handle all TMG SDK errors. TMGClientException provides exceptionType through which called will get exact reason for error

Since:

1.0

Version:

1.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`AUTHENTICATION_FAILURE_CANCEL`	Authentication failure.
`static int`	`CRYPTO_ERROR`	Key issues.
`static int`	`DEVICE_AUTHENTICATION_NOT_SUPPORTED`	Biometric or Keyguard Authentication is not available in the device.
`static int`	`INVALID_AUTHENTICATION_METHOD`	Biometric or Keyguard Authentication is not available in the device.
`static int`	`INVALID_DEVICE_AUTHENTICATION_PARAM`	Missing Fragment Activity on the parameter.
`static int`	`INVALID_IDV_METHOD`	The provided IDV method is invalid.
`static int`	`INVALID_OTP`	The provided otp is in bad format.
`static int`	`INVALID_PARAMETERS`	Some of the configuration parameters, like provisioned token are invalid.
`static int`	`INVALID_TOKEN_ID`	The provided Visa Provisioned Token Id is null or empty.
`static int`	`ISSUER_AUTHENTICATION_REQUIRED`	Issuer authentication required.
`static int`	`JSON_PARSING_ERROR`	Error parsing json.
`static int`	`KEYSTORE_ERROR`	Key permanently invalidated.
`static int`	`SERVER_ERROR`	Represent server error code between 401 to 599 (Not including 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`	OTP has expired.
`static int`	`SERVER_ERROR_IDV_CANCELED`	User canceled the IDV authentication
`static int`	`SERVER_ERROR_IDV_NOT_AVAILABLE`	Selected invalid IDV method.
`static int`	`SERVER_ERROR_INVALID_TOKEN_STATE`	Invalid token state server error.
`static int`	`SERVER_ERROR_NO_SESSION_FOUND`	The session was not found / expired / terminated.
`static int`	`SERVER_ERROR_RETRY_LIMIT_EXCEEDED`	The authentication has exceeded the attempt limit.
`static int`	`SERVER_ERROR_TOO_MANY_REQUESTS`	Server is unable to process request due to too many requests.
`static int`	`SERVER_ERROR_WRONG_OTP`	Invalid OTP value.
`static int`	`SERVER_IS_NOT_ACCESSIBLE`	Connection issues.
`static int`	`SERVER_RETRYABLE`	This error code represent server error that is retryable.
`static int`	`STORAGE_ERROR`	The device authentication method is not found in the storage.
`static int`	`TOKEN_DEVICE_BINDING_DECLINED`	The token device binding declined.
`static int`	`TOKEN_DEVICE_BINDING_PENDING`	The create binding process is still in pending state.
`static int`	`TOKEN_NOT_BOUNDED`	The create binding process is still in pending state.

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 error code

String getMessage()
Returns 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 authentication was canceled. (Keyguard/Biometric).
    
    Since:
    
    v1.0.1
    
    See Also:
    
    Constant Field Values
  - DEVICE_AUTHENTICATION_NOT_SUPPORTED
```
public static final int DEVICE_AUTHENTICATION_NOT_SUPPORTED
```
    Biometric or Keyguard Authentication is not available in the device.
    Please setup on the Android Settings.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - INVALID_AUTHENTICATION_METHOD
```
public static final int INVALID_AUTHENTICATION_METHOD
```
    Biometric or Keyguard Authentication is not available in the device.
    Please setup on the Android Settings.
    
    Since:
    
    v1.0.1
    
    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 server error.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - SERVER_ERROR_IDV_NOT_AVAILABLE
```
public static final int SERVER_ERROR_IDV_NOT_AVAILABLE
```
    Selected 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 / 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
```
    Invalid 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
```
    OTP has expired.
    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 attempt limit.
    Please try again.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - SERVER_ERROR
```
public static final int SERVER_ERROR
```
    Represent server error code between 401 to 599 (Not including 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 request due to 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 represent server error that is retryable.
    Please try again.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - CRYPTO_ERROR
```
public static final int CRYPTO_ERROR
```
    Key issues.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - INVALID_PARAMETERS
```
public static final int INVALID_PARAMETERS
```
    Some of the configuration parameters, like provisioned token 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 Fragment Activity on 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 for valid CVM method by checking if token details has selected CVM method.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - TOKEN_NOT_BOUNDED
```
public static final int TOKEN_NOT_BOUNDED
```
    The create binding process is still in pending state.
    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 create binding process is still 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 device binding declined.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - INVALID_IDV_METHOD
```
public static final int INVALID_IDV_METHOD
```
    The provided IDV method 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 PendingBindingSession.submitIdvMethod().
    
    Since:
    
    v1.0.1
    
    See Also:
    
    Constant Field Values
  - INVALID_OTP
```
public static final int INVALID_OTP
```
    The provided otp is in bad 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 json.
    
    Since:
    
    v1.0.1
    
    See Also:
    
    Constant Field Values
  - INVALID_TOKEN_ID
```
public static final int INVALID_TOKEN_ID
```
    The provided Visa Provisioned Token Id is null or empty.
    
    Since:
    
    v1.0.1
    
    See Also:
    
    Constant Field Values
  - KEYSTORE_ERROR
```
public static final int KEYSTORE_ERROR
```
    Key permanently invalidated.
    
    Since:
    
    v1.0.2
    
    See Also:
    
    Constant Field Values
  - SERVER_ERROR_IDV_CANCELED
```
public static final int SERVER_ERROR_IDV_CANCELED
```
    User canceled the IDV authentication
    Please select another IDV method.
    
    Since:
    
    v1.1.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 error message
    
    Overrides:
    
    getMessage in class Throwable
  - getErrorCode
```
public int getErrorCode()
```
    Returns error code

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

Modifier and Type	Method	Description
`int`	`getErrorCode()`	Returns error code
`String`	`getMessage()`	Returns 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

INVALID_AUTHENTICATION_METHOD

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

SERVER_ERROR_IDV_CANCELED

Constructor Detail

TMGClientException

TMGClientException

Method Detail

getMessage

getErrorCode