Package org.keycloak.expiration.jpa.impl

Class RealmAwareExpirationTask

java.lang.Object

org.keycloak.expiration.jpa.impl.RealmAwareExpirationTask

All Implemented Interfaces:

Runnable, ExpirationTask

public class RealmAwareExpirationTask
extends Object

An ExpirationTask that runs cleanup per realm.

On each run, this task fetches the list of realms, removes orphan coordination keys (from deleted realms), and then iterates over each realm. Per-realm coordination via ServerConfigStorageProvider ensures that a cleanup is skipped if another node ran one recently for the same realm.

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
RealmAwareExpirationTask(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

RealmAwareExpirationTask

public RealmAwareExpirationTask(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)