Package com.pingidentity.sdk.pingonewallet.client

Class PingOneWalletClient

java.lang.Object
com.pingidentity.sdk.pingonewallet.client.PingOneWalletClient
All Implemented Interfaces:
com.pingidentity.did.sdk.client.LinkHandler, com.pingidentity.sdk.pingonewallet.client.DidMessageListener, com.pingidentity.sdk.pingonewallet.contracts.PingOneWalletClientContract
public class PingOneWalletClient extends Object implements com.pingidentity.sdk.pingonewallet.contracts.PingOneWalletClientContract, com.pingidentity.sdk.pingonewallet.client.DidMessageListener, com.pingidentity.did.sdk.client.LinkHandler
Client class to interact with Credentials and manage Wallet

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    PingOneWalletClient.Builder
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    TAG
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    checkForMessages()
    Call this method to check if wallet has received any new messages in the mailbox.
    io.reactivex.rxjava3.core.Single<com.pingidentity.did.sdk.types.Claim>
    createSelfClaim(Map<String,String> map, com.pingidentity.did.sdk.client.service.model.ApplicationInstance applicationInstance)
    Call this method to create a map of self attested claims
    PresentationMatcherResult
    findMatchingCredentialsForRequest(PresentationRequest request, List<com.pingidentity.did.sdk.types.Claim> credentials)
    Call this method to filter the verifiable credentials that match the schema defined in the input descriptor in the presentation request.
    com.pingidentity.did.sdk.client.service.model.ApplicationInstance
    getApplicationInstance(PingOneRegion walletRegion)
    Returns ApplicationInstance used to register the wallet in PingOneRegion
    DataRepository
    getDataRepository()
    Call this method to get the DataRepository that is used by the SDK to store credentials and other information.
    PingOneRegion
    getRegionForApplicationInstance(com.pingidentity.did.sdk.client.service.model.ApplicationInstance applicationInstance)
     
    StorageManagerContract
    getStorageManager()
    Call this method to get the StorageManagerContract that is used by the SDK to store credentials and other information.
    void
    handleClaim(UUID sender, String message, com.pingidentity.did.sdk.client.service.model.Challenge challenge, com.pingidentity.did.sdk.types.Claim claim, List<com.pingidentity.did.sdk.exception.DidException> errors, com.pingidentity.did.sdk.client.service.model.ApplicationInstance applicationInstance)
     
    void
    handleError(Exception e, com.pingidentity.did.sdk.client.service.model.ApplicationInstance appInstance)
     
    void
    handleException(com.pingidentity.did.sdk.exception.DidException error, com.pingidentity.did.sdk.client.service.model.ApplicationInstance appInstance)
     
    void
    handleExpiredClaim(UUID sender, String message, com.pingidentity.did.sdk.client.service.model.Challenge challenge, com.pingidentity.did.sdk.types.ClaimReference claimReference, List<com.pingidentity.did.sdk.exception.DidException> errors, com.pingidentity.did.sdk.client.service.model.ApplicationInstance applicationInstance)
     
    void
    handleOpenID4VerifiablePresentationRequest(com.pingidentity.did.sdk.w3c.verifiableCredential.VerifiablePresentationRequest request, com.pingidentity.did.sdk.client.OpenIDVerifiableCredentialsClient openIDVerifiableCredentialsClient)
     
    void
    handleRequest(com.pingidentity.did.sdk.types.Request request, com.pingidentity.did.sdk.client.service.model.ApplicationInstance appInstance)
     
    void
    handleSecureMessage(UUID senderId, String message, com.pingidentity.did.sdk.client.service.model.Challenge challenge, com.pingidentity.did.sdk.client.service.model.ApplicationInstance appInstance)
     
    void
    handleShare(UUID senderId, String message, com.pingidentity.did.sdk.client.service.model.Challenge challenge, List<com.pingidentity.did.sdk.types.Share> shares, List<com.pingidentity.did.sdk.exception.DidException> errors, com.pingidentity.did.sdk.client.service.model.ApplicationInstance appInstance)
     
    void
    handleShareRequest(UUID senderId, String message, com.pingidentity.did.sdk.client.service.model.Challenge challenge, List<String> shares, com.pingidentity.did.sdk.client.service.model.ApplicationInstance appInstance)
     
    void
    handleWalletError(com.pingidentity.sdk.pingonewallet.errors.WalletException err)
     
    void
    handleWalletMessage(String sender, String message, com.pingidentity.did.sdk.client.service.model.Challenge challenge, com.pingidentity.did.sdk.client.service.model.ApplicationInstance applicationInstance)
     
    com.pingidentity.did.sdk.client.service.model.ApplicationInstance
    pairWallet(PairingRequest pairingRequest, String pushToken)
    Call this function to pair your wallet app for future issuance and receive credential updates
    com.pingidentity.did.sdk.client.service.model.ApplicationInstance
    pairWallet(PresentationRequest presentationRequest, String pushToken)
    Call this function to pair your wallet app for future issuance and receive credential updates
    void
    pollForMessages()
    Helper method to start polling for new messages sent to the wallet.
    io.reactivex.rxjava3.core.Single<PresentationResult>
    presentCredentials(CredentialsPresentation presentation)
    Call this method to share the presentation with the requester
    boolean
    processNotification(Map<Object,Object> userInfo)
    Forward content from push notifications payload for processing.
    void
    processPingOneRequest(PingOneRegion region, String request)
     
    void
    processPingOneRequest(String qrContent)
    Forward content from QR codes and universal links for processing.
    void
    processQrContent(String qrContent)
    Deprecated.
    This method is deprecated and will be removed in upcoming updates.
    void
    registerCallbackHandler(WalletCallbackHandler callbackHandler)
    Call this method to register a callback handler to listen for wallet actions
    void
    registerStorageManager(StorageManagerContract storageManager)
    Call this method to register the optional storage manager that can be used by the SDK to maintain the values for claims and other data.
    void
    reportCredentialDeletion(com.pingidentity.did.sdk.types.Claim claim)
    Call this method when a credential is deleted from the Wallet.
    static void
    setApplicationInstanceFor(PingOneRegion walletRegion, com.pingidentity.did.sdk.client.service.model.ApplicationInstance applicationInstance)
     
    void
    stopPolling()
    Call this method to stop polling for messages sent to the wallet
    com.pingidentity.did.sdk.client.service.model.ApplicationInstance
    updatePushToken(String pushToken)
    Deprecated.
    This method is deprecated and will be removed in upcoming updates.
    List<com.pingidentity.did.sdk.client.service.model.ApplicationInstance>
    updatePushTokens(String pushToken)
    Update Firebase token to receive notification from the service

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.pingidentity.did.sdk.client.LinkHandler

    handleError, handleRequest

  • Field Details

    • TAG

      public static final String TAG

  • Method Details

    • setApplicationInstanceFor

      public static void setApplicationInstanceFor(PingOneRegion walletRegion, com.pingidentity.did.sdk.client.service.model.ApplicationInstance applicationInstance)

    • registerStorageManager

      public void registerStorageManager(@NonNull StorageManagerContract storageManager)
      Call this method to register the optional storage manager that can be used by the SDK to maintain the values for claims and other data.
      Specified by:
      registerStorageManager in interface com.pingidentity.sdk.pingonewallet.contracts.PingOneWalletClientContract
      Parameters:
      storageManager - Implementation of StorageManagerContract interface
      See Also:

    • getStorageManager

      public StorageManagerContract getStorageManager()
      Call this method to get the StorageManagerContract that is used by the SDK to store credentials and other information.
      Specified by:
      getStorageManager in interface com.pingidentity.sdk.pingonewallet.contracts.PingOneWalletClientContract
      Returns:
      Registered instance of StorageManagerContract interface implementation

    • getDataRepository

      public DataRepository getDataRepository()
      Call this method to get the DataRepository that is used by the SDK to store credentials and other information.
      Specified by:
      getDataRepository in interface com.pingidentity.sdk.pingonewallet.contracts.PingOneWalletClientContract
      Returns:
      An instance of DataRepository using the registered StorageManagerContract

    • registerCallbackHandler

      public void registerCallbackHandler(@NonNull WalletCallbackHandler callbackHandler)
      Call this method to register a callback handler to listen for wallet actions
      Specified by:
      registerCallbackHandler in interface com.pingidentity.sdk.pingonewallet.contracts.PingOneWalletClientContract
      Parameters:
      callbackHandler - Instance of WalletCallbackHandler to handle important events such as credential issuance/revocation etc.

    • getApplicationInstance

      public com.pingidentity.did.sdk.client.service.model.ApplicationInstance getApplicationInstance(PingOneRegion walletRegion)
      Returns ApplicationInstance used to register the wallet in PingOneRegion
      Parameters:
      walletRegion - : PingOneRegion
      Returns:
      ApplicationInstance containing keys and ID for the SDK instance for the PingOneRegion

    • getRegionForApplicationInstance

      public PingOneRegion getRegionForApplicationInstance(com.pingidentity.did.sdk.client.service.model.ApplicationInstance applicationInstance)

    • pairWallet

      public com.pingidentity.did.sdk.client.service.model.ApplicationInstance pairWallet(@NonNull PairingRequest pairingRequest, @Nullable String pushToken) throws com.pingidentity.sdk.pingonewallet.errors.WalletException
      Call this function to pair your wallet app for future issuance and receive credential updates
      Specified by:
      pairWallet in interface com.pingidentity.sdk.pingonewallet.contracts.PingOneWalletClientContract
      Parameters:
      pairingRequest - : PairingRequest from service for wallet pairing containing the issuer ID and optional challenge required for pairing
      pushToken - : Optional push token
      Returns:
      Returns the ApplicationInstance registered for pairing
      Throws:
      com.pingidentity.sdk.pingonewallet.errors.WalletException - if pairing is unsuccessful

    • pairWallet

      public com.pingidentity.did.sdk.client.service.model.ApplicationInstance pairWallet(@NonNull PresentationRequest presentationRequest, @Nullable String pushToken) throws com.pingidentity.sdk.pingonewallet.errors.WalletException
      Call this function to pair your wallet app for future issuance and receive credential updates
      Specified by:
      pairWallet in interface com.pingidentity.sdk.pingonewallet.contracts.PingOneWalletClientContract
      Parameters:
      presentationRequest - : Request from service for wallet pairing containing the issuer ID and session id required for pairing
      pushToken - : Optional push token
      Returns:
      Returns the ApplicationInstance registered for pairing
      Throws:
      com.pingidentity.sdk.pingonewallet.errors.WalletException - if pairing is unsuccessful

    • updatePushToken

      @Deprecated public com.pingidentity.did.sdk.client.service.model.ApplicationInstance updatePushToken(@NonNull String pushToken)
      Deprecated.
      This method is deprecated and will be removed in upcoming updates.
      Description copied from interface: com.pingidentity.sdk.pingonewallet.contracts.PingOneWalletClientContract
      Update firebase push token to receive notifications from the service
      Specified by:
      updatePushToken in interface com.pingidentity.sdk.pingonewallet.contracts.PingOneWalletClientContract
      Parameters:
      pushToken - Firebase Push Token
      Returns:
      ApplicationInstance Updated application instance for storage

    • updatePushTokens

      public List<com.pingidentity.did.sdk.client.service.model.ApplicationInstance> updatePushTokens(String pushToken)
      Update Firebase token to receive notification from the service
      Specified by:
      updatePushTokens in interface com.pingidentity.sdk.pingonewallet.contracts.PingOneWalletClientContract
      Parameters:
      pushToken - Firebase Push Token
      Returns:
      Updated ApplicationInstance objects

    • processQrContent

      @Deprecated public void processQrContent(@NonNull String qrContent)
      Deprecated.
      This method is deprecated and will be removed in upcoming updates. Use processPingOneRequest instead
      Handle URL for issuance or presentation
      Specified by:
      processQrContent in interface com.pingidentity.sdk.pingonewallet.contracts.PingOneWalletClientContract
      Parameters:
      qrContent - Raw content from the QR code

    • processPingOneRequest

      public void processPingOneRequest(@NonNull String qrContent)
      Forward content from QR codes and universal links for processing. Make sure to register the callbackhandler beforehand to receive the result.
      Specified by:
      processPingOneRequest in interface com.pingidentity.sdk.pingonewallet.contracts.PingOneWalletClientContract
      Parameters:
      qrContent - : Raw content from the QR code

    • processPingOneRequest

      public void processPingOneRequest(PingOneRegion region, @NonNull String request)

    • processNotification

      public boolean processNotification(Map<Object,Object> userInfo)
      Forward content from push notifications payload for processing. Make sure to register the callbackhandler beforehand to receive the result.
      Specified by:
      processNotification in interface com.pingidentity.sdk.pingonewallet.contracts.PingOneWalletClientContract
      Parameters:
      userInfo - : Push notification payload
      Returns:
      true if the notification can be handled by Wallet SDK and false if the SDK cannot recognize it as a PingOne notification

    • pollForMessages

      public void pollForMessages()
      Helper method to start polling for new messages sent to the wallet. Use this method only if you are not using push notifications.

    • stopPolling

      public void stopPolling()
      Call this method to stop polling for messages sent to the wallet

    • checkForMessages

      public void checkForMessages()
      Call this method to check if wallet has received any new messages in the mailbox. This method can be used to check for messages on user action or if push notifications are not available.
      Specified by:
      checkForMessages in interface com.pingidentity.sdk.pingonewallet.contracts.PingOneWalletClientContract

    • findMatchingCredentialsForRequest

      public PresentationMatcherResult findMatchingCredentialsForRequest(@NonNull PresentationRequest request, @NonNull List<com.pingidentity.did.sdk.types.Claim> credentials)
      Call this method to filter the verifiable credentials that match the schema defined in the input descriptor in the presentation request.
      Specified by:
      findMatchingCredentialsForRequest in interface com.pingidentity.sdk.pingonewallet.contracts.PingOneWalletClientContract
      Parameters:
      request - PresentationRequest containing the filtering criteria and other metadata
      credentials - List of claims saved in the Wallet
      Returns:
      PresentationMatherResult containing the list of credentials matching the criteria defined in the presentation request

    • presentCredentials

      public io.reactivex.rxjava3.core.Single<PresentationResult> presentCredentials(@NonNull CredentialsPresentation presentation)
      Call this method to share the presentation with the requester
      Specified by:
      presentCredentials in interface com.pingidentity.sdk.pingonewallet.contracts.PingOneWalletClientContract
      Parameters:
      presentation - CredentialPresentation object containing filtered credentials and presentation request
      Returns:
      PresentationResult returned after credential presentation

    • createSelfClaim

      public io.reactivex.rxjava3.core.Single<com.pingidentity.did.sdk.types.Claim> createSelfClaim(@NonNull Map<String,String> map, com.pingidentity.did.sdk.client.service.model.ApplicationInstance applicationInstance)
      Call this method to create a map of self attested claims
      Parameters:
      map - : Map with key-value pairs for claim
      applicationInstance - : ApplicationInstance
      Returns:
      Self-signed Claim object

    • reportCredentialDeletion

      public void reportCredentialDeletion(@NonNull com.pingidentity.did.sdk.types.Claim claim)
      Call this method when a credential is deleted from the Wallet. Reporting this action will help admins view accurate stats on their dashboards in future.
      Specified by:
      reportCredentialDeletion in interface com.pingidentity.sdk.pingonewallet.contracts.PingOneWalletClientContract
      Parameters:
      claim - Claim that was deleted from wallet

    • handleOpenID4VerifiablePresentationRequest

      public void handleOpenID4VerifiablePresentationRequest(com.pingidentity.did.sdk.w3c.verifiableCredential.VerifiablePresentationRequest request, com.pingidentity.did.sdk.client.OpenIDVerifiableCredentialsClient openIDVerifiableCredentialsClient)
      Specified by:
      handleOpenID4VerifiablePresentationRequest in interface com.pingidentity.did.sdk.client.LinkHandler

    • handleError

      public void handleError(Exception e, com.pingidentity.did.sdk.client.service.model.ApplicationInstance appInstance)
      Specified by:
      handleError in interface com.pingidentity.sdk.pingonewallet.client.DidMessageListener

    • handleRequest

      public void handleRequest(com.pingidentity.did.sdk.types.Request request, com.pingidentity.did.sdk.client.service.model.ApplicationInstance appInstance)
      Specified by:
      handleRequest in interface com.pingidentity.sdk.pingonewallet.client.DidMessageListener

    • handleShare

      public void handleShare(UUID senderId, String message, com.pingidentity.did.sdk.client.service.model.Challenge challenge, List<com.pingidentity.did.sdk.types.Share> shares, List<com.pingidentity.did.sdk.exception.DidException> errors, com.pingidentity.did.sdk.client.service.model.ApplicationInstance appInstance)
      Specified by:
      handleShare in interface com.pingidentity.sdk.pingonewallet.client.DidMessageListener

    • handleShareRequest

      public void handleShareRequest(UUID senderId, String message, com.pingidentity.did.sdk.client.service.model.Challenge challenge, List<String> shares, com.pingidentity.did.sdk.client.service.model.ApplicationInstance appInstance)
      Specified by:
      handleShareRequest in interface com.pingidentity.sdk.pingonewallet.client.DidMessageListener

    • handleClaim

      public void handleClaim(UUID sender, String message, com.pingidentity.did.sdk.client.service.model.Challenge challenge, com.pingidentity.did.sdk.types.Claim claim, List<com.pingidentity.did.sdk.exception.DidException> errors, com.pingidentity.did.sdk.client.service.model.ApplicationInstance applicationInstance)
      Specified by:
      handleClaim in interface com.pingidentity.sdk.pingonewallet.client.DidMessageListener

    • handleExpiredClaim

      public void handleExpiredClaim(UUID sender, String message, com.pingidentity.did.sdk.client.service.model.Challenge challenge, com.pingidentity.did.sdk.types.ClaimReference claimReference, List<com.pingidentity.did.sdk.exception.DidException> errors, com.pingidentity.did.sdk.client.service.model.ApplicationInstance applicationInstance)
      Specified by:
      handleExpiredClaim in interface com.pingidentity.sdk.pingonewallet.client.DidMessageListener

    • handleSecureMessage

      public void handleSecureMessage(UUID senderId, String message, com.pingidentity.did.sdk.client.service.model.Challenge challenge, com.pingidentity.did.sdk.client.service.model.ApplicationInstance appInstance)
      Specified by:
      handleSecureMessage in interface com.pingidentity.sdk.pingonewallet.client.DidMessageListener

    • handleException

      public void handleException(com.pingidentity.did.sdk.exception.DidException error, com.pingidentity.did.sdk.client.service.model.ApplicationInstance appInstance)
      Specified by:
      handleException in interface com.pingidentity.sdk.pingonewallet.client.DidMessageListener

    • handleWalletError

      public void handleWalletError(com.pingidentity.sdk.pingonewallet.errors.WalletException err)

    • handleWalletMessage

      public void handleWalletMessage(String sender, String message, com.pingidentity.did.sdk.client.service.model.Challenge challenge, com.pingidentity.did.sdk.client.service.model.ApplicationInstance applicationInstance)