com.ibm.security.access.mobile.authentication

Class MfaQRScanResult

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


    public final class MfaQRScanResult
    extends java.lang.Object
    implements IQRScanResult
    The MfaQRScanResult handles registration data scanned from a QR code.
    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<MfaQRScanResult> CREATOR 
      • Fields inherited from interface android.os.Parcelable

        CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
    • Constructor Summary

      Constructors 
      Constructor and Description
      MfaQRScanResult()
      Returns a new instance of a MfaQRScanResult object.
      MfaQRScanResult(java.lang.String code, java.lang.String metadataUrl, java.lang.String clientId, java.lang.String tokenUrl)
      Returns a new instance of a MfaQRScanResult object.
      MfaQRScanResult(java.lang.String code, java.lang.String metadataUrl, java.lang.String clientId, java.lang.String tokenUrl, boolean ignoreSslCerts)
      Returns a new instance of a MfaQRScanResult 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.lang.String getClientId()
      Returns the unique identifier between the service and the app.
      java.lang.String getCode()
      Returns the OAuth authorization code.
      java.lang.String getMetadataUrl()
      Returns the metadata discovery endpoint.
      java.lang.String getTokenUrl()
      Returns the location to the OAuth endpoint.
      boolean isIgnoreSslCerts()
      The flag indicating whether to ignore SSL certificate checking.
      MfaQRScanResult parse(java.lang.String value)
      Parses the incoming data from the QR code.
      void writeToParcel(android.os.Parcel dest, int flags)
      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<MfaQRScanResult> CREATOR
    • Constructor Detail

      • MfaQRScanResult

        public MfaQRScanResult()
        Returns a new instance of a MfaQRScanResult object.
      • MfaQRScanResult

        public MfaQRScanResult(java.lang.String code,
                               java.lang.String metadataUrl,
                               java.lang.String clientId,
                               java.lang.String tokenUrl)
        Returns a new instance of a MfaQRScanResult object.
        Parameters:
        code - the OAuth authorization code
        metadataUrl - the metadata discovery endpoint
        clientId - the unique identifier between the service and the app
        tokenUrl - the location to the OAuth endpoint
        Throws:
        java.lang.IllegalArgumentException - if any parameter is null
      • MfaQRScanResult

        public MfaQRScanResult(java.lang.String code,
                               java.lang.String metadataUrl,
                               java.lang.String clientId,
                               java.lang.String tokenUrl,
                               boolean ignoreSslCerts)
        Returns a new instance of a MfaQRScanResult object.
        Parameters:
        code - the OAuth authorization code
        metadataUrl - the metadata discovery endpoint
        clientId - the unique identifier between the service and the app
        tokenUrl - the location to the OAuth endpoint
        ignoreSslCerts - the flag to ignore SSL certificate checking
        Throws:
        java.lang.IllegalArgumentException - if any parameter is null
    • Method Detail

      • getMetadataUrl

        public java.lang.String getMetadataUrl()
        Returns the metadata discovery endpoint.
        Returns:
        the metadata discovery endpoint
      • getCode

        public java.lang.String getCode()
        Returns the OAuth authorization code.
        Returns:
        the OAuth authorization code
      • parse

        public MfaQRScanResult parse(java.lang.String value)
        Parses the incoming data from the QR code.
        Specified by:
        parse in interface IQRScanResult
        Parameters:
        value - The incoming value.
        Returns:
        an instance of MfaQRScanResult, or null if the data cannot be parsed.
      • 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 dest,
                                  int flags)
        Writes the object into a parcel.
        Specified by:
        writeToParcel in interface android.os.Parcelable
        Parameters:
        dest - the parcel where the object is written into
        flags - flags about how the object should be written
      • getTokenUrl

        public java.lang.String getTokenUrl()
        Returns the location to the OAuth endpoint.
        Returns:
        the location to the OAuth endpoint
      • getClientId

        public java.lang.String getClientId()
        Returns the unique identifier between the service and the app.
        Returns:
        the unique identifier between the service and the app
      • isIgnoreSslCerts

        public boolean isIgnoreSslCerts()
        The flag indicating whether to ignore SSL certificate checking.
        Returns:
        flag indicating whether to ignore SSL certificate checking