Package org.keycloak.models.sessions.infinispan.remote

Class RemoteUserLoginFailureProviderFactory

java.lang.Object

org.keycloak.models.sessions.infinispan.remote.RemoteUserLoginFailureProviderFactory

All Implemented Interfaces:

UpdaterFactory<LoginFailureKey,LoginFailureEntity,LoginFailuresUpdater>, RemoteChangeLogTransaction.SharedState<LoginFailureKey,LoginFailureEntity>, UserLoginFailureProviderFactory<RemoteUserLoginFailureProvider>, EnvironmentDependentProviderFactory, ProviderFactory<RemoteUserLoginFailureProvider>, ServerInfoAwareProviderFactory

public class RemoteUserLoginFailureProviderFactory
extends Object
implements UserLoginFailureProviderFactory<RemoteUserLoginFailureProvider>, UpdaterFactory<LoginFailureKey,LoginFailureEntity,LoginFailuresUpdater>, EnvironmentDependentProviderFactory, RemoteChangeLogTransaction.SharedState<LoginFailureKey,LoginFailureEntity>, ServerInfoAwareProviderFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROTO_ENTITY

Constructor Summary

Constructors

Constructor	Description
RemoteUserLoginFailureProviderFactory()

Method Summary

Modifier and Type	Method	Description
int	backOffBaseTimeMillis()
org.infinispan.util.concurrent.BlockingManager	blockingManager()
org.infinispan.client.hotrod.RemoteCache<LoginFailureKey,LoginFailureEntity>	cache()
void	close()	This is called when the server shuts down.
RemoteUserLoginFailureProvider	create(KeycloakSession session)
LoginFailuresUpdater	create(LoginFailureKey key, LoginFailureEntity entity)	Creates an Updater for an entity created by the current Keycloak transaction.
LoginFailuresUpdater	deleted(LoginFailureKey key)	Deletes a entity that was not previous read by the Keycloak transaction.
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.
boolean	isSupported(Config.Scope config)	Check if the provider is supported and should be available based on the provider configuration.
int	maxRetries()
int	order()
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized
void	setMaxRetries(int maxRetries)
LoginFailuresUpdater	wrapFromCache(LoginFailureKey key, LoginFailureEntity value, long version)	Wraps an entity read from the Infinispan cache.

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.sessions.infinispan.changes.remote.updater.UpdaterFactory

wrapFromCache

Field Details

PROTO_ENTITY

public static final String PROTO_ENTITY

Constructor Details

RemoteUserLoginFailureProviderFactory

public RemoteUserLoginFailureProviderFactory()

Method Details

create

public RemoteUserLoginFailureProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<RemoteUserLoginFailureProvider>

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

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

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<RemoteUserLoginFailureProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<RemoteUserLoginFailureProvider>

order

public int order()

Specified by:

order in interface ProviderFactory<RemoteUserLoginFailureProvider>

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.

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

Returns:

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

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

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

create

public LoginFailuresUpdater create(LoginFailureKey key,
 LoginFailureEntity entity)

Description copied from interface: UpdaterFactory

Creates an Updater for an entity created by the current Keycloak transaction.

Specified by:

create in interface UpdaterFactory<LoginFailureKey,LoginFailureEntity,LoginFailuresUpdater>

Parameters:

key - The Infinispan key.

entity - The Infinispan value.

Returns:

The Updater to be used when updating the entity state.

wrapFromCache

public LoginFailuresUpdater wrapFromCache(LoginFailureKey key,
 LoginFailureEntity value,
 long version)

Description copied from interface: UpdaterFactory

Wraps an entity read from the Infinispan cache.

Specified by:

wrapFromCache in interface UpdaterFactory<LoginFailureKey,LoginFailureEntity,LoginFailuresUpdater>

Parameters:

key - The Infinispan key.

value - The Infinispan value.

version - The entry version.

Returns:

The Updater to be used when updating the entity state.

deleted

public LoginFailuresUpdater deleted(LoginFailureKey key)

Description copied from interface: UpdaterFactory

Deletes a entity that was not previous read by the Keycloak transaction.

Specified by:

deleted in interface UpdaterFactory<LoginFailureKey,LoginFailureEntity,LoginFailuresUpdater>

Parameters:

key - The Infinispan key.

Returns:

The Updater for a deleted entity.

cache

public org.infinispan.client.hotrod.RemoteCache<LoginFailureKey,LoginFailureEntity> cache()

Specified by:

cache in interface RemoteChangeLogTransaction.SharedState<LoginFailureKey,LoginFailureEntity>

maxRetries

public int maxRetries()

Specified by:

maxRetries in interface RemoteChangeLogTransaction.SharedState<LoginFailureKey,LoginFailureEntity>

backOffBaseTimeMillis

public int backOffBaseTimeMillis()

Specified by:

backOffBaseTimeMillis in interface RemoteChangeLogTransaction.SharedState<LoginFailureKey,LoginFailureEntity>

blockingManager

public org.infinispan.util.concurrent.BlockingManager blockingManager()

Specified by:

blockingManager in interface RemoteChangeLogTransaction.SharedState<LoginFailureKey,LoginFailureEntity>

setMaxRetries

public void setMaxRetries(int maxRetries)