de.otto.synapse.eventsource

Class AbstractEventSource

java.lang.Object

de.otto.synapse.eventsource.AbstractEventSource

All Implemented Interfaces:

EventSource

Direct Known Subclasses:

DefaultEventSource

public abstract class AbstractEventSource
extends java.lang.Object
implements EventSource

Constructor Summary

Constructors

Constructor and Description
AbstractEventSource(MessageLogReceiverEndpoint messageLog)

Method Summary

Modifier and Type	Method and Description
ChannelPosition	consumeUntil(ChannelPosition startFrom, java.time.Instant until) Consumes all events from the EventSource, beginning with startFrom, until the stopCondition is met.
java.lang.String	getChannelName() Returns the name of the EventSource.
MessageDispatcher	getMessageDispatcher() Returns the MessageDispatcher used to register consumers at the EventSource.
MessageLogReceiverEndpoint	getMessageLogReceiverEndpoint() Returns the MessageLogReceiverEndpoint used by the EventSource to consume events.
boolean	isStopping()
void	register(MessageConsumer<?> messageConsumer) Registers a new EventConsumer at the EventSource.
void	stop()

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.otto.synapse.eventsource.EventSource

consume, consume, consumeUntil

Constructor Detail

AbstractEventSource

public AbstractEventSource(MessageLogReceiverEndpoint messageLog)

Method Detail

getChannelName

public java.lang.String getChannelName()

Description copied from interface: EventSource

Returns the name of the EventSource.

For streaming event-sources, this is the name of the event stream.

Specified by:

getChannelName in interface EventSource

Returns:

name

stop

public void stop()

Specified by:

stop in interface EventSource

isStopping

public boolean isStopping()

Specified by:

isStopping in interface EventSource

register

public void register(MessageConsumer<?> messageConsumer)

Registers a new EventConsumer at the EventSource.

consumers have to be thread safe as it may be called from multiple threads (e.g. for kinesis streams there is one thread per shard)

Specified by:

register in interface EventSource

Parameters:

messageConsumer - the EventConsumer that is registered at the EventSource

getMessageDispatcher

@Nonnull
public MessageDispatcher getMessageDispatcher()

Returns the MessageDispatcher used to register consumers at the EventSource.

Specified by:

getMessageDispatcher in interface EventSource

Returns:

MessageDispatcher

getMessageLogReceiverEndpoint

@Nonnull
public MessageLogReceiverEndpoint getMessageLogReceiverEndpoint()

Description copied from interface: EventSource

Returns the MessageLogReceiverEndpoint used by the EventSource to consume events.

Specified by:

getMessageLogReceiverEndpoint in interface EventSource

Returns:

MessageLogReceiverEndpoint

consumeUntil

@Nonnull
public ChannelPosition consumeUntil(@Nonnull
                                             ChannelPosition startFrom,
                                             @Nonnull
                                             java.time.Instant until)

Description copied from interface: EventSource

Consumes all events from the EventSource, beginning with startFrom, until the stopCondition is met.

The registered consumers will be called zero or more times, depending on the number of events retrieved from the EventSource.

Specified by:

consumeUntil in interface EventSource

Parameters:

startFrom - the read position returned from earlier executions

until - the arrival timestamp until the messages should be consumed

Returns:

the new read position