Package org.keycloak.models.cache.infinispan.idp

Class InfinispanIdentityProviderStorageProvider

java.lang.Object

org.keycloak.models.cache.infinispan.idp.InfinispanIdentityProviderStorageProvider

All Implemented Interfaces:

IdentityProviderStorageProvider, Provider

public class InfinispanIdentityProviderStorageProvider
extends Object
implements IdentityProviderStorageProvider

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.models.IdentityProviderStorageProvider

IdentityProviderStorageProvider.FetchMode, IdentityProviderStorageProvider.LoginFilter

Constructor Summary

Constructors

Constructor	Description
InfinispanIdentityProviderStorageProvider(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
static String	cacheKeyForLogin(RealmModel realm, IdentityProviderStorageProvider.FetchMode fetchMode)
static String	cacheKeyIsEnabled(RealmModel realm)
static String	cacheKeyOrgId(RealmModel realm, String orgId)
void	close()
long	count()	Returns the number of IDPs in the realm.
IdentityProviderModel	create(IdentityProviderModel model)	Creates a new identity provider from the specified model.
IdentityProviderMapperModel	createMapper(IdentityProviderMapperModel model)	Creates a new identity provider mapper from the specified model.
Stream<IdentityProviderModel>	getAllStream(Map<String,String> attrs, Integer first, Integer max)	Returns all identity providers in the realm filtered according to the specified search options.
IdentityProviderModel	getByAlias(String alias)	Obtains the identity provider with the specified alias.
Stream<String>	getByFlow(String flowId, String search, Integer first, Integer max)	Returns the aliases of all identity providers whose firstBrokerLoginFlowId or postBrokerLoginFlowId matches the provided flowId.
IdentityProviderModel	getById(String internalId)	Obtains the identity provider with the specified internal id.
Stream<IdentityProviderModel>	getByOrganization(String orgId, Integer first, Integer max)	Returns all identity providers associated with the organization with the provided id.
Stream<IdentityProviderModel>	getForLogin(IdentityProviderStorageProvider.FetchMode mode, String organizationId)	Returns all identity providers available for login, according to the specified mode.
IdentityProviderMapperModel	getMapperById(String id)	Obtains the identity provider mapper with the specified id.
IdentityProviderMapperModel	getMapperByName(String identityProviderAlias, String name)	Obtains the identity provider mapper with the provided identity provider alias and name.
Stream<IdentityProviderMapperModel>	getMappersByAliasStream(String identityProviderAlias)	Returns identity provider mappers by the provided alias as a stream.
Stream<IdentityProviderMapperModel>	getMappersStream(Map<String,String> options, Integer first, Integer max)	Returns all identity provider mappers in the realm filtered according to the specified search options.
boolean	isIdentityFederationEnabled()	Checks whether the realm has any configured identity providers or not.
boolean	remove(String alias)	Removes the identity provider with the specified alias.
void	removeAll()	Removes all identity providers from the realm.
void	removeAllMappers()	Removes all identity provider mappers from the realm.
boolean	removeMapper(IdentityProviderMapperModel model)	Removes the given identity provider mapper.
void	update(IdentityProviderModel model)	Updates the identity provider using the specified model.
void	updateMapper(IdentityProviderMapperModel model)	Updates the identity provider mapper using the specified model.

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.IdentityProviderStorageProvider

getAllStream, getByIdOrAlias, getMappersStream

Constructor Details

InfinispanIdentityProviderStorageProvider

public InfinispanIdentityProviderStorageProvider(KeycloakSession session)

Method Details

cacheKeyOrgId

public static String cacheKeyOrgId(RealmModel realm,
 String orgId)

cacheKeyForLogin

public static String cacheKeyForLogin(RealmModel realm,
 IdentityProviderStorageProvider.FetchMode fetchMode)

cacheKeyIsEnabled

public static String cacheKeyIsEnabled(RealmModel realm)

create

public IdentityProviderModel create(IdentityProviderModel model)

Description copied from interface: IdentityProviderStorageProvider

Creates a new identity provider from the specified model.

Specified by:

create in interface IdentityProviderStorageProvider

Parameters:

model - a IdentityProviderModel containing the identity provider's data.

Returns:

the model of the created identity provider.

update

public void update(IdentityProviderModel model)

Description copied from interface: IdentityProviderStorageProvider

Updates the identity provider using the specified model.

Specified by:

update in interface IdentityProviderStorageProvider

Parameters:

model - a IdentityProviderModel containing the identity provider's data.

remove

public boolean remove(String alias)

Description copied from interface: IdentityProviderStorageProvider

Removes the identity provider with the specified alias.

Specified by:

remove in interface IdentityProviderStorageProvider

Parameters:

alias - the alias of the identity provider to be removed.

Returns:

true if an IDP with the specified alias was found and removed; false otherwise.

removeAll

public void removeAll()

Description copied from interface: IdentityProviderStorageProvider

Removes all identity providers from the realm.

Specified by:

removeAll in interface IdentityProviderStorageProvider

getById

public IdentityProviderModel getById(String internalId)

Description copied from interface: IdentityProviderStorageProvider

Obtains the identity provider with the specified internal id.

Specified by:

getById in interface IdentityProviderStorageProvider

Parameters:

internalId - the identity provider's internal id.

Returns:

a reference to the identity provider, or null if no provider is found.

getByAlias

public IdentityProviderModel getByAlias(String alias)

Description copied from interface: IdentityProviderStorageProvider

Obtains the identity provider with the specified alias.

Specified by:

getByAlias in interface IdentityProviderStorageProvider

Parameters:

alias - the identity provider's alias.

Returns:

a reference to the identity provider, or null if no provider is found.

isIdentityFederationEnabled

public boolean isIdentityFederationEnabled()

Description copied from interface: IdentityProviderStorageProvider

Checks whether the realm has any configured identity providers or not.

Specified by:

isIdentityFederationEnabled in interface IdentityProviderStorageProvider

Returns:

true if the realm has at least one configured identity provider (federation is enabled); false otherwise.

getByOrganization

public Stream<IdentityProviderModel> getByOrganization(String orgId,
 Integer first,
 Integer max)

Description copied from interface: IdentityProviderStorageProvider

Returns all identity providers associated with the organization with the provided id.

Specified by:

getByOrganization in interface IdentityProviderStorageProvider

Parameters:

orgId - the id of the organization.

first - the position of the first result to be processed (pagination offset). Ignored if negative or null.

max - the maximum number of results to be returned. Ignored if negative or null.

Returns:

a non-null stream of IdentityProviderModels that match the search criteria.

getForLogin

public Stream<IdentityProviderModel> getForLogin(IdentityProviderStorageProvider.FetchMode mode,
 String organizationId)

Description copied from interface: IdentityProviderStorageProvider

Returns all identity providers available for login, according to the specified mode. An IDP can be used for login if it is enabled, is not a link-only IDP, and is not configured to be hidden on login page.

The mode parameter may narrow the list of IDPs that are available. FETCH_MODE.REALM_ONLY fetches only realm-level IDPs (i.e. those not associated with any org). FETCH_MODE.ORG_ONLY will work together with the organizationId parameter. If the latter is set, only the IDPs associated with that org will be returned. Otherwise, the method returns the IDPs associated with any org. FETCH_MODE.ALL combines both approaches, returning both the realm-level IDPs with those associated with organizations (or a specific organization as per the organizationId param).

Specified by:

getForLogin in interface IdentityProviderStorageProvider

Parameters:

mode - the fetch mode to be used. Can be REALM_ONLY, ORG_ONLY, or ALL.

organizationId - an optional organization ID. If present and the mode is not REALM_ONLY, the param indicates that only IDPs associated with the specified organization are to be returned.

Returns:

a non-null stream of IdentityProviderModels that are suitable for being displayed in the login pages.

getByFlow

public Stream<String> getByFlow(String flowId,
 String search,
 Integer first,
 Integer max)

Description copied from interface: IdentityProviderStorageProvider

Returns the aliases of all identity providers whose firstBrokerLoginFlowId or postBrokerLoginFlowId matches the provided flowId.

Specified by:

getByFlow in interface IdentityProviderStorageProvider

Parameters:

flowId - the id of the flow.

search - an optional String representing an identity provider alias (partial or exact). If the value is enclosed in double quotes, the method treats it as an exact search (e.g. "name"). If the value is enclosed in wildcards, the method treats it as an infix search (e.g. *name*). Otherwise, the method treats it as a prefix search (i.e. name* and name return the same results).

first - the position of the first result to be processed (pagination offset). Ignored if negative or null.

max - the maximum number of results to be returned. Ignored if negative or null.

Returns:

a non-null stream of IdentityProviderModels that match the search criteria.

getAllStream

public Stream<IdentityProviderModel> getAllStream(Map<String,String> attrs,
 Integer first,
 Integer max)

Description copied from interface: IdentityProviderStorageProvider

Returns all identity providers in the realm filtered according to the specified search options. The options include:

• Regular fields found in IdentityProviderModel, such as ALIAS, ENABLED, HIDE_ON_LOGIN, etc;
• Special search keys also present in IdentityProviderModel. Those include SEARCH, used to perform exact, prefix, and infix searches by alias, and ALIAS_NOT_IN, used to perform searches for identity providers whose alias doesn't match any of the specified aliases (separated by comma);
• Any attribute found in the identity provider's config. If the option key doesn't match any of the previous cases, the implementations must search the providers whose config contains a pair that matches the specified search option

Specified by:

getAllStream in interface IdentityProviderStorageProvider

Parameters:

attrs - a Map containing identity provider search options that must be matched.

first - the position of the first result to be processed (pagination offset). Ignored if negative or null.

max - the maximum number of results to be returned. Ignored if negative or null.

Returns:

a non-null stream of IdentityProviderModels that match the search criteria.

count

public long count()

Description copied from interface: IdentityProviderStorageProvider

Returns the number of IDPs in the realm.

Specified by:

count in interface IdentityProviderStorageProvider

Returns:

the number of IDPs found in the realm.

close

public void close()

Specified by:

close in interface Provider

createMapper

public IdentityProviderMapperModel createMapper(IdentityProviderMapperModel model)

Description copied from interface: IdentityProviderStorageProvider

Creates a new identity provider mapper from the specified model.

Specified by:

createMapper in interface IdentityProviderStorageProvider

Parameters:

model - a IdentityProviderMapperModel containing the identity provider mapper's data.

Returns:

the model of the created identity provider mapper.

updateMapper

public void updateMapper(IdentityProviderMapperModel model)

Description copied from interface: IdentityProviderStorageProvider

Updates the identity provider mapper using the specified model.

Specified by:

updateMapper in interface IdentityProviderStorageProvider

Parameters:

model - a IdentityProviderMapperModel containing the identity provider mapper's data.

removeMapper

public boolean removeMapper(IdentityProviderMapperModel model)

Description copied from interface: IdentityProviderStorageProvider

Removes the given identity provider mapper.

Specified by:

removeMapper in interface IdentityProviderStorageProvider

Parameters:

model - a IdentityProviderMapperModel to be deleted.

Returns:

true if an identity provider mapper was removed; false otherwise.

removeAllMappers

public void removeAllMappers()

Description copied from interface: IdentityProviderStorageProvider

Removes all identity provider mappers from the realm.

Specified by:

removeAllMappers in interface IdentityProviderStorageProvider

getMapperById

public IdentityProviderMapperModel getMapperById(String id)

Description copied from interface: IdentityProviderStorageProvider

Obtains the identity provider mapper with the specified id.

Specified by:

getMapperById in interface IdentityProviderStorageProvider

Parameters:

id - the identity provider mapper's id.

Returns:

a reference to the identity provider mapper, or null if no mapper is found.

getMapperByName

public IdentityProviderMapperModel getMapperByName(String identityProviderAlias,
 String name)

Description copied from interface: IdentityProviderStorageProvider

Obtains the identity provider mapper with the provided identity provider alias and name.

Specified by:

getMapperByName in interface IdentityProviderStorageProvider

Parameters:

identityProviderAlias - the identity provider alias.

name - the identity provider mapper's name.

Returns:

a reference to the identity provider mapper, or null if no provider is found.

getMappersStream

public Stream<IdentityProviderMapperModel> getMappersStream(Map<String,String> options,
 Integer first,
 Integer max)

Description copied from interface: IdentityProviderStorageProvider

Returns all identity provider mappers in the realm filtered according to the specified search options.

Specified by:

getMappersStream in interface IdentityProviderStorageProvider

Parameters:

options - a Map containing identity provider search options that must be matched.

first - the position of the first result to be processed (pagination offset). Ignored if negative or null.

max - the maximum number of results to be returned. Ignored if negative or null.

Returns:

a non-null stream of IdentityProviderModels that match the search criteria.

getMappersByAliasStream

public Stream<IdentityProviderMapperModel> getMappersByAliasStream(String identityProviderAlias)

Description copied from interface: IdentityProviderStorageProvider

Returns identity provider mappers by the provided alias as a stream.

Specified by:

getMappersByAliasStream in interface IdentityProviderStorageProvider

Parameters:

identityProviderAlias - String Identity provider alias to filter results.

Returns:

Stream of IdentityProviderMapperModel Never returns null.