Package org.axonframework.messaging.eventstreaming

Interface StreamableEventSource

All Superinterfaces:

TrackingTokenSource

All Known Subinterfaces:

EventStore

All Known Implementing Classes:

InterceptingEventStore, RecordingEventStore, StorageEngineBackedEventStore

public interface StreamableEventSource
extends TrackingTokenSource

Interface towards a streamable event source.

Provides functionality to open an event stream.

Since:

3.0

Author:

Allard Buijze, Rene de Waele, Steven van Beelen

Method Summary

Modifier and Type	Method	Description
MessageStream<EventMessage>	open(StreamingCondition condition, ProcessingContext context)	Open an event stream containing all events matching the given condition.

Methods inherited from interface org.axonframework.messaging.eventstreaming.TrackingTokenSource

firstToken, latestToken, tokenAt

Method Details

open

MessageStream<EventMessage> open(@Nonnull
 StreamingCondition condition,
 @Nullable
 ProcessingContext context)

Open an event stream containing all events matching the given condition.

To retrieve the position of the returned events, the TrackingToken.fromContext(Context) operation should be used by providing the entire MessageStream.Entry wrapping the returned events.

Note that the returned stream is infinite, so beware of applying terminal operations to the returned stream.

When all events are of interest during streaming, then use EventCriteria.havingAnyTag() as the condition criteria.

Parameters:

condition - The StreamingCondition defining the starting position of the stream and event criteria to filter the stream with.

context - The current ProcessingContext, if any.

Returns:

An event stream matching the given condition.