Enum Class PolicyEnforcementMode

java.lang.Object
java.lang.Enum<PolicyEnforcementMode>
org.keycloak.representations.idm.authorization.PolicyEnforcementMode
All Implemented Interfaces:
Serializable, Comparable<PolicyEnforcementMode>, Constable, EnumWithStableIndex

public enum PolicyEnforcementMode extends Enum<PolicyEnforcementMode> implements EnumWithStableIndex
The policy enforcement mode dictates how authorization requests are handled by the server.
Author:
Pedro Igor
  • Enum Constant Details

    • ENFORCING

      public static final PolicyEnforcementMode ENFORCING
      Requests are denied by default even when there is no policy associated with a given resource.
    • PERMISSIVE

      public static final PolicyEnforcementMode PERMISSIVE
      Requests are allowed even when there is no policy associated with a given resource.
    • DISABLED

      public static final PolicyEnforcementMode DISABLED
      Completely disables the evaluation of policies and allow access to any resource.
  • Method Details

    • values

      public static PolicyEnforcementMode[] 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 PolicyEnforcementMode 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
    • getStableIndex

      public int getStableIndex()
      Specified by:
      getStableIndex in interface EnumWithStableIndex
      Returns:
      Unique numeric index which is stable in time and identifies an instance. Reusing the same index for two distinct entries of the same class is forbidden even if they cannot exist at the same time (e.g. one is deleted before other is introduced).
    • valueOfInteger

      public static PolicyEnforcementMode valueOfInteger(Integer id)