Package com.gemalto.mfs.mwsdk.mobilegateway

Interface MGCardLifeCycleManager

  • public interface MGCardLifeCycleManager
    The card life cycle manager component as what the name suggests manages the life cycle (e.g. suspend, resume, delete) of a digitized card. All events will be dispatched via a listener. After successful request, the CPS will send a command to the CPS SDK to fulfill the request.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void deleteCard​(java.lang.String digitalCardId, MGCardLifecycleEventListener mgCardLifecycleEventListener)
      An asynchronous method to DELETE the digitized card.
      java.lang.String deleteCard​(java.lang.String digitalCardId, MGCardLifecycleEventListener mgCardLifecycleEventListener, java.lang.String issuerID, java.util.List<KeyValues> keyValueList)
      An asynchronous method to DELETE the digitized card.
      java.lang.String deleteCard​(java.lang.String digitalCardId, MGCardLifecycleEventListener mgCardLifecycleEventListener, java.lang.String issuerID, java.util.List<KeyValues> keyValueList, java.lang.String accessToken)
      An asynchronous method to DELETE the digitized card.
      void resumeCard​(java.lang.String digitalCardId, MGCardLifecycleEventListener mgCardLifecycleEventListener)
      An asynchronous method to RESUME the digitized card.
      java.lang.String resumeCard​(java.lang.String digitalCardId, MGCardLifecycleEventListener mgCardLifecycleEventListener, java.lang.String issuerID, java.util.List<KeyValues> keyValueList)
      An asynchronous method to RESUME the digitized card.
      java.lang.String resumeCard​(java.lang.String digitalCardId, MGCardLifecycleEventListener mgCardLifecycleEventListener, java.lang.String issuerID, java.util.List<KeyValues> keyValueList, java.lang.String accessToken)
      An asynchronous method to RESUME the digitized card.
      void suspendCard​(java.lang.String digitalCardId, MGCardLifecycleEventListener mgCardLifecycleEventListener)
      An asynchronous method to SUSPEND the digitized card.
      java.lang.String suspendCard​(java.lang.String digitalCardId, MGCardLifecycleEventListener mgCardLifecycleEventListener, java.lang.String issuerID, java.util.List<KeyValues> keyValueList)
      An asynchronous method to SUSPEND the digitized card.
      java.lang.String suspendCard​(java.lang.String digitalCardId, MGCardLifecycleEventListener mgCardLifecycleEventListener, java.lang.String issuerID, java.util.List<KeyValues> keyValueList, java.lang.String accessToken)
      An asynchronous method to SUSPEND the digitized card.
      java.lang.String updateCard​(java.lang.String digitalCardId, MGCardLifecycleEventListener mgCardLifecycleEventListener, java.lang.String issuerID, byte[] authenticationToken, java.util.List<KeyValues> keyValueList)
      An asynchronous method to UPDATE the digitized card.
      java.lang.String updateCard​(java.lang.String digitalCardId, MGCardLifecycleEventListener mgCardLifecycleEventListener, java.lang.String issuerID, byte[] authenticationToken, java.util.List<KeyValues> keyValueList, java.lang.String accessToken)
      An asynchronous method to UPDATE the digitized card.

    • Method Detail

      • suspendCard

        void suspendCard​(java.lang.String digitalCardId,
                 MGCardLifecycleEventListener mgCardLifecycleEventListener)
        An asynchronous method to SUSPEND the digitized card.
        Parameters:
        digitalCardId - the unique digitalCardId of the card.
        Digitized card ID shared by the HCE platform components (Different than token ID)
        mgCardLifecycleEventListener - listener to the card lifecycle events.

      • suspendCard

        java.lang.String suspendCard​(java.lang.String digitalCardId,
                             MGCardLifecycleEventListener mgCardLifecycleEventListener,
                             java.lang.String issuerID,
                             java.util.List<KeyValues> keyValueList)
        An asynchronous method to SUSPEND the digitized card.
        Parameters:
        digitalCardId - the unique digitalCardId of the card.
        Digitized card ID shared by the HCE platform components (Different than token ID)
        mgCardLifecycleEventListener - listener to the card lifecycle events.
        issuerID - Unique identifier of the issuer, provided if the MPA has this value.
        keyValueList - the list of keyValuesObject
        Returns:
        the String of correlationId
        Since:
        2.3

      • suspendCard

        java.lang.String suspendCard​(java.lang.String digitalCardId,
                             MGCardLifecycleEventListener mgCardLifecycleEventListener,
                             java.lang.String issuerID,
                             java.util.List<KeyValues> keyValueList,
                             java.lang.String accessToken)
        An asynchronous method to SUSPEND the digitized card.
        Parameters:
        digitalCardId - the unique digitalCardId of the card.
        Digitized card ID shared by the HCE platform components (Different than token ID)
        mgCardLifecycleEventListener - listener to the card lifecycle events.
        issuerID - Unique identifier of the issuer, provided if the MPA has this value.
        keyValueList - the list of keyValuesObject
        accessToken - Access token to authorize the MPA request.
        Returns:
        the String of correlationId
        Since:
        4.1

      • resumeCard

        void resumeCard​(java.lang.String digitalCardId,
                MGCardLifecycleEventListener mgCardLifecycleEventListener)
        An asynchronous method to RESUME the digitized card.
        Parameters:
        digitalCardId - the unique digitalCardId of the card.
        Digitized card ID shared by the HCE platform components (Different than token ID)
        mgCardLifecycleEventListener - listener to the card lifecycle events.

      • resumeCard

        java.lang.String resumeCard​(java.lang.String digitalCardId,
                            MGCardLifecycleEventListener mgCardLifecycleEventListener,
                            java.lang.String issuerID,
                            java.util.List<KeyValues> keyValueList)
        An asynchronous method to RESUME the digitized card.
        Parameters:
        digitalCardId - the unique digitalCardId of the card.
        Digitized card ID shared by the HCE platform components (Different than token ID)
        mgCardLifecycleEventListener - listener to the card lifecycle events.
        issuerID - Unique identifier of the issuer, provided if the MPA has this value.
        keyValueList - the list of keyValuesObject
        Returns:
        the String of correlationId
        Since:
        2.3

      • resumeCard

        java.lang.String resumeCard​(java.lang.String digitalCardId,
                            MGCardLifecycleEventListener mgCardLifecycleEventListener,
                            java.lang.String issuerID,
                            java.util.List<KeyValues> keyValueList,
                            java.lang.String accessToken)
        An asynchronous method to RESUME the digitized card.
        Parameters:
        digitalCardId - the unique digitalCardId of the card.
        Digitized card ID shared by the HCE platform components (Different than token ID)
        mgCardLifecycleEventListener - listener to the card lifecycle events.
        issuerID - Unique identifier of the issuer, provided if the MPA has this value.
        keyValueList - the list of keyValuesObject
        accessToken - Access token to authorize the MPA request.
        Returns:
        the String of correlationId
        Since:
        4.1

      • deleteCard

        void deleteCard​(java.lang.String digitalCardId,
                MGCardLifecycleEventListener mgCardLifecycleEventListener)
        An asynchronous method to DELETE the digitized card.
        Parameters:
        digitalCardId - the unique digitalCardId of the card.
        Digitized card ID shared by the HCE platform components (Different than token ID)
        mgCardLifecycleEventListener - listener to the card lifecycle events.

      • deleteCard

        java.lang.String deleteCard​(java.lang.String digitalCardId,
                            MGCardLifecycleEventListener mgCardLifecycleEventListener,
                            java.lang.String issuerID,
                            java.util.List<KeyValues> keyValueList)
        An asynchronous method to DELETE the digitized card.
        Parameters:
        digitalCardId - the unique digitalCardId of the card.
        Digitized card ID shared by the HCE platform components (Different than token ID)
        mgCardLifecycleEventListener - listener to the card lifecycle events.
        issuerID - Unique identifier of the issuer, provided if the MPA has this value.
        keyValueList - the list of keyValuesObject
        Returns:
        the String of correlationId
        Since:
        2.3

      • deleteCard

        java.lang.String deleteCard​(java.lang.String digitalCardId,
                            MGCardLifecycleEventListener mgCardLifecycleEventListener,
                            java.lang.String issuerID,
                            java.util.List<KeyValues> keyValueList,
                            java.lang.String accessToken)
        An asynchronous method to DELETE the digitized card.
        Parameters:
        digitalCardId - the unique digitalCardId of the card.
        Digitized card ID shared by the HCE platform components (Different than token ID)
        mgCardLifecycleEventListener - listener to the card lifecycle events.
        issuerID - Unique identifier of the issuer, provided if the MPA has this value.
        keyValueList - the list of keyValuesObject
        accessToken - Access token to authorize the MPA request.
        Returns:
        the String of correlationId
        Since:
        4.1

      • updateCard

        java.lang.String updateCard​(java.lang.String digitalCardId,
                            MGCardLifecycleEventListener mgCardLifecycleEventListener,
                            java.lang.String issuerID,
                            byte[] authenticationToken,
                            java.util.List<KeyValues> keyValueList)
        An asynchronous method to UPDATE the digitized card.
        Parameters:
        digitalCardId - the unique digitalCardId of the card.
        Digitized card ID shared by the HCE platform components (Different than token ID)
        mgCardLifecycleEventListener - listener to the card lifecycle events.
        issuerID - Unique identifier of the issuer, provided if the MPA has this value.
        authenticationToken - Token computed by the Issuer that has authenticated the end user, provided if the MPA has this value.
        keyValueList - the list of keyValuesObject
        Returns:
        the String of correlationId
        Since:
        2.3

      • updateCard

        java.lang.String updateCard​(java.lang.String digitalCardId,
                            MGCardLifecycleEventListener mgCardLifecycleEventListener,
                            java.lang.String issuerID,
                            byte[] authenticationToken,
                            java.util.List<KeyValues> keyValueList,
                            java.lang.String accessToken)
        An asynchronous method to UPDATE the digitized card.
        Parameters:
        digitalCardId - the unique digitalCardId of the card.
        Digitized card ID shared by the HCE platform components (Different than token ID)
        mgCardLifecycleEventListener - listener to the card lifecycle events.
        issuerID - Unique identifier of the issuer, provided if the MPA has this value.
        authenticationToken - Token computed by the Issuer that has authenticated the end user, provided if the MPA has this value.
        keyValueList - the list of keyValuesObject
        accessToken - Access token to authorize the MPA request.
        Returns:
        the String of correlationId
        Since:
        4.1