Package org.keycloak.models.map.storage.hotRod

Class HotRodMapStorageProviderFactory

java.lang.Object

org.keycloak.models.map.storage.hotRod.HotRodMapStorageProviderFactory

All Implemented Interfaces:

AmphibianProviderFactory<MapStorageProvider>, ComponentFactory<MapStorageProvider,MapStorageProvider>, MapStorageProviderFactory, ConfiguredProvider, EnvironmentDependentProviderFactory, ProviderFactory<MapStorageProvider>

public class HotRodMapStorageProviderFactory
extends Object
implements AmphibianProviderFactory<MapStorageProvider>, MapStorageProviderFactory, EnvironmentDependentProviderFactory

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.models.map.storage.MapStorageProviderFactory

MapStorageProviderFactory.Flag

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Map<SearchableModelField<AuthenticatedClientSessionModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,AbstractEntity,AuthenticatedClientSessionModel>>	CLIENT_SESSION_PREDICATES
protected static final DeepCloner	CLONER
static final String	PROVIDER_ID

Constructor Summary

Constructors

Constructor	Description
HotRodMapStorageProviderFactory()

Method Summary

Modifier and Type	Method	Description
MapStorageProvider	create(KeycloakSession session)
List<ProviderConfigProperty>	getConfigMetadata()	Returns the metadata for each configuration property supported by this factory.
HotRodEntityDescriptor<?,?>	getEntityDescriptor(Class<?> c)
String	getHelpText()
String	getId()
void	init(Config.Scope config)	Only called once when the factory is first created.
boolean	isSupported()
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.component.AmphibianProviderFactory

close, create, getConfigProperties, onUpdate, preRemove

Methods inherited from interface org.keycloak.component.ComponentFactory

getCommonProviderConfigProperties, getTypeMetadata, onCreate, validateConfiguration

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig

Methods inherited from interface org.keycloak.provider.EnvironmentDependentProviderFactory

isSupported

Methods inherited from interface org.keycloak.provider.ProviderFactory

order

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

CLIENT_SESSION_PREDICATES

protected static final Map<SearchableModelField<AuthenticatedClientSessionModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,AbstractEntity,AuthenticatedClientSessionModel>> CLIENT_SESSION_PREDICATES

CLONER

protected static final DeepCloner CLONER

Constructor Details

HotRodMapStorageProviderFactory

public HotRodMapStorageProviderFactory()

Method Details

create

public MapStorageProvider create(KeycloakSession session)

Specified by:

create in interface AmphibianProviderFactory<MapStorageProvider>

Specified by:

create in interface ComponentFactory<MapStorageProvider,MapStorageProvider>

Specified by:

create in interface ProviderFactory<MapStorageProvider>

getEntityDescriptor

public HotRodEntityDescriptor<?,?> getEntityDescriptor(Class<?> c)

init

public void init(Config.Scope config)

Description copied from interface: ProviderFactory

Only called once when the factory is first created. This config is pulled from keycloak_server.json

Specified by:

init in interface ProviderFactory<MapStorageProvider>

postInit

public void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<MapStorageProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<MapStorageProvider>

isSupported

public boolean isSupported()

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Returns:

true if the provider is supported and should be available, false otherwise

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

getConfigMetadata

public List<ProviderConfigProperty> getConfigMetadata()

Description copied from interface: ProviderFactory

Returns the metadata for each configuration property supported by this factory.

Specified by:

getConfigMetadata in interface ProviderFactory<MapStorageProvider>

Returns:

a list with the metadata for each configuration property supported by this factory