Package io.micronaut.security.rules

Enum SecurityRuleResult

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SecurityRuleResult>
    public enum SecurityRuleResult
extends java.lang.Enum<SecurityRuleResult>
    The result of a security rule check.
    Since:
    1.0
    Author:
    James Kleeh

    • 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

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static SecurityRuleResult valueOf​(java.lang.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​(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