Package io.axoniq.framework.messaging.eventstreaming.checkpoint

Class CheckpointingProgressStrategyFactory

java.lang.Object

io.axoniq.framework.messaging.eventstreaming.checkpoint.CheckpointingProgressStrategyFactory

All Implemented Interfaces:

SegmentProgressStrategyFactory

@Internal
public final class CheckpointingProgressStrategyFactory
extends Object
implements SegmentProgressStrategyFactory

SegmentProgressStrategyFactory that produces a CheckpointingProgressStrategy for every segment of a processor whose components include one or more self-checkpointing Checkpointing units. It carries the processor-scoped participants and the auto/deferred mode, and creates one strategy per work package.

Use detecting() to obtain the component-driven selector: given a processor's EventHandlingComponents it inspects them for Checkpointing units (via EventHandlingComponent.unwrap(Class)) and returns either this checkpointing factory (when any participate) or the default token-storing factory (when none do).

Internal API. This class is marked Internal: it is part of the self-checkpointing support, intended primarily for internal and advanced use, and its shape may change in a minor or patch release.

Since:

5.3.0

Author:

Allard Buijze

See Also:

• CheckpointingProgressStrategy

Constructor Summary

Constructors

Constructor	Description
CheckpointingProgressStrategyFactory(List<Checkpointing> participants, boolean autoCheckpointing)	Constructs a CheckpointingProgressStrategyFactory for the given participants.

Method Summary

Modifier and Type	Method	Description
SegmentProgressStrategy	create(SegmentProgressContext context)	Creates the SegmentProgressStrategy for the segment owning the given context.
static Function<List<EventHandlingComponent>,SegmentProgressStrategyFactory>	detecting()	Returns the component-driven selector used to pick a SegmentProgressStrategyFactory for a processor: a CheckpointingProgressStrategyFactory when its components include self-checkpointing Checkpointing units, otherwise the default token-storing factory.

Methods inherited from class java.lang.Object

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

Constructor Details

CheckpointingProgressStrategyFactory

public CheckpointingProgressStrategyFactory(List<Checkpointing> participants,
 boolean autoCheckpointing)

Constructs a CheckpointingProgressStrategyFactory for the given participants.

Parameters:

participants - the self-checkpointing units of the processor; must not be empty

autoCheckpointing - true when an ordinary handler is co-located (auto mode), false when every handler is self-checkpointing (fully-deferred)

Method Details

detecting

public static Function<List<EventHandlingComponent>,SegmentProgressStrategyFactory> detecting()

Returns the component-driven selector used to pick a SegmentProgressStrategyFactory for a processor: a CheckpointingProgressStrategyFactory when its components include self-checkpointing Checkpointing units, otherwise the default token-storing factory.

A component is self-checkpointing iff it (or the POJO it wraps) resolves to a Checkpointing unit. The processor runs in auto mode unless every component is self-checkpointing (fully-deferred); a mixed processor is logged, since the self-checkpointing components cannot then defer the stored token.

Returns:

a function mapping a processor's components to the appropriate progress-strategy factory

create

public SegmentProgressStrategy create(SegmentProgressContext context)

Description copied from interface: SegmentProgressStrategyFactory

Creates the SegmentProgressStrategy for the segment owning the given context.

The context is bound to a single segment; the returned strategy should retain it to observe and persist that segment's progress.

Specified by:

create in interface SegmentProgressStrategyFactory

Parameters:

context - the progress context to bind the strategy to

Returns:

a strategy bound to context