org.keycloak.storage.user.UserQueryProvider の継承関係図

org.keycloak.storage.user.UserQueryProvider 連携図

公開メンバ関数
int	getUsersCount (RealmModel realm)

default int	getUsersCount (RealmModel realm, boolean includeServiceAccount)

List< UserModel >	getUsers (RealmModel realm)

List< UserModel >	getUsers (RealmModel realm, int firstResult, int maxResults)

List< UserModel >	searchForUser (String search, RealmModel realm)

List< UserModel >	searchForUser (String search, RealmModel realm, int firstResult, int maxResults)

List< UserModel >	searchForUser (Map< String, String > params, RealmModel realm)

List< UserModel >	searchForUser (Map< String, String > params, RealmModel realm, int firstResult, int maxResults)

List< UserModel >	getGroupMembers (RealmModel realm, GroupModel group, int firstResult, int maxResults)

default List< UserModel >	getRoleMembers (RealmModel realm, RoleModel role)

default List< UserModel >	getRoleMembers (RealmModel realm, RoleModel role, int firstResult, int maxResults)

List< UserModel >	getGroupMembers (RealmModel realm, GroupModel group)

List< UserModel >	searchForUserByUserAttribute (String attrName, String attrValue, RealmModel realm)

詳解

Optional capability interface implemented by UserStorageProviders. Defines complex queries that are used to locate one or more users. You must implement this interface if you want to view and manager users from the administration console.

著者: Bill Burke

バージョン

Revision: 1

関数詳解

◆ getGroupMembers() [1/2]

List<UserModel> org.keycloak.storage.user.UserQueryProvider.getGroupMembers	(	RealmModel	realm,
		GroupModel	group,
		int	firstResult,
		int	maxResults
	)

Get users that belong to a specific group. Implementations do not have to search in UserFederatedStorageProvider as this is done automatically.

参照: org.keycloak.storage.federated.UserFederatedStorageProvider

引数

realm
group
firstResult
maxResults

戻り値

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.storage.UserStorageManager, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.ldap.LDAPStorageProviderで実装されています。

◆ getGroupMembers() [2/2]

List<UserModel> org.keycloak.storage.user.UserQueryProvider.getGroupMembers	(	RealmModel	realm,
		GroupModel	group
	)

Get users that belong to a specific group. Implementations do not have to search in UserFederatedStorageProvider as this is done automatically.

参照: org.keycloak.storage.federated.UserFederatedStorageProvider

引数

realm
group

戻り値

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManager, org.keycloak.storage.ldap.LDAPStorageProviderで実装されています。

◆ getRoleMembers() [1/2]

default List<UserModel> org.keycloak.storage.user.UserQueryProvider.getRoleMembers	(	RealmModel	realm,
		RoleModel	role
	)

inline

Get users that belong to a specific role.

引数

realm
role

戻り値

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManagerで実装されています。

     {
         return Collections.EMPTY_LIST;
     }

◆ getRoleMembers() [2/2]

default List<UserModel> org.keycloak.storage.user.UserQueryProvider.getRoleMembers	(	RealmModel	realm,
		RoleModel	role,
		int	firstResult,
		int	maxResults
	)

inline

Search for users that have a specific role with a specific roleId.

引数

firstResult
maxResults
role

戻り値

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.storage.UserStorageManager, org.keycloak.models.cache.infinispan.UserCacheSessionで実装されています。

     {
         return Collections.EMPTY_LIST;
     }

◆ getUsers() [1/2]

List<UserModel> org.keycloak.storage.user.UserQueryProvider.getUsers ( RealmModel realm )

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManager, org.keycloak.storage.ldap.LDAPStorageProviderで実装されています。

◆ getUsers() [2/2]

List<UserModel> org.keycloak.storage.user.UserQueryProvider.getUsers	(	RealmModel	realm,
		int	firstResult,
		int	maxResults
	)

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManager, org.keycloak.storage.ldap.LDAPStorageProviderで実装されています。

◆ getUsersCount() [1/2]

int org.keycloak.storage.user.UserQueryProvider.getUsersCount ( RealmModel realm )

Returns the number of users, without consider any service account.

引数

realm the realm

戻り値: the number of users

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManager, org.keycloak.storage.ldap.LDAPStorageProviderで実装されています。

◆ getUsersCount() [2/2]

default int org.keycloak.storage.user.UserQueryProvider.getUsersCount	(	RealmModel	realm,
		boolean	includeServiceAccount
	)

inline

Returns the number of users.

引数

realm	the realm
includeServiceAccount	if true, the number of users will also include service accounts. Otherwise, only the number of users.

戻り値: the number of users

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManagerで実装されています。

                                                                                {
         throw new RuntimeException("Not implemented");
     }

◆ searchForUser() [1/4]

List<UserModel> org.keycloak.storage.user.UserQueryProvider.searchForUser	(	String	search,
		RealmModel	realm
	)

Search for users with username, email or first + last name that is like search string.

If possible, implementations should treat the parameter values as partial match patterns i.e. in RDMBS terms use LIKE.

This method is used by the admin console search box

引数

search
realm

戻り値

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManager, org.keycloak.storage.ldap.LDAPStorageProviderで実装されています。

◆ searchForUser() [2/4]

List<UserModel> org.keycloak.storage.user.UserQueryProvider.searchForUser	(	String	search,
		RealmModel	realm,
		int	firstResult,
		int	maxResults
	)

Search for users with username, email or first + last name that is like search string.

If possible, implementations should treat the parameter values as partial match patterns i.e. in RDMBS terms use LIKE.

This method is used by the admin console search box

引数

search
realm
firstResult
maxResults

戻り値

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManager, org.keycloak.storage.ldap.LDAPStorageProviderで実装されています。

◆ searchForUser() [3/4]

List<UserModel> org.keycloak.storage.user.UserQueryProvider.searchForUser	(	Map< String, String >	params,
		RealmModel	realm
	)

Search for user by parameter. Valid parameters are: "first" - first name "last" - last name "email" - email "username" - username

If possible, implementations should treat the parameter values as partial match patterns i.e. in RDMBS terms use LIKE.

This method is used by the REST API when querying users.

引数

params
realm

戻り値

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManager, org.keycloak.storage.ldap.LDAPStorageProviderで実装されています。

◆ searchForUser() [4/4]

List<UserModel> org.keycloak.storage.user.UserQueryProvider.searchForUser	(	Map< String, String >	params,
		RealmModel	realm,
		int	firstResult,
		int	maxResults
	)

Search for user by parameter. Valid parameters are: "first" - first name "last" - last name "email" - email "username" - username

If possible, implementations should treat the parameter values as patterns i.e. in RDMBS terms use LIKE. This method is used by the REST API when querying users.

引数

params
realm
firstResult
maxResults

戻り値

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManager, org.keycloak.storage.ldap.LDAPStorageProviderで実装されています。

◆ searchForUserByUserAttribute()

List<UserModel> org.keycloak.storage.user.UserQueryProvider.searchForUserByUserAttribute	(	String	attrName,
		String	attrValue,
		RealmModel	realm
	)

Search for users that have a specific attribute with a specific value. Implementations do not have to search in UserFederatedStorageProvider as this is done automatically.

参照: org.keycloak.storage.federated.UserFederatedStorageProvider

引数

attrName
attrValue
realm

戻り値

org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManager, org.keycloak.storage.ldap.LDAPStorageProviderで実装されています。

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

D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/storage/user/UserQueryProvider.java

公開メンバ関数

詳解

関数詳解

◆ getGroupMembers() [1/2]

◆ getGroupMembers() [2/2]

◆ getRoleMembers() [1/2]

◆ getRoleMembers() [2/2]

◆ getUsers() [1/2]

◆ getUsers() [2/2]

◆ getUsersCount() [1/2]

◆ getUsersCount() [2/2]

◆ searchForUser() [1/4]

◆ searchForUser() [2/4]

◆ searchForUser() [3/4]

◆ searchForUser() [4/4]

◆ searchForUserByUserAttribute()