Package com.thalesgroup.gemalto.d1

Class D1Exception

java.lang.Object
java.lang.Throwable
java.lang.Exception
com.thalesgroup.gemalto.d1.D1Exception
All Implemented Interfaces:
Serializable
public final class D1Exception extends Exception
The D1 exception.

When an error occurs and support is required, it is recommended to include getErrorCode() as well as the stack trace of error in the report.

Since:
1.0.0
See Also:

  • Constructor Details

    • D1Exception

      public D1Exception(@NonNull D1Exception.ErrorCode errorCode)
      Constructs a D1Exception with the specific error code.
      Parameters:
      errorCode - The error code of this exception.

    • D1Exception

      public D1Exception(@NonNull D1Exception.ErrorCode errorCode, @NonNull Throwable cause)
      Constructs a D1Exception with an error code and the cause.
      Parameters:
      errorCode - The error code.
      cause - The cause.

    • D1Exception

      public D1Exception(@NonNull D1Exception.ErrorCode errorCode, @NonNull Throwable cause, int causeErrorCode, String causeErrorMessage)
      Constructs a D1Exception with the error code, cause and the cause's error code.
      Parameters:
      errorCode - The D1 error code.
      cause - The cause of the exception.
      causeErrorCode - The error code of the cause.
      causeErrorMessage - The error message of the cause.

    • D1Exception

      public D1Exception(@NonNull D1Exception.ErrorCode errorCode, int causeErrorCode, String causeErrorMessage)
      Constructs a D1Exception with the error code, the cause's error code and message.
      Parameters:
      errorCode - The D1 error code.
      causeErrorCode - The error code of the cause.
      causeErrorMessage - The error message of the cause.

    • D1Exception

      @RestrictTo(LIBRARY_GROUP) public D1Exception(@NonNull D1Exception.ErrorCode errorCode, int causeErrorCode, String causeErrorMessage, @Nullable Object additionalData)
      Constructs a D1Exception with optional SDK-specific structured data.

      This constructor is reserved for use by D1 SDK internals. Integrators should consume the data through getAdditionalData().

    • D1Exception

      public D1Exception(@NonNull D1Exception.ErrorCode errorCode, @NonNull Throwable cause, int causeErrorCode)
      Constructs a D1Exception with the error code, cause and the cause's error code.
      Parameters:
      errorCode - The D1 error code.
      cause - The cause of the exception.
      causeErrorCode - The error code of the cause.

  • Method Details

    • getMessage

      public String getMessage()
      Retrieves the underlying error name, error code, cause error code and cause error message. The error message is in <D1ErrorName> [<D1-ErrorCode>] (<CauseErrorCode>) <CauseErrorMessage> format where (CauseErrorCode) and <CauseErrorMessage> are optional.
      Overrides:
      getMessage in class Throwable
      Returns:
      the formatted error message.
      Since:
      3.4.0

    • getErrorCode

      @NonNull public D1Exception.ErrorCode getErrorCode()
      Retrieves the D1Exception.ErrorCode of this exception.
      Returns:
      The D1Exception.ErrorCode.

    • getAdditionalData

      @Nullable public Object getAdditionalData()
      Returns optional structured diagnostic data supplied by the SDK.

      For Google Pay UPP errors this may be a GoogleCardSavedStatusResult when Google returned card-saved status information.

      Returns:
      additional data, or null when unavailable
      Since:
      4.4.0