Package com.evolveum.midpoint.xml.ns._public.common.common_3

Enum AuthenticationSequenceModuleNecessityType

java.lang.Object

java.lang.Enum<AuthenticationSequenceModuleNecessityType>

com.evolveum.midpoint.xml.ns._public.common.common_3.AuthenticationSequenceModuleNecessityType

All Implemented Interfaces:

Serializable, Comparable<AuthenticationSequenceModuleNecessityType>

public enum AuthenticationSequenceModuleNecessityType
extends Enum<AuthenticationSequenceModuleNecessityType>

Necessity, i.e. the level of requirement, whether the module is mandatory or optional.

Enum Constant Summary

Enum Constants

Enum Constant	Description
OPTIONAL	The module is optional.
REQUIRED	The module is required.
REQUISITE	The module is required.
SUFFICIENT	The module is sufficient for authentication to succeed.

Method Summary

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

SUFFICIENT

public static final AuthenticationSequenceModuleNecessityType SUFFICIENT

The module is sufficient for authentication to succeed. It is NOT required to succeed. If this module succeeds, the evaluation stops. The result is a success. Other modules are NOT evaluated. (Except for the case when "required" module that was evaluated before has failed.) If this module fails, the evaluation continues. Other modules are evaluated.

REQUIRED

public static final AuthenticationSequenceModuleNecessityType REQUIRED

The module is required. The module must succeed for the entire sequence to be successful. If this module succeeds, the evaluation continues. Other modules are evaluated. If this module fails, the evaluation continues. Other modules are evaluated. Final result of authentication sequence is a failure.

REQUISITE

public static final AuthenticationSequenceModuleNecessityType REQUISITE

The module is required. The module must succeed for the entire sequence to be successful. If this module succeeds, the evaluation continues. Other modules are evaluated. If this module fails, the evaluation stops with an error. Other modules are NOT evaluated. Final result of authentication sequence is a failure.

OPTIONAL

public static final AuthenticationSequenceModuleNecessityType OPTIONAL

The module is optional. It is NOT required to succeed. Optional module does not really influence the result of the authentication. But it may be used to add some authentication attributes, it may be used to cross-authenticate is SSO realms and so on. If this module succeeds, the evaluation continues. If this module fails, the evaluation continues. The result of the sequence is a failure only if this is the only module in the sequence and it fails.

Method Detail

values

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

Returns:

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

valueOf

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

value

public String value()

fromValue

public static AuthenticationSequenceModuleNecessityType fromValue(String v)