com.ibm.security.access.mobile.authentication

Class HotpEnrollment

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


    public final class HotpEnrollment
    extends java.lang.Object
    implements IEnrollment
    The enrollment for counter based one-time password.
    Since:
    1.2.0
    Version:
    1.2.8
    • Constructor Summary

      Constructors 
      Constructor and Description
      HotpEnrollment() 
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      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.
      java.lang.String getType()
      Returns the type of the enrollment challenge.
      boolean isEnabled()
      Returns whether the enrollment is enabled.
      org.json.JSONObject serializeToJson()
      Returns a JSON string of the serialized HotpEnrollment object.
      void setEnabled(boolean enabled)
      Set the flag to indicate whether the enrollment is enabled.
      • Methods inherited from class java.lang.Object

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

      • HotpEnrollment

        public HotpEnrollment()
    • 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 type of the enrollment challenge
      • getName

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

        public java.lang.String getMethod()
        Returns the type of HTTP method required for enrollment. This must be GET or POST.
        Specified by:
        getMethod in interface IEnrollment
        Returns:
        the type of HTTP method required for enrollment
      • getIdentifier

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

        public org.json.JSONObject serializeToJson()
        Returns a JSON string of the serialized HotpEnrollment object.
        Specified by:
        serializeToJson in interface IEnrollment
        Returns:
        the JSONObject