com.ibm.security.access.mobile.authentication

Class PendingTransaction

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


    public class PendingTransaction
    extends java.lang.Object
    implements android.os.Parcelable
    Representation of a pending transaction.
    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<PendingTransaction> CREATOR
      Creates an instance from a parcel.
      • Fields inherited from interface android.os.Parcelable

        CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
    • Constructor Summary

      Constructors 
      Constructor and Description
      PendingTransaction(java.lang.String transactionId, java.lang.String policyEndpointUrl, java.util.Date createdDate)
      Returns an instance of a new PendingTransaction object.
    • 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.Date getCreatedDate()
      Return the transaction creation date.
      java.lang.String getImageUrl()
      Return the fully-qualified URL of an image to use.
      java.lang.String getMessage()
      Return the message associated with the transaction, if provided.
      java.lang.String getPolicyEndpointUrl()
      Return the policy endpoint of the challenge mechanism.
      java.lang.String getTransactionId()
      Return the unique identifier of the transaction.
      java.lang.String getType()
      Return the type of transaction.
      void setCreatedDate(java.util.Date createdDate)
      Set the transaction creation date.
      void setImageUrl(java.lang.String imageUrl)
      Set the fully-qualified URL of an image to use.
      void setMessage(java.lang.String message)
      Set the associated message with the transaction.
      void setPolicyEndpointUrl(java.lang.String policyEndpointUrl)
      Set the policy endpoint of the challenge mechanism.
      void setTransactionId(java.lang.String transactionId)
      Set the unique identifier of the transaction.
      void setType(java.lang.String type)
      Set the type of transaction.
      java.lang.String transactionIdShort()
      The transactionId is represented as a Universal Unique Identifier (UUID).
      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<PendingTransaction> CREATOR
        Creates an instance from a parcel.
        Since:
        1.2.2
    • Constructor Detail

      • PendingTransaction

        public PendingTransaction(java.lang.String transactionId,
                                  java.lang.String policyEndpointUrl,
                                  java.util.Date createdDate)
        Returns an instance of a new PendingTransaction object.
        Parameters:
        transactionId - the unique identifer of the transaction
        policyEndpointUrl - the policy endpoint to the challenge mechanism
        createdDate - the transaction creation date
        Throws:
        java.lang.IllegalArgumentException - if any parameter is null
    • Method Detail

      • getTransactionId

        public java.lang.String getTransactionId()
        Return the unique identifier of the transaction.
        Returns:
        the unique identifier of the transaction
      • setTransactionId

        public void setTransactionId(java.lang.String transactionId)
        Set the unique identifier of the transaction.
        Parameters:
        transactionId - the unique identifier of the transaction
        Throws:
        java.lang.IllegalArgumentException - if parameter is null
      • getPolicyEndpointUrl

        public java.lang.String getPolicyEndpointUrl()
        Return the policy endpoint of the challenge mechanism.
        Returns:
        the policy endpoint of the challenge mechanism
      • setPolicyEndpointUrl

        public void setPolicyEndpointUrl(java.lang.String policyEndpointUrl)
        Set the policy endpoint of the challenge mechanism.
        Parameters:
        policyEndpointUrl - the policy endpoint of the challenge mechanism
        Throws:
        java.lang.IllegalArgumentException - if parameter is null
      • getCreatedDate

        public java.util.Date getCreatedDate()
        Return the transaction creation date.
        Returns:
        the transaction creation date
      • setCreatedDate

        public void setCreatedDate(java.util.Date createdDate)
        Set the transaction creation date.
        Parameters:
        createdDate - the transaction creation date
        Throws:
        java.lang.IllegalArgumentException - if parameter is null
      • getMessage

        public java.lang.String getMessage()
        Return the message associated with the transaction, if provided.
        Returns:
        the message associated with the transaction
      • setMessage

        public void setMessage(java.lang.String message)
        Set the associated message with the transaction.
        Parameters:
        message - the associated message with the transaction
      • getImageUrl

        public java.lang.String getImageUrl()
        Return the fully-qualified URL of an image to use. Default is null. Not implemented on the server, so subject to change.
        Returns:
        the fully-qualified URL of an image to use
      • setImageUrl

        public void setImageUrl(java.lang.String imageUrl)
        Set the fully-qualified URL of an image to use.
        Parameters:
        imageUrl - the fully-qualified URL of an image to use
      • getType

        public java.lang.String getType()
        Return the type of transaction.
        Returns:
        the type of transaction
      • setType

        public void setType(java.lang.String type)
        Set the type of transaction.
        Parameters:
        type - the type of transaction
        Throws:
        java.lang.IllegalArgumentException - if parameter is null
      • transactionIdShort

        public java.lang.String transactionIdShort()
        The transactionId is represented as a Universal Unique Identifier (UUID). This method returns the characters up to the first dash.
        Returns:
        the characters to the first dash of transactionId
      • 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