Package org.keycloak.singleobject.jpa

Class JpaSingleUseObjectProviderFactory

java.lang.Object

org.keycloak.singleobject.jpa.JpaSingleUseObjectProviderFactory

All Implemented Interfaces:

SingleUseObjectProviderFactory<JpaSingleUseObjectProvider>, EnvironmentDependentProviderFactory, ProviderFactory<JpaSingleUseObjectProvider>, ServerInfoAwareProviderFactory

public class JpaSingleUseObjectProviderFactory
extends Object
implements SingleUseObjectProviderFactory<JpaSingleUseObjectProvider>, EnvironmentDependentProviderFactory, ServerInfoAwareProviderFactory

Factory for JpaSingleUseObjectProvider.

Enabled only when the Profile.Feature.CACHELESS feature is active. Registers a periodic ExpirationTask to clean up expired single-use objects from the database.

Constructor Summary

Constructors

Constructor	Description
JpaSingleUseObjectProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
JpaSingleUseObjectProvider	create(KeycloakSession session)
Set<Class<? extends Provider>>	dependsOn()	Optional method used to declare that a ProviderFactory has a dependency on one or more Providers.
List<ProviderConfigProperty>	getConfigMetadata()	Returns the metadata for each configuration property supported by this factory.
String	getId()
Map<String,String>	getOperationalInfo()	Return actual info about the provider.
void	init(Config.Scope config)	Only called once when the factory is first created.
boolean	isSupported(Config.Scope config)	Check if the provider is supported and should be available based on the provider configuration.
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.provider.ProviderFactory

order

Constructor Details

JpaSingleUseObjectProviderFactory

public JpaSingleUseObjectProviderFactory()

Method Details

create

public JpaSingleUseObjectProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<JpaSingleUseObjectProvider>

init

public void init(Config.Scope config)

Description copied from interface: ProviderFactory

Only called once when the factory is first created.

Specified by:

init in interface ProviderFactory<JpaSingleUseObjectProvider>

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<JpaSingleUseObjectProvider>

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<JpaSingleUseObjectProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<JpaSingleUseObjectProvider>

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<JpaSingleUseObjectProvider>

Returns:

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

dependsOn

public Set<Class<? extends Provider>> dependsOn()

Description copied from interface: ProviderFactory

Optional method used to declare that a ProviderFactory has a dependency on one or more Providers. If a Provider is declared here, it is guaranteed that the dependencies ProviderFactory.postInit(org.keycloak.models.KeycloakSessionFactory) method will be executed before this ProviderFactory's ProviderFactory.postInit(org.keycloak.models.KeycloakSessionFactory). Similarly, it's guaranteed that ProviderFactory.close() will be called on this ProviderFactory before ProviderFactory.close() is called on any of the dependent ProviderFactory implementations.

Specified by:

dependsOn in interface ProviderFactory<JpaSingleUseObjectProvider>

isSupported

public boolean isSupported(Config.Scope config)

Description copied from interface: EnvironmentDependentProviderFactory

Check if the provider is supported and should be available based on the provider configuration.

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Parameters:

config - the provider configuration

Returns:

true if the provider is supported. Otherwise, false.

getOperationalInfo

public Map<String,String> getOperationalInfo()

Description copied from interface: ServerInfoAwareProviderFactory

Return actual info about the provider. This info contains information about provider's configuration and operational conditions (eg. errors in connection to remote systems etc) which is shown on "Server Info" page then.

Specified by:

getOperationalInfo in interface ServerInfoAwareProviderFactory

Returns:

Map with keys describing value and relevant values itself