Package org.keycloak.expiration.jpa.impl

Class DefaultExpirationTask

java.lang.Object

org.keycloak.expiration.jpa.impl.DefaultExpirationTask

All Implemented Interfaces:

Runnable, ExpirationTask

public class DefaultExpirationTask
extends Object

An ExpirationTask that runs a single global cleanup (no per-realm iteration).

Uses ServerConfigStorageProvider to coordinate across cluster nodes: a cleanup is skipped if another node ran one recently (within the configured interval).

Field Summary

Fields

Modifier and Type	Field	Description
protected final ExpirationAction	action
protected final String	entityId
protected final KeycloakSessionFactory	factory
protected final int	intervalSeconds
protected final ExpirationListener	listener
protected static final org.jboss.logging.Logger	logger
protected final int	maxRemoval

Constructor Summary

Constructors

Constructor	Description
DefaultExpirationTask(KeycloakSessionFactory factory, Executor executor, ExpirationAction action, ExpirationListener listener, String entityId, int transactionTimeoutSeconds, int intervalSeconds, int maxRemoval)

Method Summary

Modifier and Type	Method	Description
protected static Outcome	computeOutcome(boolean success, boolean failed)
final void	run()
void	schedule()	Registers this task with the TimerProvider to run periodically at the configured interval.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

protected static final org.jboss.logging.Logger logger

factory

protected final KeycloakSessionFactory factory

entityId

protected final String entityId

intervalSeconds

protected final int intervalSeconds

maxRemoval

protected final int maxRemoval

action

protected final ExpirationAction action

listener

protected final ExpirationListener listener

Constructor Details

DefaultExpirationTask

public DefaultExpirationTask(KeycloakSessionFactory factory,
 Executor executor,
 ExpirationAction action,
 ExpirationListener listener,
 String entityId,
 int transactionTimeoutSeconds,
 int intervalSeconds,
 int maxRemoval)

Method Details

run

public final void run()

Specified by:

run in interface Runnable

schedule

public void schedule()

Description copied from interface: ExpirationTask

Registers this task with the TimerProvider to run periodically at the configured interval.

Specified by:

schedule in interface ExpirationTask

computeOutcome

protected static Outcome computeOutcome(boolean success,
 boolean failed)