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

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

公開メンバ関数
Resource	create (String name, ResourceServer resourceServer, String owner)
Resource	create (String id, String name, ResourceServer resourceServer, String owner)
void	delete (String id)
Resource	findById (String id, String resourceServerId)
List< Resource >	findByOwner (String ownerId, String resourceServerId)
void	findByOwner (String ownerId, String resourceServerId, Consumer< Resource > consumer)
List< Resource >	findByUri (String uri, String resourceServerId)
List< Resource >	findByResourceServer (String resourceServerId)
List< Resource >	findByResourceServer (Map< String, String[]> attributes, String resourceServerId, int firstResult, int maxResult)
List< Resource >	findByScope (List< String > id, String resourceServerId)
void	findByScope (List< String > scopes, String resourceServerId, Consumer< Resource > consumer)
Resource	findByName (String name, String resourceServerId)
Resource	findByName (String name, String ownerId, String resourceServerId)
List< Resource >	findByType (String type, String resourceServerId)
void	findByType (String type, String resourceServerId, Consumer< Resource > consumer)

詳解

A ResourceStore is responsible to manage the persistence of Resource instances.

著者

Pedro Igor

関数詳解

create() [1/2]

Resource org.keycloak.authorization.store.ResourceStore.create	(	String	name,
		ResourceServer	resourceServer,
		String	owner
	)

Creates a Resource instance backed by this persistent storage implementation.

引数

name	the name of this resource. It must be unique.
resourceServer	the resource server to where the given resource belongs to
owner	the owner of this resource or null if the resource server is the owner

戻り値

an instance backed by the underlying storage implementation

create() [2/2]

Resource org.keycloak.authorization.store.ResourceStore.create	(	String	id,
		String	name,
		ResourceServer	resourceServer,
		String	owner
	)

Creates a Resource instance backed by this persistent storage implementation.

引数

id	the id of this resource. It must be unique.
name	the name of this resource. It must be unique.
resourceServer	the resource server to where the given resource belongs to
owner	the owner of this resource or null if the resource server is the owner

戻り値

an instance backed by the underlying storage implementation

delete()

void org.keycloak.authorization.store.ResourceStore.delete

(

String

id

)

Removes a Resource instance, with the given

id 

from the persistent storage.

引数

id	the identifier of an existing resource instance

findById()

Resource org.keycloak.authorization.store.ResourceStore.findById	(	String	id,
		String	resourceServerId
	)

Returns a Resource instance based on its identifier.

引数

id	the identifier of an existing resource instance

戻り値

the resource instance with the given identifier or null if no instance was found

findByName() [1/2]

Resource org.keycloak.authorization.store.ResourceStore.findByName	(	String	name,
		String	resourceServerId
	)

Find a Resource by its name where the owner is the resource server itself.

引数

name	the name of the resource
resourceServerId	the identifier of the resource server

戻り値

a resource with the given name

findByName() [2/2]

Resource org.keycloak.authorization.store.ResourceStore.findByName	(	String	name,
		String	ownerId,
		String	resourceServerId
	)

Find a Resource by its name where the owner is the given ownerId.

引数

name	the name of the resource
ownerId	the owner id
resourceServerId	the identifier of the resource server

戻り値

a resource with the given name

findByOwner() [1/2]

List<Resource> org.keycloak.authorization.store.ResourceStore.findByOwner	(	String	ownerId,
		String	resourceServerId
	)

Finds all Resource instances with the given

ownerId 

.

引数

ownerId

the identifier of the owner

戻り値

a list with all resource instances owned by the given owner

findByOwner() [2/2]

void org.keycloak.authorization.store.ResourceStore.findByOwner	(	String	ownerId,
		String	resourceServerId,
		Consumer< Resource >	consumer
	)

findByResourceServer() [1/2]

List<Resource> org.keycloak.authorization.store.ResourceStore.findByResourceServer

(

String

resourceServerId

)

Finds all Resource instances associated with a given resource server.

引数

resourceServerId

the identifier of the resource server

戻り値

a list with all resources associated with the given resource server

findByResourceServer() [2/2]

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

Finds all Resource instances associated with a given resource server.

引数

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

戻り値

a list with all resources associated with the given resource server

findByScope() [1/2]

List<Resource> org.keycloak.authorization.store.ResourceStore.findByScope	(	List< String >	id,
		String	resourceServerId
	)

Finds all Resource associated with a given scope.

引数

id	one or more scope identifiers

戻り値

a list of resources associated with the given scope(s)

findByScope() [2/2]

void org.keycloak.authorization.store.ResourceStore.findByScope	(	List< String >	scopes,
		String	resourceServerId,
		Consumer< Resource >	consumer
	)

findByType() [1/2]

List<Resource> org.keycloak.authorization.store.ResourceStore.findByType	(	String	type,
		String	resourceServerId
	)

Finds all Resource with the given type.

引数

type	the type of the resource

戻り値

a list of resources with the given type

findByType() [2/2]

void org.keycloak.authorization.store.ResourceStore.findByType	(	String	type,
		String	resourceServerId,
		Consumer< Resource >	consumer
	)

Finds all Resource with the given type.

引数

type	the type of the resource
resourceServerId	the resource server id
consumer	the result consumer

戻り値

a list of resources with the given type

findByUri()

List<Resource> org.keycloak.authorization.store.ResourceStore.findByUri	(	String	uri,
		String	resourceServerId
	)

Finds all Resource instances with the given uri.

引数

uri	the identifier of the uri

戻り値

a list with all resource instances owned by the given owner

---

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

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