Package org.keycloak.models.sessions.infinispan.transaction

Class DefaultInfinispanTransactionProviderFactory

java.lang.Object

org.keycloak.models.sessions.infinispan.transaction.DefaultInfinispanTransactionProviderFactory

All Implemented Interfaces:

InfinispanTransactionProviderFactory, ProviderFactory<InfinispanTransactionProvider>, ServerInfoAwareProviderFactory

public class DefaultInfinispanTransactionProviderFactory
extends Object
implements InfinispanTransactionProviderFactory, ServerInfoAwareProviderFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_WRITE_SESSION_UPDATES_IN_MAIN_TRANSACTION
static final String	ID
protected static org.jboss.logging.Logger	log

Constructor Summary

Constructors

Constructor	Description
DefaultInfinispanTransactionProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
InfinispanTransactionProvider	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.
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

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

log

protected static org.jboss.logging.Logger log

CONFIG_WRITE_SESSION_UPDATES_IN_MAIN_TRANSACTION

public static final String CONFIG_WRITE_SESSION_UPDATES_IN_MAIN_TRANSACTION

See Also:

• Constant Field Values

Constructor Details

DefaultInfinispanTransactionProviderFactory

public DefaultInfinispanTransactionProviderFactory()

Method Details

create

public InfinispanTransactionProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<InfinispanTransactionProvider>

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

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

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

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

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<InfinispanTransactionProvider>

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

getId

public String getId()

Specified by:

getId in interface ProviderFactory<InfinispanTransactionProvider>