Package io.micronaut.security.rules

Enum Class SecurityRuleResult

java.lang.Object

java.lang.Enum<SecurityRuleResult>

io.micronaut.security.rules.SecurityRuleResult

All Implemented Interfaces:

Serializable, Comparable<SecurityRuleResult>, Constable

public enum SecurityRuleResult
extends Enum<SecurityRuleResult>

The result of a security rule check.

Since:

1.0

Author:

James Kleeh

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
ALLOWED	The rule explicitly allows this request.
REJECTED	The rule explicitly rejects this request.
UNKNOWN	The rule has no information to make the determination.

Method Summary

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

ALLOWED

public static final SecurityRuleResult ALLOWED

The rule explicitly allows this request.

REJECTED

public static final SecurityRuleResult REJECTED

The rule explicitly rejects this request.

UNKNOWN

public static final SecurityRuleResult UNKNOWN

The rule has no information to make the determination.

Method Details

values

public static SecurityRuleResult[] 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 SecurityRuleResult 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