com.ibm.security.access.mobile.authentication

Class FingerprintChallengeWrapper

  • java.lang.Object
    • com.ibm.security.access.mobile.authentication.FingerprintChallengeWrapper
  • All Implemented Interfaces:
    android.os.Parcelable


    public class FingerprintChallengeWrapper
    extends java.lang.Object
    implements android.os.Parcelable
    A wrapper class for the FingerprintChallenge objects. You can use this class rather than FingerprintChallenge directly if you are developing for API version < 23 and do not want to check that level in your code every time.
    Since:
    1.2.2
    Version:
    1.2.8
    • Nested Class Summary

      • Nested classes/interfaces inherited from interface android.os.Parcelable

        android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static android.os.Parcelable.Creator<FingerprintChallengeWrapper> CREATOR
      Creates an instance from a parcel.
      • Fields inherited from interface android.os.Parcelable

        CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      int describeContents()
      Returns a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
      java.util.HashMap<java.lang.String,java.lang.Object> getChallengeData()
      Returns the challengeData of the mechanism.
      java.lang.String getChallengeText()
      Returns the text representing the server challenge which requires signing.
      java.lang.String getDescription()
      Returns the description of the mechanism.
      java.lang.String getIdentifier()
      Returns the identifier of the mechanism.
      java.lang.String[] getKeyHandles()
      Returns an array of String representing names of key handles.
      java.lang.String getKeyName()
      Returns the type's identifier, used to access the private key in the key store.
      java.lang.String getMessagePrompt()
      Returns the message to display in the alert when prompted.
      java.lang.String getName()
      Returns the name of the mechanism.
      java.lang.String getPostbackUri()
      Returns the postback URI of the mechanism.
      java.lang.String getState()
      Returns the unique identifier of the mechanism request.
      java.lang.String getType()
      Returns the type of enrollment challenge.
      void launchUI(android.app.Activity activity, IChallengeCallbackHandleUserInput callback)
      Launches the Fingerprint dialog for LocalAuthentication.
      IChallenge parse(org.json.JSONObject data)
      Returns an instance of IChallenge parsed from the object, or null if data cannot be parsed.
      void setChallengeData(java.util.HashMap<java.lang.String,java.lang.Object> challengeData)
      Set the challengeData of the mechanism.
      void setKeyName(java.lang.String keyName)
      Set the type's identifier, used to access the private key in the key store.
      void setPostbackUri(java.lang.String postbackUri)
      Set the postback URL of the mechanism.
      void setState(java.lang.String state)
      Set the unique identifier of the mechanism request.
      void writeToParcel(android.os.Parcel parcel, int i)
      Writes the object into a parcel.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

    • Constructor Detail

      • FingerprintChallengeWrapper

        public FingerprintChallengeWrapper(java.lang.String messagePrompt)
        Returns an instance containing a new FingerprintChallengeWrapper with a message.
        Parameters:
        messagePrompt - the message to display.
    • Method Detail

      • describeContents

        public int describeContents()
        Returns a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
        Specified by:
        describeContents in interface android.os.Parcelable
        Returns:
        bitmask indicating the set of special object types
      • writeToParcel

        public void writeToParcel(android.os.Parcel parcel,
                                  int i)
        Writes the object into a parcel.
        Specified by:
        writeToParcel in interface android.os.Parcelable
        Parameters:
        parcel - the parcel where the object is written into
        i - flags about how the object should be written
      • getName

        public java.lang.String getName()
        Returns the name of the mechanism.
        Returns:
        the name of the mechanism or null if API < 23
      • getChallengeData

        public java.util.HashMap<java.lang.String,java.lang.Object> getChallengeData()
        Returns the challengeData of the mechanism.
        Returns:
        the challengeData of the mechanism or null if API < 23
      • setChallengeData

        public void setChallengeData(java.util.HashMap<java.lang.String,java.lang.Object> challengeData)
        Set the challengeData of the mechanism.
        Parameters:
        challengeData - the data to be set
      • setPostbackUri

        public void setPostbackUri(java.lang.String postbackUri)
        Set the postback URL of the mechanism.
        Parameters:
        postbackUri - the postback URL to be set
      • getType

        public java.lang.String getType()
        Returns the type of enrollment challenge.
        Returns:
        the type of enrollment challenge or null if API < 23
      • getPostbackUri

        public java.lang.String getPostbackUri()
        Returns the postback URI of the mechanism.
        Returns:
        the postback URI of the mechanism or null if API < 23
      • getState

        public java.lang.String getState()
        Returns the unique identifier of the mechanism request.
        Returns:
        unique identifier of the mechanism request or null if API < 23
      • setState

        public void setState(java.lang.String state)
        Set the unique identifier of the mechanism request.
        Parameters:
        state - unique identifier to be set
      • getMessagePrompt

        public java.lang.String getMessagePrompt()
        Returns the message to display in the alert when prompted.
        Returns:
        the message to display in the alert or null if API < 23
      • getIdentifier

        public java.lang.String getIdentifier()
        Returns the identifier of the mechanism. For example: urn:ibm:security:authentication:asf:mechanism:hotp
        Returns:
        identifier of the mechanism or null if API < 23
      • getDescription

        public java.lang.String getDescription()
        Returns the description of the mechanism.
        Returns:
        description of the mechanism or null if API < 23
      • parse

        public IChallenge parse(org.json.JSONObject data)
        Returns an instance of IChallenge parsed from the object, or null if data cannot be parsed.
        Parameters:
        data - the object to deserialize from.
        Returns:
        an instance of FingerprintChallenge or null if data cannot be parsed or if API < 23
      • getChallengeText

        public java.lang.String getChallengeText()
        Returns the text representing the server challenge which requires signing.
        Returns:
        text representing the server challenge which requires signing or null if API < 23
      • getKeyName

        public java.lang.String getKeyName()
        Returns the type's identifier, used to access the private key in the key store. Only one challenge of this type can be enrolled, so there's no overlap.
        Returns:
        the name of the key in the key store or null if API < 23
      • setKeyName

        public void setKeyName(java.lang.String keyName)
        Set the type's identifier, used to access the private key in the key store.
        Parameters:
        keyName - the name of the key in the key store
      • getKeyHandles

        public java.lang.String[] getKeyHandles()
        Returns an array of String representing names of key handles.
        Returns:
        array of String representing names of key handles or null if API < 23
      • launchUI

        public void launchUI(android.app.Activity activity,
                             IChallengeCallbackHandleUserInput callback)
        Launches the Fingerprint dialog for LocalAuthentication.
        Parameters:
        callback - The function delegate that is invoked with the ChallengeResult