Package org.keycloak.models.jpa

Class JpaIdentityProviderStorageProvider

java.lang.Object

org.keycloak.models.jpa.JpaIdentityProviderStorageProvider

All Implemented Interfaces:

IdentityProviderStorageProvider, Provider

public class JpaIdentityProviderStorageProvider
extends Object
implements IdentityProviderStorageProvider

A JPA based implementation of IdentityProviderStorageProvider.

Author:

Stefan Guilhen

Nested Class Summary

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

IdentityProviderStorageProvider.FetchMode, IdentityProviderStorageProvider.LoginFilter

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.jboss.logging.Logger	logger

Constructor Summary

Constructors

Constructor	Description
JpaIdentityProviderStorageProvider(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
void	close()
long	count()	Returns the number of IDPs in the realm.
IdentityProviderModel	create(IdentityProviderModel identityProvider)	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.
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	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 identityProvider)	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, getByOrganization, getForLogin, getMappersStream, isIdentityFederationEnabled

Field Details

logger

protected static final org.jboss.logging.Logger logger

Constructor Details

JpaIdentityProviderStorageProvider

public JpaIdentityProviderStorageProvider(KeycloakSession session)

Method Details

create

public IdentityProviderModel create(IdentityProviderModel identityProvider)

Description copied from interface: IdentityProviderStorageProvider

Creates a new identity provider from the specified model.

Specified by:

create in interface IdentityProviderStorageProvider

Parameters:

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

Returns:

the model of the created identity provider.

update

public void update(IdentityProviderModel identityProvider)

Description copied from interface: IdentityProviderStorageProvider

Updates the identity provider using the specified model.

Specified by:

update in interface IdentityProviderStorageProvider

Parameters:

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

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.

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.

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.