org.occurrent.subscription.blocking.durable

Class DurableSubscriptionModel

java.lang.Object

org.occurrent.subscription.blocking.durable.DurableSubscriptionModel

All Implemented Interfaces:

DelegatingSubscriptionModel, PositionAwareSubscriptionModel, Subscribable, SubscriptionModel, SubscriptionModelLifeCycle

public class DurableSubscriptionModel
extends java.lang.Object
implements PositionAwareSubscriptionModel, DelegatingSubscriptionModel

Combines a SubscriptionModel and with a SubscriptionPositionStorage to automatically persist the subscription position after each successful call to the "action" method (i.e. when the consumer in this method Subscribable.subscribe(String, Consumer) has completed successfully), thus making the subscription durable.

Note that this implementation stores the subscription position after _every_ action. If you have a lot of events and duplication is not that much of a deal, consider changing this behavior by supplying an instance of DurableSubscriptionModelConfig.

Constructor Summary

Constructors

Constructor and Description
DurableSubscriptionModel(PositionAwareSubscriptionModel subscriptionModel, SubscriptionPositionStorage storage) Create a subscription that combines a PositionAwareSubscriptionModel with a SubscriptionPositionStorage to automatically store the subscription after each successful call to action (The "consumer" in Subscribable.subscribe(String, Consumer)).
DurableSubscriptionModel(PositionAwareSubscriptionModel subscriptionModel, SubscriptionPositionStorage storage, DurableSubscriptionModelConfig config) Create a subscription that combines a PositionAwareSubscriptionModel with a SubscriptionPositionStorage to automatically store the subscription when the predicate defined in DurableSubscriptionModelConfig.persistCloudEventPositionPredicate is fulfilled.

Method Summary

Modifier and Type	Method and Description
void	cancelSubscription(java.lang.String subscriptionId) Cancel a subscription.
PositionAwareSubscriptionModel	getDelegatedSubscriptionModel()
org.occurrent.subscription.SubscriptionPosition	globalSubscriptionPosition()
boolean	isPaused(java.lang.String subscriptionId)
boolean	isRunning()
boolean	isRunning(java.lang.String subscriptionId)
void	pauseSubscription(java.lang.String subscriptionId)
Subscription	resumeSubscription(java.lang.String subscriptionId)
void	shutdown()
void	start()
void	stop()
Subscription	subscribe(java.lang.String subscriptionId, org.occurrent.subscription.SubscriptionFilter filter, org.occurrent.subscription.StartAt startAt, java.util.function.Consumer<io.cloudevents.CloudEvent> action)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.occurrent.subscription.api.blocking.Subscribable

subscribe, subscribe, subscribe

Methods inherited from interface org.occurrent.subscription.api.blocking.DelegatingSubscriptionModel

getDelegatedSubscriptionModelRecursively

Constructor Detail

DurableSubscriptionModel

public DurableSubscriptionModel(PositionAwareSubscriptionModel subscriptionModel,
                                SubscriptionPositionStorage storage)

Create a subscription that combines a PositionAwareSubscriptionModel with a SubscriptionPositionStorage to automatically store the subscription after each successful call to action (The "consumer" in Subscribable.subscribe(String, Consumer)).

Parameters:

subscriptionModel - The subscription that will read events from the event store

storage - The SubscriptionPositionStorage that'll be used to persist the stream position

DurableSubscriptionModel

public DurableSubscriptionModel(PositionAwareSubscriptionModel subscriptionModel,
                                SubscriptionPositionStorage storage,
                                DurableSubscriptionModelConfig config)

Create a subscription that combines a PositionAwareSubscriptionModel with a SubscriptionPositionStorage to automatically store the subscription when the predicate defined in DurableSubscriptionModelConfig.persistCloudEventPositionPredicate is fulfilled.

Parameters:

subscriptionModel - The subscription that will read events from the event store

storage - The SubscriptionPositionStorage that'll be used to persist the stream position

Method Detail

subscribe

public Subscription subscribe(java.lang.String subscriptionId,
                              org.occurrent.subscription.SubscriptionFilter filter,
                              org.occurrent.subscription.StartAt startAt,
                              java.util.function.Consumer<io.cloudevents.CloudEvent> action)

Specified by:

subscribe in interface Subscribable

stop

public void stop()

Specified by:

stop in interface SubscriptionModelLifeCycle

start

public void start()

Specified by:

start in interface SubscriptionModelLifeCycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface SubscriptionModelLifeCycle

isRunning

public boolean isRunning(java.lang.String subscriptionId)

Specified by:

isRunning in interface SubscriptionModelLifeCycle

isPaused

public boolean isPaused(java.lang.String subscriptionId)

Specified by:

isPaused in interface SubscriptionModelLifeCycle

resumeSubscription

public Subscription resumeSubscription(java.lang.String subscriptionId)

Specified by:

resumeSubscription in interface SubscriptionModelLifeCycle

pauseSubscription

public void pauseSubscription(java.lang.String subscriptionId)

Specified by:

pauseSubscription in interface SubscriptionModelLifeCycle

cancelSubscription

public void cancelSubscription(java.lang.String subscriptionId)

Cancel a subscription. This means that it'll no longer receive events as they are persisted to the event store. The subscription position that is persisted in the SubscriptionPositionStorage will also be removed.

Specified by:

cancelSubscription in interface SubscriptionModelLifeCycle

Parameters:

subscriptionId - The subscription id to cancel

shutdown

@PreDestroy
public void shutdown()

Specified by:

shutdown in interface SubscriptionModelLifeCycle

globalSubscriptionPosition

public org.occurrent.subscription.SubscriptionPosition globalSubscriptionPosition()

Specified by:

globalSubscriptionPosition in interface PositionAwareSubscriptionModel

getDelegatedSubscriptionModel

public PositionAwareSubscriptionModel getDelegatedSubscriptionModel()

Specified by:

getDelegatedSubscriptionModel in interface DelegatingSubscriptionModel