com.ibm.security.access.mobile.authentication

Class FingerprintEnrollment

  • java.lang.Object
    • com.ibm.security.access.mobile.authentication.FingerprintEnrollment
  • All Implemented Interfaces:
    IEnrollment, IScimEnrollment


    public final class FingerprintEnrollment
    extends java.lang.Object
    implements IScimEnrollment
    The enrollment for Fingerprint.
    Since:
    1.2.0
    Version:
    1.2.8
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getAlgorithm()
      Returns the name of the algorithm to sign the data.
      java.lang.String getIdentifier()
      Returns the identifier of the enrollment.
      java.lang.String getKeyHandle()
      Returns the name that can be used to identify the key handle.
      java.lang.String getMethod()
      Returns the type of HTTP method required for enrollment.
      java.lang.String getName()
      Returns the name of the enrollment challenge.
      java.lang.String getPublicKey()
      Returns the public key used to be stored.
      java.lang.String getQueryString()
      Returns additional attributes for enrolling in SCIM interface.
      java.lang.String getType()
      Returns the type of the enrollment challenge.
      boolean isEnabled()
      Returns the flag to indicate whether the enrollment challenge is enabled.
      org.json.JSONObject serializeToJson()
      Returns the serialized FingerprintEnrollment object as a JSON string.
      void setEnabled(boolean enabled)
      Set the flag to indicate whether the enrollment challenge is enabled.
      void setKeyHandle(java.lang.String keyHandle)
      Sets the key handle.
      void setPublicKey(java.lang.String publicKey)
      Sets the public key.
      • Methods inherited from class java.lang.Object

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

      • FingerprintEnrollment

        public FingerprintEnrollment()
    • Method Detail

      • getType

        public java.lang.String getType()
        Returns the type of the enrollment challenge.
        Specified by:
        getType in interface IEnrollment
        Returns:
        the typ of enrollment challenge
      • getIdentifier

        public java.lang.String getIdentifier()
        Returns the identifier of the enrollment.
        Specified by:
        getIdentifier in interface IEnrollment
        Returns:
        the identifier of the enrollment
      • getName

        public java.lang.String getName()
        Returns the name of the enrollment challenge.
        Specified by:
        getName in interface IEnrollment
        Returns:
        the name of the enrollment challenge
      • getMethod

        public java.lang.String getMethod()
        Returns the type of HTTP method required for enrollment.
        Specified by:
        getMethod in interface IEnrollment
        Returns:
        the type of HTTP method required for enrollment
      • getAlgorithm

        public java.lang.String getAlgorithm()
        Returns the name of the algorithm to sign the data.
        Returns:
        the name of the algorithm to sign the data
      • setEnabled

        public void setEnabled(boolean enabled)
        Set the flag to indicate whether the enrollment challenge is enabled.
        Specified by:
        setEnabled in interface IEnrollment
        Parameters:
        enabled - the flag to indicate whether the enrollment challenge is enabled
      • getKeyHandle

        public java.lang.String getKeyHandle()
        Returns the name that can be used to identify the key handle.
        Specified by:
        getKeyHandle in interface IScimEnrollment
        Returns:
        the name that can be used to identify the key handle
      • setKeyHandle

        public void setKeyHandle(java.lang.String keyHandle)
        Sets the key handle.
        Specified by:
        setKeyHandle in interface IScimEnrollment
        Parameters:
        keyHandle - the key handle to be set
        Throws:
        java.lang.IllegalArgumentException - if parameter is null
      • isEnabled

        public boolean isEnabled()
        Returns the flag to indicate whether the enrollment challenge is enabled.
        Specified by:
        isEnabled in interface IEnrollment
        Specified by:
        isEnabled in interface IScimEnrollment
        Returns:
        the flag to indicate whether the enrollment challenge is enabled
      • getPublicKey

        public java.lang.String getPublicKey()
        Returns the public key used to be stored.
        Returns:
        the public key used to be stored
      • setPublicKey

        public void setPublicKey(java.lang.String publicKey)
        Sets the public key.
        Parameters:
        publicKey - the public key to be set
        Throws:
        java.lang.IllegalArgumentException - if parameter is null
      • getQueryString

        public java.lang.String getQueryString()
        Returns additional attributes for enrolling in SCIM interface.
        Specified by:
        getQueryString in interface IScimEnrollment