com.ibm.security.access.mobile.authentication

Class UserPresenceChallenge

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


    public class UserPresenceChallenge
    extends java.lang.Object
    implements IChallenge
    The simple user presence challenge prompts the user to acknowledge.
    Since:
    1.2.0
    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<UserPresenceChallenge> 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 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 keystore.
      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 the enrollment challenge.
      void launchUI(android.app.Activity activity, IChallengeCallbackHandleUserInput callback)
      Launches an UI that prompts the user for presence confirmation.
      IChallenge parse(org.json.JSONObject data)
      Returns an instance of IChallenge parsed from the object.
      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 keystore.
      void setPostbackUri(java.lang.String postbackUri)
      The postback URI 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

      • CREATOR

        public static final android.os.Parcelable.Creator<UserPresenceChallenge> CREATOR
        Creates an instance from a parcel.
        Since:
        1.2.2
    • Constructor Detail

      • UserPresenceChallenge

        public UserPresenceChallenge()
        Returns an instance containing a new IChallenge.
      • UserPresenceChallenge

        public UserPresenceChallenge(java.lang.String messagePrompt)
        Returns an instance containing a new IChallenge with a message.
        Parameters:
        messagePrompt - the message to display.
        Throws:
        java.lang.IllegalArgumentException - if parameter is null
    • Method Detail

      • getName

        public java.lang.String getName()
        Returns the name of the mechanism.
        Returns:
        the name of the mechanism
      • getIdentifier

        public java.lang.String getIdentifier()
        Returns the identifier of the mechanism. For example: urn:ibm:security:authentication:asf:mechanism:hotp
        Specified by:
        getIdentifier in interface IChallenge
        Returns:
        identifier of the mechanism
      • getDescription

        public java.lang.String getDescription()
        Returns the description of the mechanism.
        Specified by:
        getDescription in interface IChallenge
        Returns:
        description of the mechanism
      • setPostbackUri

        public void setPostbackUri(java.lang.String postbackUri)
        The postback URI of the mechanism.
        Specified by:
        setPostbackUri in interface IChallenge
        Parameters:
        postbackUri - the postback URI of the mechanism
        Throws:
        java.lang.IllegalArgumentException - if parameter is null
      • getPostbackUri

        public java.lang.String getPostbackUri()
        Returns the postback URI of the mechanism.
        Specified by:
        getPostbackUri in interface IChallenge
        Returns:
        the postback URI of the mechanism
      • getState

        public java.lang.String getState()
        Returns the unique identifier of the mechanism request.
        Specified by:
        getState in interface IChallenge
        Returns:
        unique identifier of the mechanism request
      • setState

        public void setState(java.lang.String state)
        Set the unique identifier of the mechanism request.
        Specified by:
        setState in interface IChallenge
        Parameters:
        state - unique identifier to be set
        Throws:
        java.lang.IllegalArgumentException - if parameter is null
      • getMessagePrompt

        public java.lang.String getMessagePrompt()
        Returns the message to display in the alert when prompted.
        Specified by:
        getMessagePrompt in interface IChallenge
        Returns:
        the message to display in the alert
      • getKeyName

        public java.lang.String getKeyName()
        Returns the type's identifier, used to access the private key in the keystore.
        Returns:
        the type's identifier, used to access the private key in the keystore.
      • setKeyName

        public void setKeyName(java.lang.String keyName)
        Set the type's identifier, used to access the private key in the keystore.
        Parameters:
        keyName - the name of the key in the key store
        Throws:
        java.lang.IllegalArgumentException - if parameter is null
      • getChallengeData

        public java.util.HashMap<java.lang.String,java.lang.Object> getChallengeData()
        Returns the challengeData of the mechanism. Represeting the data that will be returned in the launchUI(Activity, IChallengeCallbackHandleUserInput) function.
        Returns:
        the challengeData of the mechanism
      • 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
        Throws:
        java.lang.IllegalArgumentException - if parameter is null
      • getChallengeText

        public java.lang.String getChallengeText()
        Returns text representing the server challenge which requires signing.
        Returns:
        text representing the server challenge which requires signing
      • getKeyHandles

        public java.lang.String[] getKeyHandles()
        Returns an array of String representing names of key handles.
        Returns:
        an array of String representing names of key handles
      • getType

        public java.lang.String getType()
        Returns the type of the enrollment challenge.
        Returns:
        the type of enrollment challenge
      • parse

        public IChallenge parse(org.json.JSONObject data)
        Returns an instance of IChallenge parsed from the object.
        Specified by:
        parse in interface IChallenge
        Parameters:
        data - the object to deserialize from.
        Returns:
        The deserialized IChallenge.
      • launchUI

        public void launchUI(android.app.Activity activity,
                             IChallengeCallbackHandleUserInput callback)
        Launches an UI that prompts the user for presence confirmation.
        Specified by:
        launchUI in interface IChallenge
        Parameters:
        callback - the function delegate that is invoked with a HashMap
      • 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
        Since:
        1.2.2
      • 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
        Since:
        1.2.2