Top Description Fields Constructors Methods
org.keycloak.representations.idm.authorization

public final Enum PolicyEnforcementMode

extends Enum<PolicyEnforcementMode>
implements EnumWithStableIndex
Class Inheritance
All Implemented Interfaces
org.keycloak.util.EnumWithStableIndex
Imports
java.util.Map, .Objects, org.keycloak.util.EnumWithStableIndex
The policy enforcement mode dictates how authorization requests are handled by the server.
Author
Pedro Igor

Field Summary

Modifier and TypeField and Description
private static final Map<Integer, PolicyEnforcementMode>
BY_ID

public static final PolicyEnforcementMode
DISABLED

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

public static final PolicyEnforcementMode
ENFORCING

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

public static final PolicyEnforcementMode
PERMISSIVE

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

private final int
stableIndex

Constructor Summary

AccessConstructor and Description
private
PolicyEnforcementMode(int stableIndex)

Method Summary

Modifier and TypeMethod and Description
public int
getStableIndex()

Implements org.keycloak.util.EnumWithStableIndex.getStableIndex.

public static PolicyEnforcementMode
valueOf(String name)

public static PolicyEnforcementMode
valueOfInteger(Integer id)

public static PolicyEnforcementMode[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

BY_IDback to summary
private static final Map<Integer, PolicyEnforcementMode> BY_ID
DISABLEDback to summary
public static final PolicyEnforcementMode DISABLED

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

ENFORCINGback to summary
public static final PolicyEnforcementMode ENFORCING

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

PERMISSIVEback to summary
public static final PolicyEnforcementMode PERMISSIVE

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

stableIndexback to summary
private final int stableIndex

Constructor Detail

PolicyEnforcementModeback to summary
private PolicyEnforcementMode(int stableIndex)

Method Detail

getStableIndexback to summary
public int getStableIndex()

Implements org.keycloak.util.EnumWithStableIndex.getStableIndex.

Returns:int

Doc from org.keycloak.util.EnumWithStableIndex.getStableIndex.

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).

Annotations
@Override
valueOfback to summary
public static PolicyEnforcementMode valueOf(String name)
valueOfIntegerback to summary
public static PolicyEnforcementMode valueOfInteger(Integer id)
valuesback to summary
public static PolicyEnforcementMode[] values()