Package org.keycloak.authorization.policy.provider.user

Class UserPolicyProvider

java.lang.Object

org.keycloak.authorization.policy.provider.user.UserPolicyProvider

All Implemented Interfaces:

PartialEvaluationPolicyProvider, PolicyProvider, Provider

public class UserPolicyProvider
extends Object
implements PolicyProvider, PartialEvaluationPolicyProvider

Author:

Pedro Igor

Constructor Summary

Constructors

Constructor	Description
UserPolicyProvider(BiFunction<Policy,AuthorizationProvider,UserPolicyRepresentation> representationFunction)

Method Summary

Modifier and Type	Method	Description
void	close()
void	evaluate(Evaluation evaluation)
boolean	evaluate(KeycloakSession session, Policy policy, UserModel adminUser)	Evaluate if the given policy grants access to the given subject.
Stream<Policy>	getPermissions(KeycloakSession session, ResourceType resourceType, UserModel subject)	Returns a list of Policy instances representing the permissions that apply to a given subject when partially evaluating the realm resources that can be accessed.
boolean	supports(Policy policy)	If partial evaluation is supported for the given policy.

Methods inherited from class java.lang.Object

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

Constructor Details

UserPolicyProvider

public UserPolicyProvider(BiFunction<Policy,AuthorizationProvider,UserPolicyRepresentation> representationFunction)

Method Details

evaluate

public void evaluate(Evaluation evaluation)

Specified by:

evaluate in interface PolicyProvider

getPermissions

public Stream<Policy> getPermissions(KeycloakSession session,
 ResourceType resourceType,
 UserModel subject)

Description copied from interface: PartialEvaluationPolicyProvider

Returns a list of Policy instances representing the permissions that apply to a given subject when partially evaluating the realm resources that can be accessed.

Specified by:

getPermissions in interface PartialEvaluationPolicyProvider

Parameters:

session - the session

resourceType - the type of the resource

subject - the subject

Returns:

the permissions that apply to the given subject

evaluate

public boolean evaluate(KeycloakSession session,
 Policy policy,
 UserModel adminUser)

Description copied from interface: PartialEvaluationPolicyProvider

Evaluate if the given policy grants access to the given subject.

Specified by:

evaluate in interface PartialEvaluationPolicyProvider

Parameters:

session - the session

policy - the policy

adminUser - the subject

Returns:

true if access is granted. Otherwise, returns false

supports

public boolean supports(Policy policy)

Description copied from interface: PartialEvaluationPolicyProvider

If partial evaluation is supported for the given policy.

Specified by:

supports in interface PartialEvaluationPolicyProvider

Parameters:

policy - the policy

Returns:

true if supported. Otherwise, returns false

close

public void close()

Specified by:

close in interface Provider