org.keycloak.models.cache.UserCache の継承関係図

org.keycloak.models.cache.UserCache 連携図

公開メンバ関数
void	evict (RealmModel realm, UserModel user)

void	evict (RealmModel realm)

void	clear ()

void	addFederatedIdentity (RealmModel realm, UserModel user, FederatedIdentityModel socialLink)

boolean	removeFederatedIdentity (RealmModel realm, UserModel user, String socialProvider)

void	updateFederatedIdentity (RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)

Set< FederatedIdentityModel >	getFederatedIdentities (UserModel user, RealmModel realm)

FederatedIdentityModel	getFederatedIdentity (UserModel user, String socialProvider, RealmModel realm)

UserModel	getUserByFederatedIdentity (FederatedIdentityModel socialLink, RealmModel realm)

void	addConsent (RealmModel realm, String userId, UserConsentModel consent)

UserConsentModel	getConsentByClient (RealmModel realm, String userId, String clientInternalId)

List< UserConsentModel >	getConsents (RealmModel realm, String userId)

void	updateConsent (RealmModel realm, String userId, UserConsentModel consent)

boolean	revokeConsentForClient (RealmModel realm, String userId, String clientInternalId)

void	setNotBeforeForUser (RealmModel realm, UserModel user, int notBefore)

int	getNotBeforeOfUser (RealmModel realm, UserModel user)

UserModel	getServiceAccount (ClientModel client)

List< UserModel >	getUsers (RealmModel realm, boolean includeServiceAccounts)

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

List< UserModel >	getUsers (RealmModel realm)

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

UserModel	addUser (RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions)

UserModel	addUser (RealmModel realm, String username)

void	preRemove (RealmModel realm)

void	preRemove (RealmModel realm, RoleModel role)

void	preRemove (RealmModel realm, GroupModel group)

void	preRemove (RealmModel realm, ClientModel client)

void	preRemove (ProtocolMapperModel protocolMapper)

void	preRemove (ClientScopeModel clientScope)

void	preRemove (RealmModel realm, ComponentModel component)

void	removeImportedUsers (RealmModel realm, String storageProviderId)

void	unlinkUsers (RealmModel realm, String storageProviderId)

void	close ()

UserModel	getUserById (String id, RealmModel realm)

UserModel	getUserByUsername (String username, RealmModel realm)

UserModel	getUserByEmail (String email, RealmModel realm)

int	getUsersCount (RealmModel realm)

default int	getUsersCount (RealmModel realm, boolean includeServiceAccount)

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)

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

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

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

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

boolean	removeUser (RealmModel realm, UserModel user)

void	grantToAllUsers (RealmModel realm, RoleModel role)

詳解

All these methods effect an entire cluster of Keycloak instances.

著者: Bill Burke

バージョン

Revision: 1

関数詳解

◆ addConsent()

void org.keycloak.models.UserProvider.addConsent	(	RealmModel	realm,
		String	userId,
		UserConsentModel	consent
	)

inherited

◆ addFederatedIdentity()

void org.keycloak.models.UserProvider.addFederatedIdentity	(	RealmModel	realm,
		UserModel	user,
		FederatedIdentityModel	socialLink
	)

inherited

◆ addUser() [1/2]

UserModel org.keycloak.storage.user.UserRegistrationProvider.addUser	(	RealmModel	realm,
		String	username
	)

inherited

All storage providers that implement this interface will be looped through. If this method returns null, then the next storage provider's addUser() method will be called. If no storage providers handle the add, then the user will be created in local storage.

Returning null is useful when you want optional support for adding users. For example, our LDAP provider can enable and disable the ability to add users.

引数

realm
username

戻り値

◆ addUser() [2/2]

UserModel org.keycloak.models.UserProvider.addUser	(	RealmModel	realm,
		String	id,
		String	username,
		boolean	addDefaultRoles,
		boolean	addDefaultRequiredActions
	)

inherited

only used for local storage

引数

realm
id
username
addDefaultRoles
addDefaultRequiredActions

戻り値

◆ clear()

void org.keycloak.models.cache.UserCache.clear ( )

Clear cache entirely.

◆ close()

void org.keycloak.models.UserProvider.close ( )

inherited

org.keycloak.provider.Providerを実装しています。

◆ evict() [1/2]

void org.keycloak.models.cache.UserCache.evict	(	RealmModel	realm,
		UserModel	user
	)

Evict user from cache.

引数

user

◆ evict() [2/2]

void org.keycloak.models.cache.UserCache.evict ( RealmModel realm )

Evict users of a specific realm

引数

realm

◆ getConsentByClient()

UserConsentModel org.keycloak.models.UserProvider.getConsentByClient	(	RealmModel	realm,
		String	userId,
		String	clientInternalId
	)

inherited

◆ getConsents()

List<UserConsentModel> org.keycloak.models.UserProvider.getConsents	(	RealmModel	realm,
		String	userId
	)

inherited

◆ getFederatedIdentities()

Set<FederatedIdentityModel> org.keycloak.models.UserProvider.getFederatedIdentities	(	UserModel	user,
		RealmModel	realm
	)

inherited

◆ getFederatedIdentity()

FederatedIdentityModel org.keycloak.models.UserProvider.getFederatedIdentity	(	UserModel	user,
		String	socialProvider,
		RealmModel	realm
	)

inherited

◆ getGroupMembers() [1/2]

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

inherited

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

戻り値

◆ getGroupMembers() [2/2]

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

inherited

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

戻り値

◆ getNotBeforeOfUser()

int org.keycloak.models.UserProvider.getNotBeforeOfUser	(	RealmModel	realm,
		UserModel	user
	)

inherited

◆ getRoleMembers() [1/2]

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

inlineinherited

Get users that belong to a specific role.

引数

realm
role

戻り値

     {
         return Collections.EMPTY_LIST;
     }

◆ getRoleMembers() [2/2]

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

inlineinherited

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

引数

firstResult
maxResults
role

戻り値

     {
         return Collections.EMPTY_LIST;
     }

◆ getServiceAccount()

UserModel org.keycloak.models.UserProvider.getServiceAccount ( ClientModel client )

inherited

◆ getUserByEmail()

UserModel org.keycloak.storage.user.UserLookupProvider.getUserByEmail	(	String	email,
		RealmModel	realm
	)

inherited

◆ getUserByFederatedIdentity()

UserModel org.keycloak.models.UserProvider.getUserByFederatedIdentity	(	FederatedIdentityModel	socialLink,
		RealmModel	realm
	)

inherited

◆ getUserById()

UserModel org.keycloak.storage.user.UserLookupProvider.getUserById	(	String	id,
		RealmModel	realm
	)

inherited

◆ getUserByUsername()

UserModel org.keycloak.storage.user.UserLookupProvider.getUserByUsername	(	String	username,
		RealmModel	realm
	)

inherited

◆ getUsers() [1/4]

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

inherited

◆ getUsers() [2/4]

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

inherited

◆ getUsers() [3/4]

List<UserModel> org.keycloak.models.UserProvider.getUsers	(	RealmModel	realm,
		boolean	includeServiceAccounts
	)

inherited

◆ getUsers() [4/4]

List<UserModel> org.keycloak.models.UserProvider.getUsers	(	RealmModel	realm,
		int	firstResult,
		int	maxResults,
		boolean	includeServiceAccounts
	)

inherited

◆ getUsersCount() [1/2]

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

inherited

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

引数

realm the realm

戻り値: the number of users

◆ getUsersCount() [2/2]

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

inlineinherited

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

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

◆ grantToAllUsers()

void org.keycloak.storage.user.UserBulkUpdateProvider.grantToAllUsers	(	RealmModel	realm,
		RoleModel	role
	)

inherited

◆ preRemove() [1/7]

void org.keycloak.models.UserProvider.preRemove ( RealmModel realm )

inherited

◆ preRemove() [2/7]

void org.keycloak.models.UserProvider.preRemove	(	RealmModel	realm,
		RoleModel	role
	)

inherited

◆ preRemove() [3/7]

void org.keycloak.models.UserProvider.preRemove	(	RealmModel	realm,
		GroupModel	group
	)

inherited

◆ preRemove() [4/7]

void org.keycloak.models.UserProvider.preRemove	(	RealmModel	realm,
		ClientModel	client
	)

inherited

◆ preRemove() [5/7]

void org.keycloak.models.UserProvider.preRemove ( ProtocolMapperModel protocolMapper )

inherited

◆ preRemove() [6/7]

void org.keycloak.models.UserProvider.preRemove ( ClientScopeModel clientScope )

inherited

◆ preRemove() [7/7]

void org.keycloak.models.UserProvider.preRemove	(	RealmModel	realm,
		ComponentModel	component
	)

inherited

◆ removeFederatedIdentity()

boolean org.keycloak.models.UserProvider.removeFederatedIdentity	(	RealmModel	realm,
		UserModel	user,
		String	socialProvider
	)

inherited

◆ removeImportedUsers()

void org.keycloak.models.UserProvider.removeImportedUsers	(	RealmModel	realm,
		String	storageProviderId
	)

inherited

Removes any imported users from a specific User Storage Provider.

引数

realm
storageProviderId

◆ removeUser()

boolean org.keycloak.storage.user.UserRegistrationProvider.removeUser	(	RealmModel	realm,
		UserModel	user
	)

inherited

Called if user originated from this provider.

If a local user is linked to this provider, this method will be called before local storage's removeUser() method is invoked.

If you are using an import strategy, and this is a local user linked to this provider, this method will be called before local storage's removeUser() method is invoked. Also, you DO NOT need to remove the imported user. The runtime will handle this for you.

引数

realm
user

戻り値

◆ revokeConsentForClient()

boolean org.keycloak.models.UserProvider.revokeConsentForClient	(	RealmModel	realm,
		String	userId,
		String	clientInternalId
	)

inherited

◆ searchForUser() [1/4]

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

inherited

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

戻り値

◆ searchForUser() [2/4]

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

inherited

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

戻り値

◆ searchForUser() [3/4]

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

inherited

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

戻り値

◆ searchForUser() [4/4]

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

inherited

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

戻り値

◆ searchForUserByUserAttribute()

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

inherited

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

戻り値

◆ setNotBeforeForUser()

void org.keycloak.models.UserProvider.setNotBeforeForUser	(	RealmModel	realm,
		UserModel	user,
		int	notBefore
	)

inherited

◆ unlinkUsers()

void org.keycloak.models.UserProvider.unlinkUsers	(	RealmModel	realm,
		String	storageProviderId
	)

inherited

Set federation link to null to imported users of a specific User Storage Provider

引数

realm
storageProviderId

◆ updateConsent()

void org.keycloak.models.UserProvider.updateConsent	(	RealmModel	realm,
		String	userId,
		UserConsentModel	consent
	)

inherited

◆ updateFederatedIdentity()

void org.keycloak.models.UserProvider.updateFederatedIdentity	(	RealmModel	realm,
		UserModel	federatedUser,
		FederatedIdentityModel	federatedIdentityModel
	)

inherited

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

D:/AppData/doxygen/keycloak/spi/src/server-spi/src/main/java/org/keycloak/models/cache/UserCache.java

公開メンバ関数

詳解

関数詳解

◆ addConsent()

◆ addFederatedIdentity()

◆ addUser() [1/2]

◆ addUser() [2/2]

◆ clear()

◆ close()

◆ evict() [1/2]

◆ evict() [2/2]

◆ getConsentByClient()

◆ getConsents()

◆ getFederatedIdentities()

◆ getFederatedIdentity()

◆ getGroupMembers() [1/2]

◆ getGroupMembers() [2/2]

◆ getNotBeforeOfUser()

◆ getRoleMembers() [1/2]

◆ getRoleMembers() [2/2]

◆ getServiceAccount()

◆ getUserByEmail()

◆ getUserByFederatedIdentity()

◆ getUserById()

◆ getUserByUsername()

◆ getUsers() [1/4]

◆ getUsers() [2/4]

◆ getUsers() [3/4]

◆ getUsers() [4/4]

◆ getUsersCount() [1/2]

◆ getUsersCount() [2/2]

◆ grantToAllUsers()

◆ preRemove() [1/7]

◆ preRemove() [2/7]

◆ preRemove() [3/7]

◆ preRemove() [4/7]

◆ preRemove() [5/7]

◆ preRemove() [6/7]

◆ preRemove() [7/7]

◆ removeFederatedIdentity()

◆ removeImportedUsers()

◆ removeUser()

◆ revokeConsentForClient()

◆ searchForUser() [1/4]

◆ searchForUser() [2/4]

◆ searchForUser() [3/4]

◆ searchForUser() [4/4]

◆ searchForUserByUserAttribute()

◆ setNotBeforeForUser()

◆ unlinkUsers()

◆ updateConsent()

◆ updateFederatedIdentity()