Package org.keycloak.expiration.jpa

Interface ExpirationTask

All Superinterfaces:

Runnable

All Known Implementing Classes:

DefaultExpirationTask, RealmAwareExpirationTask

public interface ExpirationTask
extends Runnable

A periodic task that removes expired entries from the database.

Instances are created via the ExpirationTaskBuilder and registered with the Keycloak TimerProvider by calling schedule().

Each invocation of Runnable.run() submits the cleanup work to an Executor, ensuring the timer thread is not blocked by long-running deletions. Concurrent runs are prevented by an internal guard: if a previous run is still in progress, the new invocation is skipped.

See Also:

• ExpirationTaskBuilder
• ExpirationAction

Method Summary

Modifier and Type	Method	Description
static ExpirationTaskBuilder	builder()	Returns a new ExpirationTaskBuilder to configure and build an ExpirationTask.
void	schedule()	Registers this task with the TimerProvider to run periodically at the configured interval.

Methods inherited from interface java.lang.Runnable

run

Method Details

schedule

void schedule()

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

builder

static ExpirationTaskBuilder builder()

Returns a new ExpirationTaskBuilder to configure and build an ExpirationTask.