keycloak-oidc-service
公開メンバ関数 | 公開変数類 | 全メンバ一覧
org.keycloak.models.cache.CachedUserModel インタフェース
org.keycloak.models.cache.CachedUserModel の継承関係図
Inheritance graph
org.keycloak.models.cache.CachedUserModel 連携図
Collaboration graph

公開メンバ関数

UserModel getDelegateForUpdate ()
 
boolean isMarkedForEviction ()
 
void invalidate ()
 
long getCacheTimestamp ()
 
ConcurrentMap getCachedWith ()
 
String getId ()
 
String getUsername ()
 
void setUsername (String username)
 
Long getCreatedTimestamp ()
 
void setCreatedTimestamp (Long timestamp)
 
boolean isEnabled ()
 
void setEnabled (boolean enabled)
 
void setSingleAttribute (String name, String value)
 
void setAttribute (String name, List< String > values)
 
void removeAttribute (String name)
 
String getFirstAttribute (String name)
 
List< String > getAttribute (String name)
 
Map< String, List< String > > getAttributes ()
 
Set< String > getRequiredActions ()
 
void addRequiredAction (String action)
 
void addRequiredAction (RequiredAction action)
 
void removeRequiredAction (String action)
 
void removeRequiredAction (RequiredAction action)
 
String getFirstName ()
 
void setFirstName (String firstName)
 
String getLastName ()
 
void setLastName (String lastName)
 
String getEmail ()
 
void setEmail (String email)
 
boolean isEmailVerified ()
 
void setEmailVerified (boolean verified)
 
Set< GroupModelgetGroups ()
 
void joinGroup (GroupModel group)
 
void leaveGroup (GroupModel group)
 
boolean isMemberOf (GroupModel group)
 
String getFederationLink ()
 
void setFederationLink (String link)
 
String getServiceAccountClientLink ()
 
void setServiceAccountClientLink (String clientInternalId)
 
Set< RoleModelgetRealmRoleMappings ()
 
Set< RoleModelgetClientRoleMappings (ClientModel app)
 
boolean hasRole (RoleModel role)
 
void grantRole (RoleModel role)
 
Set< RoleModelgetRoleMappings ()
 
void deleteRoleMapping (RoleModel role)
 

公開変数類

String USERNAME = "username"
 
String LAST_NAME = "lastName"
 
String FIRST_NAME = "firstName"
 
String EMAIL = "email"
 
String LOCALE = "locale"
 

詳解

Cached users will implement this interface

著者
Bill Burke
バージョン
Revision
1

関数詳解

◆ addRequiredAction() [1/2]

void org.keycloak.models.UserModel.addRequiredAction ( String  action)
inherited

◆ addRequiredAction() [2/2]

void org.keycloak.models.UserModel.addRequiredAction ( RequiredAction  action)
inherited

◆ deleteRoleMapping()

void org.keycloak.models.RoleMapperModel.deleteRoleMapping ( RoleModel  role)
inherited

◆ getAttribute()

List<String> org.keycloak.models.UserModel.getAttribute ( String  name)
inherited
引数
name
戻り値
list of all attribute values or empty list if there are not any values. Never return null

org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.storage.adapter.AbstractUserAdapter, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.utils.UserModelDelegateで実装されています。

◆ getAttributes()

Map<String, List<String> > org.keycloak.models.UserModel.getAttributes ( )
inherited

◆ getCachedWith()

ConcurrentMap org.keycloak.models.cache.CachedUserModel.getCachedWith ( )

Returns a map that contains custom things that are cached along with this model. You can write to this map.

戻り値

◆ getCacheTimestamp()

long org.keycloak.models.cache.CachedUserModel.getCacheTimestamp ( )

When was the model was loaded from database.

戻り値

◆ getClientRoleMappings()

Set<RoleModel> org.keycloak.models.RoleMapperModel.getClientRoleMappings ( ClientModel  app)
inherited

Returns set of client roles that are directly set to this object for the given client.

引数
appClient to get the roles for
戻り値
see description

org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.models.utils.UserModelDelegate, org.keycloak.storage.adapter.AbstractUserAdapterで実装されています。

◆ getCreatedTimestamp()

Long org.keycloak.models.UserModel.getCreatedTimestamp ( )
inherited

Get timestamp of user creation. May be null for old users created before this feature introduction.

org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.storage.adapter.AbstractUserAdapter, org.keycloak.models.utils.UserModelDelegate, org.keycloak.storage.adapter.InMemoryUserAdapterで実装されています。

◆ getDelegateForUpdate()

UserModel org.keycloak.models.cache.CachedUserModel.getDelegateForUpdate ( )

Invalidates the cache for this user and returns a delegate that represents the actual data provider

戻り値

◆ getEmail()

String org.keycloak.models.UserModel.getEmail ( )
inherited

◆ getFederationLink()

String org.keycloak.models.UserModel.getFederationLink ( )
inherited

◆ getFirstAttribute()

String org.keycloak.models.UserModel.getFirstAttribute ( String  name)
inherited
引数
name
戻り値
null if there is not any value of specified attribute or first value otherwise. Don't throw exception if there are more values of the attribute

org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.storage.adapter.AbstractUserAdapter, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.utils.UserModelDelegateで実装されています。

◆ getFirstName()

String org.keycloak.models.UserModel.getFirstName ( )
inherited

◆ getGroups()

Set<GroupModel> org.keycloak.models.UserModel.getGroups ( )
inherited

◆ getId()

String org.keycloak.models.UserModel.getId ( )
inherited

◆ getLastName()

String org.keycloak.models.UserModel.getLastName ( )
inherited

◆ getRealmRoleMappings()

Set<RoleModel> org.keycloak.models.RoleMapperModel.getRealmRoleMappings ( )
inherited

◆ getRequiredActions()

Set<String> org.keycloak.models.UserModel.getRequiredActions ( )
inherited

◆ getRoleMappings()

Set<RoleModel> org.keycloak.models.RoleMapperModel.getRoleMappings ( )
inherited

◆ getServiceAccountClientLink()

String org.keycloak.models.UserModel.getServiceAccountClientLink ( )
inherited

◆ getUsername()

String org.keycloak.models.UserModel.getUsername ( )
inherited

◆ grantRole()

void org.keycloak.models.RoleMapperModel.grantRole ( RoleModel  role)
inherited

◆ hasRole()

boolean org.keycloak.models.RoleMapperModel.hasRole ( RoleModel  role)
inherited

Returns

true

if this object is directly or indirectly assigned the given role,

false

otherwise.

For example,

true

is returned for hasRole(R) if:

  • R is directly assigned to this object
  • R is not assigned to this object but this object belongs to a group G which is assigned the role R
  • R is not assigned to this object but this object belongs to a group G, and G belongs to group H which is assigned the role R
引数
role
戻り値
see description

org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.models.utils.UserModelDelegate, org.keycloak.storage.adapter.AbstractUserAdapterで実装されています。

◆ invalidate()

void org.keycloak.models.cache.CachedUserModel.invalidate ( )

Invalidate the cache for this model

◆ isEmailVerified()

boolean org.keycloak.models.UserModel.isEmailVerified ( )
inherited

◆ isEnabled()

boolean org.keycloak.models.UserModel.isEnabled ( )
inherited

◆ isMarkedForEviction()

boolean org.keycloak.models.cache.CachedUserModel.isMarkedForEviction ( )

◆ isMemberOf()

boolean org.keycloak.models.UserModel.isMemberOf ( GroupModel  group)
inherited

◆ joinGroup()

void org.keycloak.models.UserModel.joinGroup ( GroupModel  group)
inherited

◆ leaveGroup()

void org.keycloak.models.UserModel.leaveGroup ( GroupModel  group)
inherited

◆ removeAttribute()

void org.keycloak.models.UserModel.removeAttribute ( String  name)
inherited

◆ removeRequiredAction() [1/2]

void org.keycloak.models.UserModel.removeRequiredAction ( String  action)
inherited

◆ removeRequiredAction() [2/2]

void org.keycloak.models.UserModel.removeRequiredAction ( RequiredAction  action)
inherited

◆ setAttribute()

void org.keycloak.models.UserModel.setAttribute ( String  name,
List< String >  values 
)
inherited

◆ setCreatedTimestamp()

void org.keycloak.models.UserModel.setCreatedTimestamp ( Long  timestamp)
inherited

◆ setEmail()

void org.keycloak.models.UserModel.setEmail ( String  email)
inherited

◆ setEmailVerified()

void org.keycloak.models.UserModel.setEmailVerified ( boolean  verified)
inherited

◆ setEnabled()

void org.keycloak.models.UserModel.setEnabled ( boolean  enabled)
inherited

◆ setFederationLink()

void org.keycloak.models.UserModel.setFederationLink ( String  link)
inherited

◆ setFirstName()

void org.keycloak.models.UserModel.setFirstName ( String  firstName)
inherited

◆ setLastName()

void org.keycloak.models.UserModel.setLastName ( String  lastName)
inherited

◆ setServiceAccountClientLink()

void org.keycloak.models.UserModel.setServiceAccountClientLink ( String  clientInternalId)
inherited

◆ setSingleAttribute()

void org.keycloak.models.UserModel.setSingleAttribute ( String  name,
String  value 
)
inherited

◆ setUsername()

void org.keycloak.models.UserModel.setUsername ( String  username)
inherited

メンバ詳解

◆ EMAIL

String org.keycloak.models.UserModel.EMAIL = "email"
inherited

◆ FIRST_NAME

String org.keycloak.models.UserModel.FIRST_NAME = "firstName"
inherited

◆ LAST_NAME

String org.keycloak.models.UserModel.LAST_NAME = "lastName"
inherited

◆ LOCALE

String org.keycloak.models.UserModel.LOCALE = "locale"
inherited

◆ USERNAME

String org.keycloak.models.UserModel.USERNAME = "username"
inherited

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