com.ibm.security.access.mobile.authentication

Class BiometricSampleEnrollment

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


    public final class BiometricSampleEnrollment
    extends java.lang.Object
    implements IEnrollment
    The enrollment of a biometric sample.
    Since:
    1.2.3
    Version:
    1.2.8
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getAuthenticatorIdentifier()
      Returns the identifier of the authenticator.
      java.lang.String getIdentifier()
      Returns the identifier of the enrollment.
      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 getSampelData()
      Returns the biometric sample data.
      int getSampleIdentifier()
      Returns the identifier of the sample.
      java.lang.String getType()
      Returns the type of the enrollment challenge.
      boolean isEnabled()
      Returns whether the enrollment is enabled.
      org.json.JSONObject serializeToJson()
      Returns the serialized BiometricSampleEnrollment object as a JSON string.
      void setAuthenticatorIdentifier(java.lang.String authenticatorIdentifier)
      Sets the identifier of the authenticator.
      void setEnabled(boolean enabled)
      Set the flag to indicate whether the enrollment is enabled.
      void setSampelData(java.lang.String sampelData)
      Sets the biometric sample data.
      void setSampleIdentifier(int sampleIdentifier)
      Sets the identifier of the sample.
      • Methods inherited from class java.lang.Object

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

      • BiometricSampleEnrollment

        public BiometricSampleEnrollment()
    • Method Detail

      • isEnabled

        public boolean isEnabled()
        Returns whether the enrollment is enabled. Default is false.
        Specified by:
        isEnabled in interface IEnrollment
        Returns:
        true if the enrollment is enabled
        false otherwise
      • setEnabled

        public void setEnabled(boolean enabled)
        Set the flag to indicate whether the enrollment is enabled.
        Specified by:
        setEnabled in interface IEnrollment
        Parameters:
        enabled - the flag to indicate whether the enrollment is enabled
      • 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
      • getSampleIdentifier

        public int getSampleIdentifier()
        Returns the identifier of the sample. Default is 1. Use the index of the array to attribute the sample identifier to the biometric engine.
        Returns:
        the identifier of the sample
      • setSampleIdentifier

        public void setSampleIdentifier(int sampleIdentifier)
        Sets the identifier of the sample.
        Parameters:
        sampleIdentifier - the identifier of the sample
      • getSampelData

        public java.lang.String getSampelData()
        Returns the biometric sample data.
        Returns:
        the biometric sample data
      • setSampelData

        public void setSampelData(java.lang.String sampelData)
        Sets the biometric sample data. The value is required to be in base64 format!
        Parameters:
        sampelData - the biometric sample data
      • getAuthenticatorIdentifier

        public java.lang.String getAuthenticatorIdentifier()
        Returns the identifier of the authenticator.
        Returns:
        the identifier of the authenticator
      • setAuthenticatorIdentifier

        public void setAuthenticatorIdentifier(java.lang.String authenticatorIdentifier)
        Sets the identifier of the authenticator.
        Parameters:
        authenticatorIdentifier - the identifier of the authenticator