org.keycloak.authorization.store.PolicyStore インタフェース

org.keycloak.authorization.store.PolicyStore 連携図

公開メンバ関数
Policy	create (AbstractPolicyRepresentation representation, ResourceServer resourceServer)
void	delete (String id)
Policy	findById (String id, String resourceServerId)
Policy	findByName (String name, String resourceServerId)
List< Policy >	findByResourceServer (String resourceServerId)
List< Policy >	findByResourceServer (Map< String, String[]> attributes, String resourceServerId, int firstResult, int maxResult)
List< Policy >	findByResource (String resourceId, String resourceServerId)
void	findByResource (String resourceId, String resourceServerId, Consumer< Policy > consumer)
List< Policy >	findByResourceType (String resourceType, String resourceServerId)
List< Policy >	findByScopeIds (List< String > scopeIds, String resourceServerId)
List< Policy >	findByScopeIds (List< String > scopeIds, String resourceId, String resourceServerId)
void	findByScopeIds (List< String > scopeIds, String resourceId, String resourceServerId, Consumer< Policy > consumer)
List< Policy >	findByType (String type, String resourceServerId)
List< Policy >	findDependentPolicies (String id, String resourceServerId)
void	findByResourceType (String type, String id, Consumer< Policy > policyConsumer)

詳解

A PolicyStore is responsible to manage the persistence of Policy instances.

著者

Pedro Igor

関数詳解

create()

Policy org.keycloak.authorization.store.PolicyStore.create	(	AbstractPolicyRepresentation	representation,
		ResourceServer	resourceServer
	)

Creates a new Policy instance. The new instance is not necessarily persisted though, which may require a call to the {#save} method to actually make it persistent.

引数

representation	the policy representation
resourceServer	the resource server to which this policy belongs

戻り値

a new instance of Policy

delete()

void org.keycloak.authorization.store.PolicyStore.delete

(

String

id

)

Deletes a policy from the underlying persistence mechanism.

引数

id	the id of the policy to delete

findById()

Policy org.keycloak.authorization.store.PolicyStore.findById	(	String	id,
		String	resourceServerId
	)

Returns a Policy with the given id

引数

id	the identifier of the policy
resourceServerId	the resource server id

戻り値

a policy with the given identifier.

findByName()

Policy org.keycloak.authorization.store.PolicyStore.findByName	(	String	name,
		String	resourceServerId
	)

Returns a Policy with the given name

引数

name	the name of the policy
resourceServerId	the resource server id

戻り値

a policy with the given name.

findByResource() [1/2]

List<Policy> org.keycloak.authorization.store.PolicyStore.findByResource	(	String	resourceId,
		String	resourceServerId
	)

Returns a list of Policy associated with a org.keycloak.authorization.core.model.Resource with the given resourceId.

引数

resourceId	the identifier of a resource
resourceServerId	the resource server id

戻り値

a list of policies associated with the given resource

findByResource() [2/2]

void org.keycloak.authorization.store.PolicyStore.findByResource	(	String	resourceId,
		String	resourceServerId,
		Consumer< Policy >	consumer
	)

findByResourceServer() [1/2]

List<Policy> org.keycloak.authorization.store.PolicyStore.findByResourceServer

(

String

resourceServerId

)

Returns a list of Policy associated with a ResourceServer with the given resourceServerId.

引数

resourceServerId

the identifier of a resource server

戻り値

a list of policies that belong to the given resource server

findByResourceServer() [2/2]

List<Policy> org.keycloak.authorization.store.PolicyStore.findByResourceServer	(	Map< String, String[]>	attributes,
		String	resourceServerId,
		int	firstResult,
		int	maxResult
	)

Returns a list of Policy associated with a ResourceServer with the given resourceServerId.

引数

attributes	a map holding the attributes that will be used as a filter
resourceServerId	the identifier of a resource server

戻り値

a list of policies that belong to the given resource server

findByResourceType() [1/2]

List<Policy> org.keycloak.authorization.store.PolicyStore.findByResourceType	(	String	resourceType,
		String	resourceServerId
	)

Returns a list of Policy associated with a org.keycloak.authorization.core.model.Resource with the given type.

引数

resourceType	the type of a resource
resourceServerId	the resource server id

戻り値

a list of policies associated with the given resource type

findByResourceType() [2/2]

void org.keycloak.authorization.store.PolicyStore.findByResourceType	(	String	type,
		String	id,
		Consumer< Policy >	policyConsumer
	)

findByScopeIds() [1/3]

List<Policy> org.keycloak.authorization.store.PolicyStore.findByScopeIds	(	List< String >	scopeIds,
		String	resourceServerId
	)

Returns a list of Policy associated with a org.keycloak.authorization.core.model.Scope with the given scopeIds.

引数

scopeIds	the id of the scopes
resourceServerId	the resource server id

戻り値

a list of policies associated with the given scopes

findByScopeIds() [2/3]

List<Policy> org.keycloak.authorization.store.PolicyStore.findByScopeIds	(	List< String >	scopeIds,
		String	resourceId,
		String	resourceServerId
	)

Returns a list of Policy associated with a org.keycloak.authorization.core.model.Scope with the given resourceId and scopeIds.

引数

scopeIds	the id of the scopes
resourceId	the id of the resource
resourceServerId	the resource server id

戻り値

a list of policies associated with the given scopes

findByScopeIds() [3/3]

void org.keycloak.authorization.store.PolicyStore.findByScopeIds	(	List< String >	scopeIds,
		String	resourceId,
		String	resourceServerId,
		Consumer< Policy >	consumer
	)

findByType()

List<Policy> org.keycloak.authorization.store.PolicyStore.findByType	(	String	type,
		String	resourceServerId
	)

Returns a list of Policy with the given type.

引数

type	the type of the policy
resourceServerId	the resource server id

戻り値

a list of policies with the given type

findDependentPolicies()

List<Policy> org.keycloak.authorization.store.PolicyStore.findDependentPolicies	(	String	id,
		String	resourceServerId
	)

Returns a list of Policy that depends on another policy with the given id.

引数

id	the id of the policy to query its dependents
resourceServerId	the resource server id

戻り値

a list of policies that depends on the a policy with the given identifier

---

このインタフェース詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/oidc-service/src/main/java/org/keycloak/authorization/store/PolicyStore.java