Package org.keycloak.models.sessions.infinispan

Class InfinispanUserSessionProviderFactory

java.lang.Object

org.keycloak.models.sessions.infinispan.InfinispanUserSessionProviderFactory

All Implemented Interfaces:

UserSessionProviderFactory<UserSessionProvider>, EnvironmentDependentProviderFactory, ProviderFactory<UserSessionProvider>, ServerInfoAwareProviderFactory

public class InfinispanUserSessionProviderFactory
extends Object
implements UserSessionProviderFactory<UserSessionProvider>, ServerInfoAwareProviderFactory, EnvironmentDependentProviderFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_MAX_BATCH_SIZE
static final String	CONFIG_OFFLINE_CLIENT_SESSION_CACHE_ENTRY_LIFESPAN_OVERRIDE
static final String	CONFIG_OFFLINE_SESSION_CACHE_ENTRY_LIFESPAN_OVERRIDE
static final String	CONFIG_USE_BATCHES
static final String	CONFIG_USE_CACHES
static final int	DEFAULT_MAX_BATCH_SIZE
static final String	REALM_REMOVED_SESSION_EVENT
static final String	REMOVE_USER_SESSIONS_EVENT

Constructor Summary

Constructors

Constructor	Description
InfinispanUserSessionProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
UserSessionProvider	create(KeycloakSession session)
Set<Class<? extends Provider>>	dependsOn()	Optional method used to declare that a ProviderFactory has a dependency on one or more Providers.
protected Long	deriveOfflineClientSessionCacheEntryLifespanOverrideMs(RealmModel realm, ClientModel client, AuthenticatedClientSessionEntity entity)
protected Long	deriveOfflineSessionCacheEntryLifespanMs(RealmModel realm, ClientModel client, UserSessionEntity entity)
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	initializePersisterLastSessionRefreshStore(KeycloakSessionFactory sessionFactory)
boolean	isSupported(Config.Scope config)	Check if the provider is supported and should be available based on the provider configuration.
int	order()
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized
protected void	registerClusterListeners(KeycloakSession session)

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

loadPersistentSessions

Field Details

REALM_REMOVED_SESSION_EVENT

public static final String REALM_REMOVED_SESSION_EVENT

See Also:

• Constant Field Values

REMOVE_USER_SESSIONS_EVENT

public static final String REMOVE_USER_SESSIONS_EVENT

See Also:

• Constant Field Values

CONFIG_OFFLINE_SESSION_CACHE_ENTRY_LIFESPAN_OVERRIDE

public static final String CONFIG_OFFLINE_SESSION_CACHE_ENTRY_LIFESPAN_OVERRIDE

See Also:

• Constant Field Values

CONFIG_OFFLINE_CLIENT_SESSION_CACHE_ENTRY_LIFESPAN_OVERRIDE

public static final String CONFIG_OFFLINE_CLIENT_SESSION_CACHE_ENTRY_LIFESPAN_OVERRIDE

See Also:

• Constant Field Values

CONFIG_MAX_BATCH_SIZE

public static final String CONFIG_MAX_BATCH_SIZE

See Also:

• Constant Field Values

DEFAULT_MAX_BATCH_SIZE

public static final int DEFAULT_MAX_BATCH_SIZE

CONFIG_USE_CACHES

public static final String CONFIG_USE_CACHES

See Also:

• Constant Field Values

CONFIG_USE_BATCHES

public static final String CONFIG_USE_BATCHES

See Also:

• Constant Field Values

Constructor Details

InfinispanUserSessionProviderFactory

public InfinispanUserSessionProviderFactory()

Method Details

create

public UserSessionProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<UserSessionProvider>

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

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

initializePersisterLastSessionRefreshStore

public void initializePersisterLastSessionRefreshStore(KeycloakSessionFactory sessionFactory)

registerClusterListeners

protected void registerClusterListeners(KeycloakSession session)

deriveOfflineSessionCacheEntryLifespanMs

protected Long deriveOfflineSessionCacheEntryLifespanMs(RealmModel realm,
 ClientModel client,
 UserSessionEntity entity)

deriveOfflineClientSessionCacheEntryLifespanOverrideMs

protected Long deriveOfflineClientSessionCacheEntryLifespanOverrideMs(RealmModel realm,
 ClientModel client,
 AuthenticatedClientSessionEntity entity)

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<UserSessionProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<UserSessionProvider>

order

public int order()

Specified by:

order in interface ProviderFactory<UserSessionProvider>

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

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

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