Package org.keycloak.events.outbox

Class OutboxCleanupTask

java.lang.Object

org.keycloak.events.outbox.OutboxCleanupTask

All Implemented Interfaces:

Runnable

public class OutboxCleanupTask
extends Object
implements Runnable

Background cleanup task that drains outbox rows owned by a removed realm or owner (e.g. receiver client). Runs in a single bounded transaction so the admin's original removal transaction can commit immediately instead of carrying a six-digit DELETE on its back.

Submitted by a feature's lifecycle listener (e.g. SSF's RealmRemovedEvent / ClientRemovedEvent handler) to a Keycloak-managed executor. The task itself opens a fresh session via KeycloakModelUtils.runJobInTransaction(org.keycloak.models.KeycloakSessionFactory, org.keycloak.models.KeycloakSessionTask) so it doesn't inherit the caller's transaction or session lifecycle.

Crash safety: if the node running this task dies mid-flight, the remaining rows are orphaned. That's bounded by the pendingMaxAge backstop on the drainer for queued rows and by the configured retention windows for terminal rows — orphan rows eventually get swept either way.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OutboxCleanupTask.Scope

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	entryKind
protected final KeycloakSessionFactory	factory
protected final String	key
protected final OutboxCleanupTask.Scope	scope
protected final Function<KeycloakSession,OutboxStore>	storeFactory

Constructor Summary

Constructors

Constructor	Description
OutboxCleanupTask(KeycloakSessionFactory factory, Function<KeycloakSession,OutboxStore> storeFactory, String entryKind, OutboxCleanupTask.Scope scope, String key)

Method Summary

Modifier and Type	Method	Description
void	run()

Methods inherited from class java.lang.Object

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

Field Details

factory

protected final KeycloakSessionFactory factory

storeFactory

protected final Function<KeycloakSession,OutboxStore> storeFactory

entryKind

protected final String entryKind

scope

protected final OutboxCleanupTask.Scope scope

key

protected final String key

Constructor Details

OutboxCleanupTask

public OutboxCleanupTask(KeycloakSessionFactory factory,
 Function<KeycloakSession,OutboxStore> storeFactory,
 String entryKind,
 OutboxCleanupTask.Scope scope,
 String key)

Method Details

run

public void run()

Specified by:

run in interface Runnable