Package org.keycloak.models

Interface RoleContainerModel

All Known Subinterfaces:

CachedRealmModel, ClientModel, LegacyRealmModel, RealmModel

All Known Implementing Classes:

AbstractClientModel, AbstractClientStorageAdapter, AbstractReadOnlyClientStorageAdapter, AbstractRealmModel, ClientAdapter, ClientAdapter, ClientModelLazyDelegate, ClientModelLazyDelegate.WithId, MapClientAdapter, MapRealmAdapter, OIDCClientSecretConfigWrapper.ReadOnlyRotatedSecretClientModel, OpenshiftSAClientAdapter, RealmAdapter, RealmAdapter, UnsupportedOperationsClientStorageAdapter

public interface RoleContainerModel

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RoleContainerModel.RoleRemovedEvent

Method Summary

Modifier and Type	Method	Description
void	addDefaultRole(String name)	Deprecated. Default roles are now managed by RealmModel.getDefaultRole().
RoleModel	addRole(String name)
RoleModel	addRole(String id, String name)
default List<String>	getDefaultRoles()	Deprecated. Default roles are now managed by RealmModel.getDefaultRole().
Stream<String>	getDefaultRolesStream()	Deprecated. Default roles are now managed by RealmModel.getDefaultRole().
String	getId()
RoleModel	getRole(String name)
Stream<RoleModel>	getRolesStream()	Returns available roles as a stream.
Stream<RoleModel>	getRolesStream(Integer firstResult, Integer maxResults)	Returns available roles as a stream.
void	removeDefaultRoles(String... defaultRoles)	Deprecated. Default roles are now managed by RealmModel.getDefaultRole().
boolean	removeRole(RoleModel role)
Stream<RoleModel>	searchForRolesStream(String search, Integer first, Integer max)	Searches roles by the given name.
default void	updateDefaultRoles(String... defaultRoles)	Deprecated. Default roles are now managed by RealmModel.getDefaultRole().

Method Detail

getId

String getId()

getRole

RoleModel getRole(String name)

addRole

RoleModel addRole(String name)

addRole

RoleModel addRole(String id,
                  String name)

removeRole

boolean removeRole(RoleModel role)

getRolesStream

Stream<RoleModel> getRolesStream()

Returns available roles as a stream.

Returns:

Stream of RoleModel. Never returns null.

getRolesStream

Stream<RoleModel> getRolesStream(Integer firstResult,
                                 Integer maxResults)

Returns available roles as a stream.

Parameters:

firstResult - Integer Index of the first desired role. Ignored if negative or null.

maxResults - Integer Maximum number of returned roles. Ignored if negative or null.

Returns:

Stream of RoleModel. Never returns null.

searchForRolesStream

Stream<RoleModel> searchForRolesStream(String search,
                                       Integer first,
                                       Integer max)

Searches roles by the given name. Returns all roles that match the given filter.

Parameters:

search - String Name of the role to be used as a filter.

first - Integer Index of the first desired role. Ignored if negative or null.

max - Integer Maximum number of returned roles. Ignored if negative or null.

Returns:

Stream of RoleModel. Never returns null.

getDefaultRoles

@Deprecated
default List<String> getDefaultRoles()

Deprecated.

Default roles are now managed by RealmModel.getDefaultRole(). This method will be removed.

Returns:

List of default roles names or empty list if there are none. Never returns null.

getDefaultRolesStream

@Deprecated
Stream<String> getDefaultRolesStream()

Deprecated.

Default roles are now managed by RealmModel.getDefaultRole(). This method will be removed.

Returns:

Stream of default roles names or empty stream if there are none. Never returns null.

addDefaultRole

@Deprecated
void addDefaultRole(String name)

Deprecated.

Default roles are now managed by RealmModel.getDefaultRole(). This method will be removed.

updateDefaultRoles

@Deprecated
default void updateDefaultRoles(String... defaultRoles)

Deprecated.

Default roles are now managed by RealmModel.getDefaultRole(). This method will be removed.

removeDefaultRoles

@Deprecated
void removeDefaultRoles(String... defaultRoles)

Deprecated.

Default roles are now managed by RealmModel.getDefaultRole(). This method will be removed.