Module io.helidon.security

Package io.helidon.security

Enum Class CompositeProviderFlag

java.lang.Object

java.lang.Enum<CompositeProviderFlag>

io.helidon.security.CompositeProviderFlag

All Implemented Interfaces:

Serializable, Comparable<CompositeProviderFlag>, Constable

public enum CompositeProviderFlag
extends Enum<CompositeProviderFlag>

Flag driving resolution of providers. If provider returns a FINISH state (either SecurityResponse.SecurityStatus.SUCCESS_FINISH or SecurityResponse.SecurityStatus.FAILURE_FINISH, the processing is finished with that status.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FORBIDDEN	Provider must not be successful for this request (e.g.
MAY_FAIL	Provider may fail, nothing happens if it does.
MUST_FAIL	Provider must fail.
OPTIONAL	Provider may succeed or abstain.
REQUIRED	Provider must succeed if called (if sufficient is before required, required is still ignored).
SUFFICIENT	If succeeds, no further providers are called, otherwise same as optional.

Method Summary

Modifier and Type	Method	Description
boolean	isValid(SecurityResponse.SecurityStatus status)	Check whether the status is valid for this flag.
static CompositeProviderFlag	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CompositeProviderFlag[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MAY_FAIL

public static final CompositeProviderFlag MAY_FAIL

Provider may fail, nothing happens if it does.

SUFFICIENT

public static final CompositeProviderFlag SUFFICIENT

If succeeds, no further providers are called, otherwise same as optional.

OPTIONAL

public static final CompositeProviderFlag OPTIONAL

Provider may succeed or abstain. If fails, no further providers are called and request fails.

REQUIRED

public static final CompositeProviderFlag REQUIRED

Provider must succeed if called (if sufficient is before required, required is still ignored).

FORBIDDEN

public static final CompositeProviderFlag FORBIDDEN

Provider must not be successful for this request (e.g. either it does not apply to this request, or it fails)

MUST_FAIL

public static final CompositeProviderFlag MUST_FAIL

Provider must fail.

Method Details

values

public static CompositeProviderFlag[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static CompositeProviderFlag valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isValid

public boolean isValid(SecurityResponse.SecurityStatus status)

Check whether the status is valid for this flag.

Parameters:

status - status as returned by a provider

Returns:

true if the status is supported by this flag and the processing should continue