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

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

公開メンバ関数
Scope	create (String name, ResourceServer resourceServer)
Scope	create (String id, String name, ResourceServer resourceServer)
void	delete (String id)
Scope	findById (String id, String resourceServerId)
Scope	findByName (String name, String resourceServerId)
List< Scope >	findByResourceServer (String id)
List< Scope >	findByResourceServer (Map< String, String[]> attributes, String resourceServerId, int firstResult, int maxResult)

詳解

A ScopeStore is responsible to manage the persistence of Scope instances.

著者

Pedro Igor

関数詳解

create() [1/2]

Scope org.keycloak.authorization.store.ScopeStore.create	(	String	name,
		ResourceServer	resourceServer
	)

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

引数

name	the name of the scope
resourceServer	the resource server to which this scope belongs

戻り値

a new instance of Scope

create() [2/2]

Scope org.keycloak.authorization.store.ScopeStore.create	(	String	id,
		String	name,
		ResourceServer	resourceServer
	)

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

引数

id	the id of the scope
name	the name of the scope
resourceServer	the resource server to which this scope belongs

戻り値

a new instance of Scope

delete()

void org.keycloak.authorization.store.ScopeStore.delete

(

String

id

)

Deletes a scope from the underlying persistence mechanism.

引数

id	the id of the scope to delete

findById()

Scope org.keycloak.authorization.store.ScopeStore.findById	(	String	id,
		String	resourceServerId
	)

Returns a Scope with the given id

引数

id	the identifier of the scope
resourceServerId	the resource server id

戻り値

a scope with the given identifier.

findByName()

Scope org.keycloak.authorization.store.ScopeStore.findByName	(	String	name,
		String	resourceServerId
	)

Returns a Scope with the given name

引数

name	the name of the scope
resourceServerId	the resource server id

戻り値

a scope with the given name.

findByResourceServer() [1/2]

List<Scope> org.keycloak.authorization.store.ScopeStore.findByResourceServer

(

String

id

)

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

引数

resourceServerId

the identifier of a resource server

戻り値

a list of scopes that belong to the given resource server

findByResourceServer() [2/2]

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

Returns a list of Scope 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 scopes that belong to the given resource server

---

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

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