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

Class WalletSecureEnrollmentError

  • public class WalletSecureEnrollmentError
extends java.lang.Object
    Errors pertaining to renewing 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 renewing error.

    • Field Detail

      • CPS_ERROR_CODE_DEFAULT

        public static final int CPS_ERROR_CODE_DEFAULT
        Default error code
        See Also:
        Constant Field Values

      • HTTP_STATUS_CODE_DEFAULT

        public static final int HTTP_STATUS_CODE_DEFAULT
        See Also:
        Constant Field Values

      • HTTP_STATUS_CODE_NO_INTERNET

        public static final int HTTP_STATUS_CODE_NO_INTERNET
        See Also:
        Constant Field Values

    • Constructor Detail

      • WalletSecureEnrollmentError

        public WalletSecureEnrollmentError​(WalletSecureEnrollmentErrorCodes sdkErrorCodes,
                                   int httpStatusCode,
                                   int cpsErrorCode,
                                   java.lang.String errorMessage,
                                   java.util.Map<java.lang.String,​java.lang.String> statusAdditionInfo)
        Constructor to create object of WalletSecureEnrollmentError.
        Parameters:
        sdkErrorCodes - error code as defined in WalletSecureEnrollmentErrorCodes
        httpStatusCode - the http status code
        cpsErrorCode - error code as defined in KnownCpsErrorCodes
        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.

      • WalletSecureEnrollmentError

        public WalletSecureEnrollmentError​(WalletSecureEnrollmentErrorCodes sdkErrorCodes,
                                   int httpStatusCode,
                                   int cpsErrorCode,
                                   java.lang.String errorMessage,
                                   java.lang.Throwable causingException,
                                   java.util.Map<java.lang.String,​java.lang.String> statusAdditionInfo)
        Constructor to create object of WalletSecureEnrollmentError.
        Parameters:
        sdkErrorCodes - error code as defined in WalletSecureEnrollmentErrorCodes
        httpStatusCode - the http status code
        cpsErrorCode - error code as defined in KnownCpsErrorCodes
        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 Detail

      • getSdkErrorCode

        public WalletSecureEnrollmentErrorCodes 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 renewing error.
        Returns:
        an error code of type WalletSecureEnrollmentErrorCodes

      • 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

      • getErrorMessage

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

      • getStatusAdditionalInfo

        public java.util.Map<java.lang.String,​java.lang.String> getStatusAdditionalInfo()
        This is returned by the CPS on a failed processing of a request. This hash map 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 java.lang.Throwable getCausingException()
        This methods returns the exception object that is responsible for the underlying issue. It can be null.
        Returns:
        throwable