Package org.apereo.cas.configuration.model.support.mfa

Enum BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes

java.lang.Object

java.lang.Enum<BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes>

org.apereo.cas.configuration.model.support.mfa.BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes>

Enclosing class:

BaseMultifactorAuthenticationProviderProperties

public static enum BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes
extends java.lang.Enum<BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes>

This is BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes.

Since:

6.4.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSED	Disallow MFA, block with authentication.
NONE	Do not check for failure at all.
OPEN	Disallow MFA, proceed with authentication but don't communicate MFA to the RP.
PHANTOM	Disallow MFA, proceed with authentication and communicate MFA to the RP.
UNDEFINED	The default one indicating that no failure mode is set at all.

Method Summary

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

OPEN

public static final BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes OPEN

Disallow MFA, proceed with authentication but don't communicate MFA to the RP.

CLOSED

public static final BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes CLOSED

Disallow MFA, block with authentication.

PHANTOM

public static final BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes PHANTOM

Disallow MFA, proceed with authentication and communicate MFA to the RP.

NONE

public static final BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes NONE

Do not check for failure at all.

UNDEFINED

public static final BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes UNDEFINED

The default one indicating that no failure mode is set at all.

Method Detail

values

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

Returns:

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

valueOf

public static BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes 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

isAllowedToBypass

public boolean isAllowedToBypass()