Package org.keycloak.models.sessions.infinispan

Class InfinispanUserLoginFailureProviderFactory

java.lang.Object

org.keycloak.models.sessions.infinispan.InfinispanUserLoginFailureProviderFactory

All Implemented Interfaces:

UserLoginFailureProviderFactory<InfinispanUserLoginFailureProvider>, EnvironmentDependentProviderFactory, ProviderEventListener, ProviderFactory<InfinispanUserLoginFailureProvider>

public class InfinispanUserLoginFailureProviderFactory
extends Object
implements UserLoginFailureProviderFactory<InfinispanUserLoginFailureProvider>, EnvironmentDependentProviderFactory, ProviderEventListener

Author:

Martin Kanis

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REALM_REMOVED_SESSION_EVENT
static final String	REMOVE_ALL_LOGIN_FAILURES_EVENT

Constructor Summary

Constructors

Constructor	Description
InfinispanUserLoginFailureProviderFactory()

Method Summary

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

Methods inherited from interface org.keycloak.provider.ProviderFactory

getConfigMetadata

Field Details

REALM_REMOVED_SESSION_EVENT

public static final String REALM_REMOVED_SESSION_EVENT

See Also:

• Constant Field Values

REMOVE_ALL_LOGIN_FAILURES_EVENT

public static final String REMOVE_ALL_LOGIN_FAILURES_EVENT

See Also:

• Constant Field Values

Constructor Details

InfinispanUserLoginFailureProviderFactory

public InfinispanUserLoginFailureProviderFactory()

Method Details

create

public InfinispanUserLoginFailureProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<InfinispanUserLoginFailureProvider>

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

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

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

registerClusterListeners

protected void registerClusterListeners(KeycloakSession session)

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<InfinispanUserLoginFailureProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<InfinispanUserLoginFailureProvider>

order

public int order()

Specified by:

order in interface ProviderFactory<InfinispanUserLoginFailureProvider>

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.

onEvent

public void onEvent(ProviderEvent event)

Specified by:

onEvent in interface ProviderEventListener