org.keycloak.models.GroupModel インタフェース

org.keycloak.models.GroupModel の継承関係図

org.keycloak.models.GroupModel 連携図

クラス
interface	GroupRemovedEvent

公開メンバ関数
String	getId ()
String	getName ()
void	setName (String name)
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 ()
GroupModel	getParent ()
String	getParentId ()
Set< GroupModel >	getSubGroups ()
void	setParent (GroupModel group)
void	addChild (GroupModel subGroup)
void	removeChild (GroupModel subGroup)
Set< RoleModel >	getRealmRoleMappings ()
Set< RoleModel >	getClientRoleMappings (ClientModel app)
boolean	hasRole (RoleModel role)
void	grantRole (RoleModel role)
Set< RoleModel >	getRoleMappings ()
void	deleteRoleMapping (RoleModel role)

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

addChild()

void org.keycloak.models.GroupModel.addChild

(

GroupModel

subGroup

)

Automatically calls setParent() on the subGroup

引数

subGroup

deleteRoleMapping()

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

inherited

Removes the given role mapping from this object.

引数

role	Role to remove

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

getAttribute()

List<String> org.keycloak.models.GroupModel.getAttribute

(

String

name

)

引数

name

戻り値

list of all attribute values or empty list if there are not any values. Never return null

getAttributes()

Map<String, List<String> > org.keycloak.models.GroupModel.getAttributes

(

)

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.

引数

app	Client 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で実装されています。

getFirstAttribute()

String org.keycloak.models.GroupModel.getFirstAttribute

(

String

name

)

引数

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

getId()

String org.keycloak.models.GroupModel.getId

(

)

getName()

String org.keycloak.models.GroupModel.getName

(

)

getParent()

GroupModel org.keycloak.models.GroupModel.getParent

(

)

getParentId()

String org.keycloak.models.GroupModel.getParentId

(

)

getRealmRoleMappings()

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

inherited

Returns set of realm roles that are directly set to this object.

戻り値

see description

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

getRoleMappings()

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

inherited

Returns set of all role (both realm all client) that are directly set to this object.

戻り値

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

getSubGroups()

Set<GroupModel> org.keycloak.models.GroupModel.getSubGroups

(

)

grantRole()

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

inherited

Grants the given role to this object.

引数

role

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

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で実装されています。

removeAttribute()

void org.keycloak.models.GroupModel.removeAttribute

(

String

name

)

removeChild()

void org.keycloak.models.GroupModel.removeChild

(

GroupModel

subGroup

)

Automatically calls setParent() on the subGroup

引数

subGroup

setAttribute()

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

setName()

void org.keycloak.models.GroupModel.setName

(

String

name

)

setParent()

void org.keycloak.models.GroupModel.setParent

(

GroupModel

group

)

You must also call addChild on the parent group, addChild on RealmModel if there is no parent group

引数

group

setSingleAttribute()

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

Set single value of specified attribute. Remove all other existing values

引数

name
value

---

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

• D:/AppData/doxygen/keycloak/oidc-service/src/main/java/org/keycloak/models/GroupModel.java