org.cyclos.model.access

Enum CredentialUsage

java.lang.Object

java.lang.Enum<CredentialUsage>

org.cyclos.model.access.CredentialUsage

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CredentialUsage>

public enum CredentialUsage
extends java.lang.Enum<CredentialUsage>

Contains all possible usages for a credential (i.e password or device). With device we are referring to a confirmation approved through a trusted device.

Author:

ameyer

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCESS The credential is used for login.
CONFIRMATION The credential is used to confirm an action.
SECONDARY The credential is used for login confirmation (i.e secondary access).

Method Summary

Modifier and Type	Method and Description
boolean	allowDevice() Returns whether devices are allowed for this credential usage.
boolean	allowPassword() Returns whether passwords are allowed for this credential usage.
boolean	requirePassword() Returns whether passwords are required for this credential usage.
static CredentialUsage	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CredentialUsage[]	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

ACCESS

public static final CredentialUsage ACCESS

The credential is used for login. Only passwords are valid credentials.

SECONDARY

public static final CredentialUsage SECONDARY

The credential is used for login confirmation (i.e secondary access).
Both passwords and devices are valid credentials.

CONFIRMATION

public static final CredentialUsage CONFIRMATION

The credential is used to confirm an action.
Both passwords and devices are valid credentials.

Method Detail

values

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

Returns:

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

valueOf

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

allowDevice

public boolean allowDevice()

Returns whether devices are allowed for this credential usage.

allowPassword

public boolean allowPassword()

Returns whether passwords are allowed for this credential usage.

requirePassword

public boolean requirePassword()

Returns whether passwords are required for this credential usage.