Package org.keycloak.models.sessions.infinispan

Class InfinispanAuthenticationSessionProviderFactory

java.lang.Object

org.keycloak.models.sessions.infinispan.InfinispanAuthenticationSessionProviderFactory

All Implemented Interfaces:

EnvironmentDependentProviderFactory, ProviderEventListener, ProviderFactory<InfinispanAuthenticationSessionProvider>, AuthenticationSessionProviderFactory<InfinispanAuthenticationSessionProvider>

public class InfinispanAuthenticationSessionProviderFactory
extends Object
implements AuthenticationSessionProviderFactory<InfinispanAuthenticationSessionProvider>, EnvironmentDependentProviderFactory, ProviderEventListener

Author:

Marek Posolda

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTH_SESSIONS_LIMIT
static final String	AUTHENTICATION_SESSION_EVENTS
static final int	DEFAULT_AUTH_SESSIONS_LIMIT
static final String	REALM_REMOVED_AUTHSESSION_EVENT

Constructor Summary

Constructors

Constructor	Description
InfinispanAuthenticationSessionProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
InfinispanAuthenticationSessionProvider	create(KeycloakSession session)
Set<Class<? extends Provider>>	dependsOn()	Optional method used to declare that a ProviderFactory has a dependency on one or more Providers.
static int	getAuthSessionsLimit(Config.Scope config)
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	onEvent(ProviderEvent event)
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

Field Details

AUTH_SESSIONS_LIMIT

public static final String AUTH_SESSIONS_LIMIT

See Also:

• Constant Field Values

DEFAULT_AUTH_SESSIONS_LIMIT

public static final int DEFAULT_AUTH_SESSIONS_LIMIT

See Also:

• Constant Field Values

AUTHENTICATION_SESSION_EVENTS

public static final String AUTHENTICATION_SESSION_EVENTS

See Also:

• Constant Field Values

REALM_REMOVED_AUTHSESSION_EVENT

public static final String REALM_REMOVED_AUTHSESSION_EVENT

See Also:

• Constant Field Values

Constructor Details

InfinispanAuthenticationSessionProviderFactory

public InfinispanAuthenticationSessionProviderFactory()

Method Details

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

getAuthSessionsLimit

public static int getAuthSessionsLimit(Config.Scope config)

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

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

Returns:

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

onEvent

public void onEvent(ProviderEvent event)

Specified by:

onEvent in interface ProviderEventListener

registerClusterListeners

protected void registerClusterListeners(KeycloakSession session)

create

public InfinispanAuthenticationSessionProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<InfinispanAuthenticationSessionProvider>

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

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<InfinispanAuthenticationSessionProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<InfinispanAuthenticationSessionProvider>

order

public int order()

Specified by:

order in interface ProviderFactory<InfinispanAuthenticationSessionProvider>

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.