io.micronaut.security.rules

Enum SecurityRuleResult

java.lang.Object

java.lang.Enum<SecurityRuleResult>

io.micronaut.security.rules.SecurityRuleResult

All Implemented Interfaces:

Serializable, Comparable<SecurityRuleResult>

public enum SecurityRuleResult
extends Enum<SecurityRuleResult>

The result of a security rule check.

Since:

1.0

Author:

James Kleeh

Enum Constant Summary

Enum Constants

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

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 Detail

values

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

Returns:

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

valueOf

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