Package org.cyclos.model.access

Enum CredentialType

java.lang.Object

java.lang.Enum<CredentialType>

org.cyclos.model.access.CredentialType

All Implemented Interfaces:

Serializable, Comparable<CredentialType>, HasMessageKey

public enum CredentialType
extends Enum<CredentialType>
implements HasMessageKey

Indicates a type of credential which can used for a give CredentialUsage. A channel can accept multiple credential types on a single usage.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEVICE	A trusted device
PASSWORD	A regular password
PIN	A device-specific pin
TOTP	An RFC 6238 TOTP

Method Summary

Modifier and Type	Method	Description
MessageKey	getMessageKey()
boolean	isManualInput()	Returns whether this credential type uses a manually entered credential
static EnumMessageKeyResolver<CredentialType>	resolverForChannelConfiguration()
static EnumMessageKeyResolver<CredentialType>	resolverForConfirmationText()
static CredentialType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CredentialType[]	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

PASSWORD

public static final CredentialType PASSWORD

A regular password

DEVICE

public static final CredentialType DEVICE

A trusted device

TOTP

public static final CredentialType TOTP

An RFC 6238 TOTP

PIN

public static final CredentialType PIN

A device-specific pin

Method Detail

values

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

Returns:

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

valueOf

public static CredentialType 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

resolverForChannelConfiguration

public static EnumMessageKeyResolver<CredentialType> resolverForChannelConfiguration()

resolverForConfirmationText

public static EnumMessageKeyResolver<CredentialType> resolverForConfirmationText()

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey

isManualInput

public boolean isManualInput()

Returns whether this credential type uses a manually entered credential