Package org.cyclos.model.access.totps

Enum TotpSecretStatus

java.lang.Object

java.lang.Enum<TotpSecretStatus>

org.cyclos.model.access.totps.TotpSecretStatus

All Implemented Interfaces:

Serializable, Comparable<TotpSecretStatus>

public enum TotpSecretStatus
extends Enum<TotpSecretStatus>

The status of an authenticator app for a user. This is never persisted.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE	The TOTP was actually activated, by verifying a code generated by the authenticator app.
NEVER_CREATED	TOTP was never created by the user
PENDING	The user has passed the verification process for creating a TOTP, and a secret is generated.

Method Summary

Modifier and Type	Method	Description
static TotpSecretStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TotpSecretStatus[]	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

NEVER_CREATED

public static final TotpSecretStatus NEVER_CREATED

TOTP was never created by the user

PENDING

public static final TotpSecretStatus PENDING

The user has passed the verification process for creating a TOTP, and a secret is generated.

ACTIVE

public static final TotpSecretStatus ACTIVE

The TOTP was actually activated, by verifying a code generated by the authenticator app.

Method Detail

values

public static TotpSecretStatus[] 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 (TotpSecretStatus c : TotpSecretStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static TotpSecretStatus valueOf(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:

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

NullPointerException - if the argument is null