org.keycloak.authorization.model

Enum ResourceServer.PolicyEnforcementMode

java.lang.Object

java.lang.Enum<ResourceServer.PolicyEnforcementMode>

org.keycloak.authorization.model.ResourceServer.PolicyEnforcementMode

All Implemented Interfaces:

Serializable, Comparable<ResourceServer.PolicyEnforcementMode>

Enclosing interface:

ResourceServer

public static enum ResourceServer.PolicyEnforcementMode
extends Enum<ResourceServer.PolicyEnforcementMode>

The policy enforcement mode dictates how authorization requests are handled by the server.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED Completely disables the evaluation of policies and allow access to any resource.
ENFORCING Requests are denied by default even when there is no policy associated with a given resource.
PERMISSIVE Requests are allowed even when there is no policy associated with a given resource.

Method Summary

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

ENFORCING

public static final ResourceServer.PolicyEnforcementMode ENFORCING

Requests are denied by default even when there is no policy associated with a given resource.

PERMISSIVE

public static final ResourceServer.PolicyEnforcementMode PERMISSIVE

Requests are allowed even when there is no policy associated with a given resource.

DISABLED

public static final ResourceServer.PolicyEnforcementMode DISABLED

Completely disables the evaluation of policies and allow access to any resource.

Method Detail

values

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

Returns:

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

valueOf

public static ResourceServer.PolicyEnforcementMode 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