Package org.keycloak.events.outbox

Class OutboxDrainerTask

java.lang.Object

org.keycloak.events.outbox.OutboxDrainerTask

All Implemented Interfaces:

KeycloakSessionTask, ScheduledTask

public class OutboxDrainerTask
extends Object
implements ScheduledTask

Drains the generic outbox for one registered entryKind: locks due PENDING rows, hands them off to the kind's OutboxDeliveryHandler, and transitions each row based on the returned OutboxDeliveryOutcome.

One drainer instance per registered kind. Each is wrapped in a ClusterAwareScheduledTaskRunner at scheduling time so in an HA deployment only one node drains a given kind per interval, even though every node schedules the timer.

Concurrency within a single tick is cheap because rows are locked PESSIMISTIC_WRITE via FOR UPDATE SKIP LOCKED by the store, and each row is transitioned to a terminal state (DELIVERED / back to PENDING with a future next_attempt_at / DEAD_LETTER) before the transaction commits.

Per-tick housekeeping after the drain pass:

• Promote rows whose createdAt is older than OutboxConfig.pendingMaxAge() to DEAD_LETTER (backstop so stuck rows can't sit forever).
• Purge DELIVERED rows past OutboxConfig.deliveredRetention().
• Purge DEAD_LETTER rows past OutboxConfig.deadLetterRetention().

Field Summary

Fields

Modifier and Type	Field	Description
protected final OutboxConfig	config
protected final OutboxDeliveryHandler	handler
protected final Function<KeycloakSession,OutboxStore>	storeFactory

Constructor Summary

Constructors

Constructor	Description
OutboxDrainerTask(OutboxConfig config, OutboxDeliveryHandler handler, Function<KeycloakSession,OutboxStore> storeFactory)

Method Summary

Modifier and Type	Method	Description
protected void	drain(KeycloakSession session, OutboxStore store)
protected void	handleRetry(OutboxStore store, OutboxEntryEntity row, String errorMessage)
protected void	processOne(KeycloakSession session, OutboxStore store, OutboxEntryEntity row)
protected void	promoteStaleQueuedToDeadLetter(OutboxStore store)
protected void	purgeDeadLetterOlderThanRetention(OutboxStore store)
protected void	purgeDeliveredOlderThanRetention(OutboxStore store)
void	run(KeycloakSession session)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.timer.ScheduledTask

getTaskName

Field Details

config

protected final OutboxConfig config

handler

protected final OutboxDeliveryHandler handler

storeFactory

protected final Function<KeycloakSession,OutboxStore> storeFactory

Constructor Details

OutboxDrainerTask

public OutboxDrainerTask(OutboxConfig config,
 OutboxDeliveryHandler handler,
 Function<KeycloakSession,OutboxStore> storeFactory)

Method Details

run

public void run(KeycloakSession session)

Specified by:

run in interface KeycloakSessionTask

drain

protected void drain(KeycloakSession session,
 OutboxStore store)

processOne

protected void processOne(KeycloakSession session,
 OutboxStore store,
 OutboxEntryEntity row)

handleRetry

protected void handleRetry(OutboxStore store,
 OutboxEntryEntity row,
 String errorMessage)

promoteStaleQueuedToDeadLetter

protected void promoteStaleQueuedToDeadLetter(OutboxStore store)

purgeDeliveredOlderThanRetention

protected void purgeDeliveredOlderThanRetention(OutboxStore store)

purgeDeadLetterOlderThanRetention

protected void purgeDeadLetterOlderThanRetention(OutboxStore store)