Uses of Class
org.axonframework.messaging.eventhandling.processing.streaming.segmenting.Segment

Packages that use Segment

Package	Description
io.axoniq.framework.messaging.eventstreaming.checkpoint	Part of the Axoniq Framework event-streaming module.
io.axoniq.framework.workflow.runtime.execution	Internal implementation of the workflow execution engine: the WorkflowEngine, its scheduling, state and storage, checkpointing/replay support, cancellation coordination, and the delegates implementing individual step primitives.
org.axonframework.messaging.eventhandling.processing.streaming.progress	Part of the Axon Messaging module.
org.axonframework.messaging.eventhandling.processing.streaming.segmenting	Part of the Axon Messaging module.
org.axonframework.messaging.eventhandling.processing.streaming.segmenting.annotation	Part of the Axon Messaging module.
org.axonframework.messaging.eventhandling.processing.streaming.token.store	Part of the Axon Messaging module.
org.axonframework.messaging.eventhandling.processing.streaming.token.store.inmemory	Part of the Axon Messaging module.
org.axonframework.messaging.eventhandling.processing.streaming.token.store.jdbc	Part of the Axon Messaging module.
org.axonframework.messaging.eventhandling.processing.streaming.token.store.jpa	Part of the Axon Messaging module.
org.axonframework.modelling.saga	Association values, the means by which an event is correlated to the saga instances that should handle it.

Uses of Segment in io.axoniq.framework.messaging.eventstreaming.checkpoint

Methods in io.axoniq.framework.messaging.eventstreaming.checkpoint with parameters of type Segment

Modifier and Type	Method	Description
CompletableFuture<TrackingToken>	Checkpointing.onCheckpointAdvanced(Segment segment, TrackingToken requested)	Invoked on the processing thread when the processor takes a checkpoint for segment that must cover requested.
default void	Checkpointing.onSegmentClaimed(Segment segment, @Nullable TrackingToken from, CheckpointTrigger trigger)	Invoked when segment is claimed, handing the unit the CheckpointTrigger it uses to declare safe positions for that segment.
default CompletableFuture<TrackingToken>	Checkpointing.onSegmentReleased(Segment segment, TrackingToken upTo)	Invoked when segment is being released.

Uses of Segment in io.axoniq.framework.workflow.runtime.execution

Methods in io.axoniq.framework.workflow.runtime.execution with parameters of type Segment

Modifier and Type	Method	Description
void	WorkflowEngine.addCheckpointLatch(Segment segment, Runnable latch)	Adds a checkpoint latch across the current set of WorkflowExecutions owned by the given segment that are still performing tasks.
void	WorkflowEngineCheckpointingSupport.CheckpointLatchCoordinator.addCheckpointLatch(Segment segment, Runnable latch)	Adds a checkpoint latch across the current set of WorkflowExecutions owned by the given segment that are still performing tasks for the supported WorkflowEngine.
boolean	WorkflowEngine.hasUnsafeCheckpointWork(Segment segment)
boolean	WorkflowEngineCheckpointingSupport.CheckpointLatchCoordinator.hasUnsafeCheckpointWork(Segment segment)	Returns whether any WorkflowExecutions owned by the given segment still makes checkpoint advancement unsafe.
boolean	WorkflowEngine.holdsCheckpoint(Segment segment)
boolean	WorkflowEngineCheckpointingSupport.CheckpointLatchCoordinator.holdsCheckpoint(Segment segment)
CompletableFuture<TrackingToken>	CheckpointingEventHandlingComponentHandlingAny.onCheckpointAdvanced(Segment segment, TrackingToken requested)
CompletableFuture<TrackingToken>	WorkflowEngineCheckpointingSupport.onCheckpointAdvanced(Segment segment, TrackingToken requested)
void	CheckpointingEventHandlingComponentHandlingAny.onSegmentClaimed(Segment segment, @Nullable TrackingToken from, CheckpointTrigger trigger)
void	WorkflowEngineCheckpointingSupport.onSegmentClaimed(Segment segment, @Nullable TrackingToken from, CheckpointTrigger trigger)
CompletableFuture<TrackingToken>	CheckpointingEventHandlingComponentHandlingAny.onSegmentReleased(Segment segment, TrackingToken requested)
CompletableFuture<TrackingToken>	WorkflowEngineCheckpointingSupport.onSegmentReleased(Segment segment, TrackingToken requested)
CompletableFuture<Void>	WorkflowEngine.releaseWorkflowsFor(Segment segment)	Drops the workflow executions owned by a segment this node no longer holds.
CompletableFuture<Void>	WorkflowEngine.restoreWorkflowsFor(Segment segment, @Nullable TrackingToken claimedFrom, ProcessingContext sourcingContext, ProcessingContext executionContext)	Restores and starts the workflow executions owned by a segment this node just claimed.

Uses of Segment in org.axonframework.messaging.eventhandling.processing.streaming.progress

Methods in org.axonframework.messaging.eventhandling.processing.streaming.progress that return Segment

Modifier and Type	Method	Description
Segment	SegmentProgressContext.segment()	Returns the Segment this strategy is responsible for.

Uses of Segment in org.axonframework.messaging.eventhandling.processing.streaming.segmenting

Fields in org.axonframework.messaging.eventhandling.processing.streaming.segmenting declared as Segment

Modifier and Type	Field	Description
static final Segment	Segment.ROOT_SEGMENT	Represents the Segment that matches against all input, but can be split to start processing elements in parallel.

Fields in org.axonframework.messaging.eventhandling.processing.streaming.segmenting with type parameters of type Segment

Modifier and Type	Field	Description
static final Context.ResourceKey<Segment>	Segment.RESOURCE_KEY	The Context.ResourceKey used whenever a Context would contain a segment id.

Methods in org.axonframework.messaging.eventhandling.processing.streaming.segmenting that return Segment

Modifier and Type	Method	Description
Segment	EventTrackerStatus.getSegment()	The segment for which this status is valid.
Segment	TrackerStatus.getSegment()
Segment	WrappedTrackerStatus.getSegment()
Segment	Segment.mergedWith(Segment other)	Calculates the Segment that represents the merger of this segment with the given other segment.
Segment[]	Segment.split()	Returns an array with two segments with a corresponding mask. The first entry contains the original segmentId, with the newly calculated mask.

Methods in org.axonframework.messaging.eventhandling.processing.streaming.segmenting that return types with arguments of type Segment

Modifier and Type	Method	Description
static Optional<Segment>	Segment.fromContext(Context context)	Returns an Optional of Segment, returning the resource keyed under the RESOURCE_KEY in the given context.
static List<Segment>	Segment.splitBalanced(Segment segment, int numberOfTimes)	Split a given Segment n-times in round robin fashion.

Methods in org.axonframework.messaging.eventhandling.processing.streaming.segmenting with parameters of type Segment

Modifier and Type	Method	Description
static Context	Segment.addToContext(Context context, Segment segment)	Adds the given segment to the given context using the RESOURCE_KEY.
int	Segment.compareTo(Segment that)
boolean	Segment.isMergeableWith(Segment other)	Indicates whether this segment can be merged with the given other segment.
static boolean	SegmentMatcher.matches(Segment segment, Object sequenceIdentifier)	Checks whether the given segment matches the given sequenceIdentifier, based on the hash code of the identifier.
Segment	Segment.mergedWith(Segment other)	Calculates the Segment that represents the merger of this segment with the given other segment.
CompletableFuture<Void>	SegmentChangeListener.onSegmentClaimed(Segment segment, @Nullable TrackingToken from)	Invoked when a segment has been claimed and processing for that segment is started.
CompletableFuture<Void>	SimpleSegmentChangeListener.onSegmentClaimed(Segment segment, @Nullable TrackingToken from)
CompletableFuture<Void>	SegmentChangeListener.onSegmentReleased(Segment segment)	Invoked when a segment has been released.
CompletableFuture<Void>	SimpleSegmentChangeListener.onSegmentReleased(Segment segment)
static TrackerStatus[]	TrackerStatus.split(Segment segment, TrackingToken trackingToken)	Split the given segment and trackingToken in two.
static List<Segment>	Segment.splitBalanced(Segment segment, int numberOfTimes)	Split a given Segment n-times in round robin fashion.

Method parameters in org.axonframework.messaging.eventhandling.processing.streaming.segmenting with type arguments of type Segment

Modifier and Type	Method	Description
static SegmentChangeListener	SegmentChangeListener.onClaim(Function<Segment,CompletableFuture<Void>> onClaim)	Creates a listener that reacts only to claim events.
static SegmentChangeListener	SegmentChangeListener.onRelease(Function<Segment,CompletableFuture<Void>> onRelease)	Creates a listener that reacts only to release events.
static SegmentChangeListener	SegmentChangeListener.runOnClaim(Consumer<Segment> onClaim)	Creates a listener that executes synchronously on claim events.
static SegmentChangeListener	SegmentChangeListener.runOnRelease(Consumer<Segment> onRelease)	Creates a listener that executes synchronously on release events.

Constructors in org.axonframework.messaging.eventhandling.processing.streaming.segmenting with parameters of type Segment

Modifier	Constructor	Description
	TrackerStatus(Segment segment, boolean caughtUp, TrackingToken trackingToken, Throwable errorState)	Construct a EventTrackerStatus to portray the status of the given segment and trackingToken.
	TrackerStatus(Segment segment, TrackingToken trackingToken)	Construct a EventTrackerStatus to portray the status of the given segment and trackingToken.

Constructor parameters in org.axonframework.messaging.eventhandling.processing.streaming.segmenting with type arguments of type Segment

Modifier	Constructor	Description
	SimpleSegmentChangeListener(BiFunction<Segment,TrackingToken,CompletableFuture<Void>> onClaim, Function<Segment,CompletableFuture<Void>> onRelease)	Creates a listener with explicit claim and release handlers.
	SimpleSegmentChangeListener(BiFunction<Segment,TrackingToken,CompletableFuture<Void>> onClaim, Function<Segment,CompletableFuture<Void>> onRelease)	Creates a listener with explicit claim and release handlers.

Uses of Segment in org.axonframework.messaging.eventhandling.processing.streaming.segmenting.annotation

Methods in org.axonframework.messaging.eventhandling.processing.streaming.segmenting.annotation that return types with arguments of type Segment

Modifier and Type	Method	Description
@Nullable ParameterResolver<Segment>	SegmentParameterResolverFactory.createInstance(Executable executable, Parameter[] parameters, int parameterIndex)

Uses of Segment in org.axonframework.messaging.eventhandling.processing.streaming.token.store

Methods in org.axonframework.messaging.eventhandling.processing.streaming.token.store that return types with arguments of type Segment

Modifier and Type	Method	Description
CompletableFuture<List<Segment>>	TokenStore.fetchAvailableSegments(String processorName, @Nullable ProcessingContext context)	Returns a CompletableFuture supplying a List of known available Segments for a given processorName.
CompletableFuture<Segment>	TokenStore.fetchSegment(String processorName, int segmentId, @Nullable ProcessingContext context)	Returns a CompletableFuture that supplies the specified Segment, or null if there was no such segment.
CompletableFuture<List<Segment>>	TokenStore.fetchSegments(String processorName, @Nullable ProcessingContext context)	Returns a CompletableFuture that supplies a list of known segments for a given processorName on completion.
CompletableFuture<List<Segment>>	TokenStore.initializeTokenSegments(String processorName, int segmentCount, @Nullable TrackingToken initialToken, @Nullable ProcessingContext context)	Initializes a given number of segments for the given processorName to track its tokens.

Methods in org.axonframework.messaging.eventhandling.processing.streaming.token.store with parameters of type Segment

Modifier and Type	Method	Description
default CompletableFuture<TrackingToken>	TokenStore.fetchToken(String processorName, Segment segment, @Nullable ProcessingContext context)	Fetches the last stored token for the given processorName and segment.
CompletableFuture<Void>	TokenStore.initializeSegment(@Nullable TrackingToken token, String processorName, Segment segment, @Nullable ProcessingContext context)	Initializes a segment with given segment for the processor with given processorName to contain the given token.

Uses of Segment in org.axonframework.messaging.eventhandling.processing.streaming.token.store.inmemory

Methods in org.axonframework.messaging.eventhandling.processing.streaming.token.store.inmemory that return types with arguments of type Segment

Modifier and Type	Method	Description
CompletableFuture<List<Segment>>	InMemoryTokenStore.fetchAvailableSegments(String processorName, ProcessingContext context)
CompletableFuture<Segment>	InMemoryTokenStore.fetchSegment(String processorName, int segmentId, @Nullable ProcessingContext context)
CompletableFuture<List<Segment>>	InMemoryTokenStore.fetchSegments(String processorName, @Nullable ProcessingContext context)
CompletableFuture<List<Segment>>	InMemoryTokenStore.initializeTokenSegments(String processorName, int segmentCount, @Nullable TrackingToken initialToken, @Nullable ProcessingContext context)

Methods in org.axonframework.messaging.eventhandling.processing.streaming.token.store.inmemory with parameters of type Segment

Modifier and Type	Method	Description
CompletableFuture<Void>	InMemoryTokenStore.initializeSegment(@Nullable TrackingToken token, String processorName, Segment segment, @Nullable ProcessingContext context)

Uses of Segment in org.axonframework.messaging.eventhandling.processing.streaming.token.store.jdbc

Methods in org.axonframework.messaging.eventhandling.processing.streaming.token.store.jdbc that return Segment

Modifier and Type	Method	Description
Segment	JdbcTokenEntry.getSegment()	Returns the segment of this token.

Methods in org.axonframework.messaging.eventhandling.processing.streaming.token.store.jdbc that return types with arguments of type Segment

Modifier and Type	Method	Description
CompletableFuture<List<Segment>>	JdbcTokenStore.fetchAvailableSegments(String processorName, @Nullable ProcessingContext context)
CompletableFuture<Segment>	JdbcTokenStore.fetchSegment(String processorName, int segmentId, @Nullable ProcessingContext context)
CompletableFuture<List<Segment>>	JdbcTokenStore.fetchSegments(String processorName, @Nullable ProcessingContext context)
CompletableFuture<List<Segment>>	JdbcTokenStore.initializeTokenSegments(String processorName, int segmentCount, @Nullable TrackingToken initialToken, @Nullable ProcessingContext context)

Methods in org.axonframework.messaging.eventhandling.processing.streaming.token.store.jdbc with parameters of type Segment

Modifier and Type	Method	Description
CompletableFuture<TrackingToken>	JdbcTokenStore.fetchToken(String processorName, Segment segment, @Nullable ProcessingContext context)
CompletableFuture<Void>	JdbcTokenStore.initializeSegment(@Nullable TrackingToken token, String processorName, Segment segment, @Nullable ProcessingContext context)
protected TrackingToken	JdbcTokenStore.insertTokenEntry(Connection connection, TrackingToken token, String processorName, Segment segment)	Inserts a new token entry via the given updatable resultSet.
protected TrackingToken	JdbcTokenStore.loadToken(Connection connection, ResultSet resultSet, String processorName, Segment segment)	Tries to load an existing token owned by a processor with given processorName and segment.
protected void	JdbcTokenStore.validateSegment(String processorName, Segment segment, Connection connection)	Validate a segment by checking for the existence of a split or merge candidate segment.

Constructors in org.axonframework.messaging.eventhandling.processing.streaming.token.store.jdbc with parameters of type Segment

Modifier	Constructor	Description
	JdbcTokenEntry(byte[] token, String tokenType, String timestamp, String owner, String processorName, Segment segment)	Initializes a token entry from existing data.

Uses of Segment in org.axonframework.messaging.eventhandling.processing.streaming.token.store.jpa

Methods in org.axonframework.messaging.eventhandling.processing.streaming.token.store.jpa that return Segment

Modifier and Type	Method	Description
Segment	TokenEntry.getSegment()	Returns the segment of this token.

Methods in org.axonframework.messaging.eventhandling.processing.streaming.token.store.jpa that return types with arguments of type Segment

Modifier and Type	Method	Description
CompletableFuture<List<Segment>>	JpaTokenStore.fetchAvailableSegments(String processorName, @Nullable ProcessingContext context)
CompletableFuture<Segment>	JpaTokenStore.fetchSegment(String processorName, int segmentId, @Nullable ProcessingContext context)
CompletableFuture<List<Segment>>	JpaTokenStore.fetchSegments(String processorName, @Nullable ProcessingContext context)
CompletableFuture<List<Segment>>	JpaTokenStore.initializeTokenSegments(String processorName, int segmentCount, @Nullable TrackingToken initialToken, @Nullable ProcessingContext context)

Methods in org.axonframework.messaging.eventhandling.processing.streaming.token.store.jpa with parameters of type Segment

Modifier and Type	Method	Description
CompletableFuture<TrackingToken>	JpaTokenStore.fetchToken(String processorName, Segment segment, @Nullable ProcessingContext context)
CompletableFuture<Void>	JpaTokenStore.initializeSegment(@Nullable TrackingToken token, String processorName, Segment segment, @Nullable ProcessingContext context)
protected TokenEntry	JpaTokenStore.loadToken(String processorName, Segment segment, jakarta.persistence.EntityManager entityManager)	Tries loading an existing token owned by a processor with given processorName and segment.

Constructors in org.axonframework.messaging.eventhandling.processing.streaming.token.store.jpa with parameters of type Segment

Modifier	Constructor	Description
	TokenEntry(String processorName, Segment segment, @Nullable TrackingToken token, Converter converter)	Initializes a new token entry for given token, processorName and segment.

Uses of Segment in org.axonframework.modelling.saga

Methods in org.axonframework.modelling.saga with parameters of type Segment

Modifier and Type	Method	Description
protected String	AbstractSagaManager.createSagaIdentifier(Segment segment)	Creates a Saga identifier that will cause a Saga instance to be considered part of the given segment.
protected boolean	AbstractSagaManager.matchesSegment(Segment segment, String sagaId)	Checks whether the given sagaId matches with the given segment.