Package eu.webtoolkit.jwt.auth

Enum EmailTokenState

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<EmailTokenState>
    public enum EmailTokenState
extends java.lang.Enum<EmailTokenState>
    A token validation state.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      EmailConfirmed
      A The token was presented which verifies the email address.
      Expired
      The token has expired.
      Invalid
      The token was invalid.
      UpdatePassword
      A token was presented which requires the user to enter a new password.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getValue()
      Returns the numerical representation of this enum.
      static EmailTokenState valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static EmailTokenState[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • Invalid

        public static final EmailTokenState Invalid
        The token was invalid.

      • Expired

        public static final EmailTokenState Expired
        The token has expired.

      • UpdatePassword

        public static final EmailTokenState UpdatePassword
        A token was presented which requires the user to enter a new password.

        The presented token was a token sent by the AuthService#lostPassword() function. When this is returned as result of AuthService#processEmailToken(), you should present the user with a dialog where he can enter a new password.

      • EmailConfirmed

        public static final EmailTokenState EmailConfirmed
        A The token was presented which verifies the email address.

        The presented token was a token sent by the AuthService#verifyEmailAddress() function. When this is returned as result of processEmailToken(), you can indicate to the user that his email address is now confirmed.

    • Method Detail

      • values

        public static EmailTokenState[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (EmailTokenState c : EmailTokenState.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static EmailTokenState valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getValue

        public int getValue()
        Returns the numerical representation of this enum.