Package com.gemalto.mfs.mwsdk.provisioning.model

Class ProvisioningServiceError

java.lang.Object
com.gemalto.mfs.mwsdk.provisioning.model.ProvisioningServiceError
public class ProvisioningServiceError extends Object
Errors pertaining to provisioning may have different causes. In some cases, the errors are linked to the HTTP protocol, others errors are handled and observed within the SDK such as having invalid credentials, while with other errors are linked to the CPS. This class allows the mobile wallet to understand the root cause of a provisioning error.

  • Field Details

    • CPS_ERROR_CODE_DEFAULT

      public static final int CPS_ERROR_CODE_DEFAULT
      Default error code
      See Also:

    • HTTP_STATUS_CODE_DEFAULT

      public static final int HTTP_STATUS_CODE_DEFAULT
      See Also:

    • HTTP_STATUS_CODE_NO_INTERNET

      public static final int HTTP_STATUS_CODE_NO_INTERNET
      See Also:

    • HTTP_STATUS_TIMEOUT

      public static final int HTTP_STATUS_TIMEOUT
      See Also:

    • RAGES_INTERNAL_ERROR

      public static final int RAGES_INTERNAL_ERROR
      See Also:

    • REPERSO_TIMEOUT_ERROR

      public static final int REPERSO_TIMEOUT_ERROR
      See Also:

    • RAGES_COMMON_NO_INTERNET

      public static final int RAGES_COMMON_NO_INTERNET
      See Also:

    • RAGES_CONNECTION_ERROR

      public static final int RAGES_CONNECTION_ERROR
      See Also:

    • RAGES_SERVER_ERROR

      public static final int RAGES_SERVER_ERROR
      See Also:

    • RAGES_INVALID_JSON_FORMAT_ERROR

      public static final int RAGES_INVALID_JSON_FORMAT_ERROR
      See Also:

    • RAGES_STORAGE_ERROR

      public static final int RAGES_STORAGE_ERROR
      See Also:

    • RAGES_USER_NOT_ENROLLED

      public static final int RAGES_USER_NOT_ENROLLED
      See Also:

    • RAGES_CRYPTO_ERROR

      public static final int RAGES_CRYPTO_ERROR
      See Also:

  • Constructor Details

    • ProvisioningServiceError

      public ProvisioningServiceError(ProvisioningServiceErrorCodes sdkErrorCodes, int httpStatusCode, int cpsErrorCode, String tokenId, String errorMessage, Map<String,String> statusAdditionInfo)
      Constructor to create object of ProvisioningServiceError.
      Parameters:
      sdkErrorCodes - error code as defined in ProvisioningServiceErrorCodes
      httpStatusCode - the http status code
      cpsErrorCode - error code as defined in KnownCpsErrorCodes
      tokenId - the tokenized card id if the error can be associated to a digitalized card. If not, this is null.
      errorMessage - string describing the error that occurred
      statusAdditionInfo - This is an optional field, which will contain complimentary information on the error that occurred. This value is provided by the CPS. For example, for a wrong activation code input, this HashMap will contain a key called "remainingTries" which will indicate the total number of tries that the end user has to correctly enter the activation code.

    • ProvisioningServiceError

      public ProvisioningServiceError(ProvisioningServiceErrorCodes sdkErrorCodes, int httpStatusCode, int cpsErrorCode, String tokenId, String errorMessage, Throwable causingException, Map<String,String> statusAdditionInfo, ProvisioningServiceError lastError)
      Constructor to create object of ProvisioningServiceError.
      Parameters:
      sdkErrorCodes - error code as defined in ProvisioningServiceErrorCodes
      httpStatusCode - the http status code
      cpsErrorCode - error code as defined in KnownCpsErrorCodes
      tokenId - the tokenized card id if the error can be associated to a digitalized card. If not, this is null.
      errorMessage - string describing the error that occurred
      causingException - causing Exception for the error
      statusAdditionInfo - This is an optional field, which will contain complimentary information on the error that occurred. This value is provided by the CPS. For example, for a wrong activation code input, this HashMap will contain a key called "remainingTries" which will indicate the total number of tries that the end user has to correctly enter the activation code.
      lastError - Previous ProvisioningServiceError before the current error if multiple errors during the request.

    • ProvisioningServiceError

      public ProvisioningServiceError(ProvisioningServiceErrorCodes sdkErrorCodes, int httpStatusCode, int cpsErrorCode, String tokenId, String errorMessage, Throwable causingException, Map<String,String> statusAdditionInfo)
      Constructor to create object of ProvisioningServiceError.
      Parameters:
      sdkErrorCodes - error code as defined in ProvisioningServiceErrorCodes
      httpStatusCode - the http status code
      cpsErrorCode - error code as defined in KnownCpsErrorCodes
      tokenId - the tokenized card id if the error can be associated to a digitalized card. If not, this is null.
      errorMessage - string describing the error that occurred
      causingException - * causing Exception for the error
      statusAdditionInfo - This is an optional field, which will contain complimentary information on the error that occurred. This value is provided by the CPS. For example, for a wrong activation code input, this HashMap will contain a key called "remainingTries" which will indicate the total number of tries that the end user has to correctly enter the activation code.

  • Method Details

    • getSdkErrorCode

      public ProvisioningServiceErrorCodes getSdkErrorCode()
      Returns a code that can be associated with an error understood by the SDK. It is through this error code which will help the mobile wallet understand the root cause of the provisioning error.
      Returns:
      an error code of type ProvisioningServiceErrorCodes

    • getHttpStatusCode

      public int getHttpStatusCode()
      Returns the http status code.
      Returns:
      an int representation of the http status code.

    • getCpsErrorCode

      public int getCpsErrorCode()
      Returns CPS error code.
      Returns:
      returns an error code of type KnownCpsErrorCodes

    • getTokenId

      public String getTokenId()
      Returns the string representation of the card token id if the error is related to a given card. Otherwise, this is null.
      Returns:
      The token id of the card, if any. Otherwise, this returns null.

    • getErrorMessage

      public String getErrorMessage()
      Returns the error message either from CPS or SDK.
      Returns:
      String - error message recieved from server

    • getStatusAdditionalInfo

      public Map<String,String> getStatusAdditionalInfo()
      This is returned by the CPS on a failed processing of a request. This hashmap is optional. If available, this will contain a list of key-value pairs which is expected to compliment the error from the CPS.
      Returns:
      Map containing additional information on the error that has occurred. This is taken from the CPS response.

    • getCausingException

      public Throwable getCausingException()
      This methods returns the exception object that is responsible for the underlying issue. It can be null.
      Returns:
      the throwable

    • getLastError

      @Nullable public ProvisioningServiceError getLastError()
      Return the last error if multiple errors during the API call. Errors will be chained in this object. Return null if there is no more other error. This is mainly used for the API call ProvisioningBusinessService.processIncomingMessage(Bundle, PushServiceListener) where it could process multiple commands one after another.
      Returns:
      the previous provisioningError object
      Since:
      6.7.0