Package org.axonframework.messaging.eventhandling.replay

Class ReplayBlockingEventHandlingComponent<E extends EventHandlingComponent & ResetHandlerRegistry<?>>

java.lang.Object

org.axonframework.messaging.eventhandling.DelegatingEventHandlingComponent

org.axonframework.messaging.eventhandling.replay.ReplayBlockingEventHandlingComponent<E>

Type Parameters:

E - the delegate EventHandlingComponent and ResetHandlerRegistry implementation

All Implemented Interfaces:

DescribableComponent, MessageHandler, EventHandler, EventHandlingComponent, ReplayStatusChangedHandler, ResetHandler, ResetHandlerRegistry<ReplayBlockingEventHandlingComponent<E>>

public class ReplayBlockingEventHandlingComponent<E extends EventHandlingComponent & ResetHandlerRegistry<?>>
extends DelegatingEventHandlingComponent
implements ResetHandlerRegistry<ReplayBlockingEventHandlingComponent<E>>

An EventHandlingComponent that blocks all event handling during replay.

This component wraps another EventHandlingComponent and prevents any events from being processed when the current TrackingToken indicates a replay is in progress (i.e., when the token is a ReplayToken).

The supportsReset() method returns true only if at least one ResetHandler has been registered through subscribe(ResetHandler).

Since:

5.1.0

Author:

Mateusz Nowak

See Also:

• ReplayToken.isReplay(TrackingToken)

Field Summary

Fields inherited from class org.axonframework.messaging.eventhandling.DelegatingEventHandlingComponent

delegate

Constructor Summary

Constructors

Constructor	Description
ReplayBlockingEventHandlingComponent(E delegate)	Constructs a ReplayBlockingEventHandlingComponent that wraps the given delegate.

Method Summary

Modifier and Type	Method	Description
MessageStream.Empty<Message>	handle(EventMessage event, ProcessingContext context)	Handles the given event unless a replay is in progress.
ReplayBlockingEventHandlingComponent<E>	subscribe(ResetHandler resetHandler)	Subscribes a ResetHandler and tracks that at least one reset handler has been registered.
boolean	supportsReset()	Returns whether this component supports reset operations.

Methods inherited from class org.axonframework.messaging.eventhandling.DelegatingEventHandlingComponent

describeTo, handle, handle, sequenceIdentifierFor, supportedEvents, supports

Methods inherited from class java.lang.Object

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

Constructor Details

ReplayBlockingEventHandlingComponent

public ReplayBlockingEventHandlingComponent(E delegate)

Constructs a ReplayBlockingEventHandlingComponent that wraps the given delegate.

Parameters:

delegate - The EventHandlingComponent to delegate calls to.

Method Details

handle

public MessageStream.Empty<Message> handle(EventMessage event,
 ProcessingContext context)

Handles the given event unless a replay is in progress.

If the TrackingToken in the context indicates a replay (i.e., is a ReplayToken), this method returns an empty MessageStream without delegating to the wrapped component.

Specified by:

handle in interface EventHandler

Overrides:

handle in class DelegatingEventHandlingComponent

Parameters:

event - The event message to handle.

context - The processing context containing the tracking token.

Returns:

An empty MessageStream if replaying, otherwise the result from the delegate.

subscribe

public ReplayBlockingEventHandlingComponent<E> subscribe(ResetHandler resetHandler)

Subscribes a ResetHandler and tracks that at least one reset handler has been registered.

This tracking is used by supportsReset() to determine if the component supports reset operations.

Specified by:

subscribe in interface ResetHandlerRegistry<E extends EventHandlingComponent & ResetHandlerRegistry<?>>

Parameters:

resetHandler - The reset handler to subscribe.

Returns:

A ResetHandlerRegistry for managing the subscription.

supportsReset

public boolean supportsReset()

Returns whether this component supports reset operations.

This implementation returns true only if at least one ResetHandler has been registered through subscribe(ResetHandler).

Specified by:

supportsReset in interface EventHandlingComponent

Overrides:

supportsReset in class DelegatingEventHandlingComponent

Returns:

true if a reset handler has been registered, false otherwise.