Package org.keycloak.cluster.infinispan

Class DatabaseAwareClusterProviderFactory

java.lang.Object

org.keycloak.cluster.infinispan.InfinispanClusterProviderFactory

org.keycloak.cluster.infinispan.DatabaseAwareClusterProviderFactory

All Implemented Interfaces:

ClusterProviderFactory, EnvironmentDependentProviderFactory, ProviderFactory<ClusterProvider>

public class DatabaseAwareClusterProviderFactory
extends InfinispanClusterProviderFactory

This implementation sends information to other clusters via a database table.

Author:

Alexander Schwartz

Nested Class Summary

Nested classes/interfaces inherited from class org.keycloak.cluster.infinispan.InfinispanClusterProviderFactory

InfinispanClusterProviderFactory.ViewChangeListener

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
DatabaseAwareClusterProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
ClusterProvider	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()
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 org.keycloak.cluster.infinispan.InfinispanClusterProviderFactory

initClusterStartupTime

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

Field Details

logger

protected static final org.jboss.logging.Logger logger

Constructor Details

DatabaseAwareClusterProviderFactory

public DatabaseAwareClusterProviderFactory()

Method Details

create

public ClusterProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<ClusterProvider>

Overrides:

create in class InfinispanClusterProviderFactory

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

Overrides:

init in class InfinispanClusterProviderFactory

getConfigMetadata

public List<ProviderConfigProperty> getConfigMetadata()

Description copied from interface: ProviderFactory

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

Returns:

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

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

Overrides:

postInit in class InfinispanClusterProviderFactory

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<ClusterProvider>

Overrides:

close in class InfinispanClusterProviderFactory

getId

public String getId()

Specified by:

getId in interface ProviderFactory<ClusterProvider>

Overrides:

getId in class InfinispanClusterProviderFactory

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.

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

Overrides:

isSupported in class InfinispanClusterProviderFactory

Parameters:

config - the provider configuration

Returns:

true if the provider is supported. Otherwise, false.