io.quarkus.keycloak.pep.runtime

Class KeycloakPolicyEnforcerConfig.KeycloakConfigPolicyEnforcer

java.lang.Object

io.quarkus.keycloak.pep.runtime.KeycloakPolicyEnforcerConfig.KeycloakConfigPolicyEnforcer

Enclosing class:

KeycloakPolicyEnforcerConfig

public static class KeycloakPolicyEnforcerConfig.KeycloakConfigPolicyEnforcer
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeycloakPolicyEnforcerConfig.KeycloakConfigPolicyEnforcer.ClaimInformationPointConfig
static class	KeycloakPolicyEnforcerConfig.KeycloakConfigPolicyEnforcer.MethodConfig
static class	KeycloakPolicyEnforcerConfig.KeycloakConfigPolicyEnforcer.PathCacheConfig
static class	KeycloakPolicyEnforcerConfig.KeycloakConfigPolicyEnforcer.PathConfig

Field Summary

Fields

Modifier and Type	Field and Description
KeycloakPolicyEnforcerConfig.KeycloakConfigPolicyEnforcer.ClaimInformationPointConfig	claimInformationPoint Defines a set of one or more claims that must be resolved and pushed to the Keycloak server in order to make these claims available to policies
boolean	enable Enables policy enforcement.
org.keycloak.representations.adapters.config.PolicyEnforcerConfig.EnforcementMode	enforcementMode Specifies how policies are enforced.
boolean	httpMethodAsScope Specifies how scopes should be mapped to HTTP methods.
boolean	lazyLoadPaths Specifies how the adapter should fetch the server for resources associated with paths in your application.
KeycloakPolicyEnforcerConfig.KeycloakConfigPolicyEnforcer.PathCacheConfig	pathCache Defines how the policy enforcer should track associations between paths in your application and resources defined in Keycloak.
Map<String,KeycloakPolicyEnforcerConfig.KeycloakConfigPolicyEnforcer.PathConfig>	paths Specifies the paths to protect.

Constructor Summary

Constructors

Constructor and Description
KeycloakConfigPolicyEnforcer()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

enable

@ConfigItem
public boolean enable

Enables policy enforcement.

enforcementMode

@ConfigItem(defaultValue="enforcing")
public org.keycloak.representations.adapters.config.PolicyEnforcerConfig.EnforcementMode enforcementMode

Specifies how policies are enforced.

paths

@ConfigItem
public Map<String,KeycloakPolicyEnforcerConfig.KeycloakConfigPolicyEnforcer.PathConfig> paths

Specifies the paths to protect.

pathCache

@ConfigItem
public KeycloakPolicyEnforcerConfig.KeycloakConfigPolicyEnforcer.PathCacheConfig pathCache

Defines how the policy enforcer should track associations between paths in your application and resources defined in Keycloak. The cache is needed to avoid unnecessary requests to a Keycloak server by caching associations between paths and protected resources

lazyLoadPaths

@ConfigItem(defaultValue="true")
public boolean lazyLoadPaths

Specifies how the adapter should fetch the server for resources associated with paths in your application. If true, the policy enforcer is going to fetch resources on-demand accordingly with the path being requested

claimInformationPoint

@ConfigItem
public KeycloakPolicyEnforcerConfig.KeycloakConfigPolicyEnforcer.ClaimInformationPointConfig claimInformationPoint

Defines a set of one or more claims that must be resolved and pushed to the Keycloak server in order to make these claims available to policies

httpMethodAsScope

@ConfigItem
public boolean httpMethodAsScope

Specifies how scopes should be mapped to HTTP methods. If set to true, the policy enforcer will use the HTTP method from the current request to check whether or not access should be granted

Constructor Detail

KeycloakConfigPolicyEnforcer

public KeycloakConfigPolicyEnforcer()