Package org.keycloak.storage

Class ClientScopeStorageManager

java.lang.Object

org.keycloak.storage.AbstractStorageManager<ClientScopeStorageProvider,ClientScopeStorageProviderModel>

org.keycloak.storage.ClientScopeStorageManager

All Implemented Interfaces:

ClientScopeProvider, Provider, ClientScopeLookupProvider

public class ClientScopeStorageManager
extends AbstractStorageManager<ClientScopeStorageProvider,ClientScopeStorageProviderModel>
implements ClientScopeProvider

Field Summary

Fields inherited from class org.keycloak.storage.AbstractStorageManager

session

Constructor Summary

Constructors

Constructor	Description
ClientScopeStorageManager(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
ClientScopeModel	addClientScope(RealmModel realm, String id, String name)	Creates new client scope with given internal ID and name to the given realm.
void	close()
ClientScopeModel	getClientScopeById(RealmModel realm, String id)	Exact search for a client scope by its internal ID..
Stream<ClientScopeModel>	getClientScopesByAttributes(RealmModel realm, Map<String,String> searchMap, boolean useOr)	Allows us to filter for scopes by specific attributes
Stream<ClientScopeModel>	getClientScopesByProtocol(RealmModel realm, String protocol)	Must retrieve all client scopes of the given realm that are use the given protocol.
Stream<ClientScopeModel>	getClientScopesStream(RealmModel realm)	Returns all the client scopes of the given realm as a stream.
boolean	removeClientScope(RealmModel realm, String id)	Removes client scope from the given realm.
void	removeClientScopes(RealmModel realm)	Removes all client scopes from the given realm.

Methods inherited from class org.keycloak.storage.AbstractStorageManager

consumeEnabledStorageProvidersWithTimeout, flatMapEnabledStorageProvidersWithTimeout, getEnabledStorageProviders, getStorageProviderFactory, getStorageProviderInstance, getStorageProviderInstance, getStorageProviderInstance, getStorageProviderInstance, getStorageProviderModel, getStorageProviderModels, getStorageProviderTimeout, mapEnabledStorageProvidersWithTimeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.models.ClientScopeProvider

addClientScope

Constructor Details

ClientScopeStorageManager

public ClientScopeStorageManager(KeycloakSession session)

Method Details

getClientScopeById

public ClientScopeModel getClientScopeById(RealmModel realm,
 String id)

Description copied from interface: ClientScopeLookupProvider

Exact search for a client scope by its internal ID..

Specified by:

getClientScopeById in interface ClientScopeLookupProvider

Parameters:

realm - Realm.

id - Internal ID of the role.

Returns:

Model of the client scope.

getClientScopesStream

public Stream<ClientScopeModel> getClientScopesStream(RealmModel realm)

Description copied from interface: ClientScopeProvider

Returns all the client scopes of the given realm as a stream.

Specified by:

getClientScopesStream in interface ClientScopeProvider

Parameters:

realm - Realm.

Returns:

Stream of the client scopes. Never returns null.

addClientScope

public ClientScopeModel addClientScope(RealmModel realm,
 String id,
 String name)

Description copied from interface: ClientScopeProvider

Creates new client scope with given internal ID and name to the given realm. Spaces in name will be replaced by underscore so that scope name can be used as value of scope parameter.

Specified by:

addClientScope in interface ClientScopeProvider

Parameters:

realm - Realm owning this client scope.

id - Internal ID of the client scope or null if one is to be created by the underlying store

name - String name of the client scope.

Returns:

Model of the created client scope.

removeClientScope

public boolean removeClientScope(RealmModel realm,
 String id)

Description copied from interface: ClientScopeProvider

Removes client scope from the given realm.

Specified by:

removeClientScope in interface ClientScopeProvider

Parameters:

realm - Realm.

id - Internal ID of the client scope

Returns:

true if the client scope existed and has been removed, false otherwise.

removeClientScopes

public void removeClientScopes(RealmModel realm)

Description copied from interface: ClientScopeProvider

Removes all client scopes from the given realm.

Specified by:

removeClientScopes in interface ClientScopeProvider

Parameters:

realm - Realm.

getClientScopesByProtocol

public Stream<ClientScopeModel> getClientScopesByProtocol(RealmModel realm,
 String protocol)

Description copied from interface: ClientScopeProvider

Must retrieve all client scopes of the given realm that are use the given protocol.

Specified by:

getClientScopesByProtocol in interface ClientScopeProvider

Parameters:

realm - the realm to retrieve the client scopes from.

protocol - the protocol expected from the clientScope

getClientScopesByAttributes

public Stream<ClientScopeModel> getClientScopesByAttributes(RealmModel realm,
 Map<String,String> searchMap,
 boolean useOr)

Description copied from interface: ClientScopeProvider

Allows us to filter for scopes by specific attributes

Specified by:

getClientScopesByAttributes in interface ClientScopeProvider

Parameters:

realm - Realm.

searchMap - a key-value map that holds the attribute names and values to search for.

useOr - If the search-params should be combined with or-expressions or and-expressions

close

public void close()

Specified by:

close in interface Provider