Package eu.webtoolkit.jwt.auth

Enum Class EmailTokenState

java.lang.Object

java.lang.Enum<EmailTokenState>

eu.webtoolkit.jwt.auth.EmailTokenState

All Implemented Interfaces:

Serializable, Comparable<EmailTokenState>, Constable

public enum EmailTokenState
extends Enum<EmailTokenState>

A token validation state.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

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

Modifier and Type	Method	Description
int	getValue()	Returns the numerical representation of this enum.
static EmailTokenState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EmailTokenState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static EmailTokenState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static EmailTokenState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Returns the numerical representation of this enum.