Package org.keycloak.authorization.admin

Class PolicyService

java.lang.Object

org.keycloak.authorization.admin.PolicyService

Direct Known Subclasses:

PermissionService, PolicyTypeService

public class PolicyService
extends Object

Author:

Pedro Igor

Field Summary

Fields

Modifier and Type	Field	Description
protected final AdminEventBuilder	adminEvent
protected final AdminPermissionEvaluator	auth
protected final org.keycloak.authorization.AuthorizationProvider	authorization
protected final org.keycloak.authorization.model.ResourceServer	resourceServer

Constructor Summary

Constructors

Constructor	Description
PolicyService(org.keycloak.authorization.model.ResourceServer resourceServer, org.keycloak.authorization.AuthorizationProvider authorization, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	create(String payload)
org.keycloak.authorization.model.Policy	create(org.keycloak.representations.idm.authorization.AbstractPolicyRepresentation representation)
protected Object	doCreatePolicyResource(org.keycloak.authorization.model.Policy policy)
protected PolicyTypeService	doCreatePolicyTypeResource(String type)
protected org.keycloak.representations.idm.authorization.AbstractPolicyRepresentation	doCreateRepresentation(String payload)
protected List<Object>	doSearch(Integer firstResult, Integer maxResult, String fields, Map<org.keycloak.authorization.model.Policy.FilterOption,String[]> filters)
jakarta.ws.rs.core.Response	findAll(String id, String name, String type, String resourceType, String resource, String scope, Boolean permission, String owner, String fields, Integer firstResult, Integer maxResult)
jakarta.ws.rs.core.Response	findByName(String name, String fields)
jakarta.ws.rs.core.Response	findPolicyProviders()
PolicyEvaluationService	getPolicyEvaluateResource()
protected org.keycloak.authorization.policy.provider.PolicyProviderAdminService	getPolicyProviderAdminResource(String policyType)
protected org.keycloak.authorization.policy.provider.PolicyProviderFactory	getPolicyProviderFactory(String policyType)
Object	getResource(String type)
protected org.keycloak.representations.idm.authorization.AbstractPolicyRepresentation	toRepresentation(org.keycloak.authorization.model.Policy model, String fields, org.keycloak.authorization.AuthorizationProvider authorization)

Methods inherited from class java.lang.Object

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

Field Details

resourceServer

protected final org.keycloak.authorization.model.ResourceServer resourceServer

authorization

protected final org.keycloak.authorization.AuthorizationProvider authorization

auth

protected final AdminPermissionEvaluator auth

adminEvent

protected final AdminEventBuilder adminEvent

Constructor Details

PolicyService

public PolicyService(org.keycloak.authorization.model.ResourceServer resourceServer,
 org.keycloak.authorization.AuthorizationProvider authorization,
 AdminPermissionEvaluator auth,
 AdminEventBuilder adminEvent)

Method Details

getResource

@Path("{type}")
public Object getResource(@PathParam("type")
 String type)

doCreatePolicyTypeResource

protected PolicyTypeService doCreatePolicyTypeResource(String type)

doCreatePolicyResource

protected Object doCreatePolicyResource(org.keycloak.authorization.model.Policy policy)

create

@POST
@Consumes("application/json")
@Produces("application/json")
public jakarta.ws.rs.core.Response create(String payload)

doCreateRepresentation

protected org.keycloak.representations.idm.authorization.AbstractPolicyRepresentation doCreateRepresentation(String payload)

create

public org.keycloak.authorization.model.Policy create(org.keycloak.representations.idm.authorization.AbstractPolicyRepresentation representation)

findByName

@Path("/search")
@GET
@Produces("application/json")
public jakarta.ws.rs.core.Response findByName(@QueryParam("name")
 String name,
 @QueryParam("fields")
 String fields)

findAll

@GET
@Produces("application/json")
public jakarta.ws.rs.core.Response findAll(@QueryParam("policyId")
 String id,
 @QueryParam("name")
 String name,
 @QueryParam("type")
 String type,
 @QueryParam("resourceType")
 String resourceType,
 @QueryParam("resource")
 String resource,
 @QueryParam("scope")
 String scope,
 @QueryParam("permission")
 Boolean permission,
 @QueryParam("owner")
 String owner,
 @QueryParam("fields")
 String fields,
 @QueryParam("first")
 Integer firstResult,
 @QueryParam("max") @DefaultValue("100")
 Integer maxResult)

toRepresentation

protected org.keycloak.representations.idm.authorization.AbstractPolicyRepresentation toRepresentation(org.keycloak.authorization.model.Policy model,
 String fields,
 org.keycloak.authorization.AuthorizationProvider authorization)

doSearch

protected List<Object> doSearch(Integer firstResult,
 Integer maxResult,
 String fields,
 Map<org.keycloak.authorization.model.Policy.FilterOption,String[]> filters)

findPolicyProviders

@Path("providers")
@GET
@Produces("application/json")
public jakarta.ws.rs.core.Response findPolicyProviders()

getPolicyEvaluateResource

@Path("evaluate")
public PolicyEvaluationService getPolicyEvaluateResource()

getPolicyProviderAdminResource

protected org.keycloak.authorization.policy.provider.PolicyProviderAdminService getPolicyProviderAdminResource(String policyType)

getPolicyProviderFactory

protected org.keycloak.authorization.policy.provider.PolicyProviderFactory getPolicyProviderFactory(String policyType)