org.occurrent.subscription.blocking.durable

Class DurableSubscriptionModel

java.lang.Object

org.occurrent.subscription.blocking.durable.DurableSubscriptionModel

All Implemented Interfaces:

DelegatingSubscriptionModel, PositionAwareSubscriptionModel, SubscriptionModel, SubscriptionModelCancelSubscription

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

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 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 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()
void	shutdown()
Subscription	subscribe(java.lang.String subscriptionId, java.util.function.Consumer<io.cloudevents.CloudEvent> action)
Subscription	subscribe(java.lang.String subscriptionId, org.occurrent.subscription.SubscriptionFilter filter, java.util.function.Consumer<io.cloudevents.CloudEvent> action) Start listening to cloud events persisted to the event store.
Subscription	subscribe(java.lang.String subscriptionId, org.occurrent.subscription.SubscriptionFilter filter, java.util.function.Supplier<org.occurrent.subscription.StartAt> startAtSupplier, 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.SubscriptionModel

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 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,
                              java.util.function.Supplier<org.occurrent.subscription.StartAt> startAtSupplier,
                              java.util.function.Consumer<io.cloudevents.CloudEvent> action)

Specified by:

subscribe in interface SubscriptionModel

subscribe

public Subscription subscribe(java.lang.String subscriptionId,
                              java.util.function.Consumer<io.cloudevents.CloudEvent> action)

Specified by:

subscribe in interface SubscriptionModel

subscribe

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

Start listening to cloud events persisted to the event store.

Specified by:

subscribe in interface SubscriptionModel

Parameters:

subscriptionId - The id of the subscription, must be unique!

filter - The filter to apply for this subscription. Only events matching the filter will cause the action to be called.

action - This action will be invoked for each cloud event that is stored in the EventStore that matches the supplied filter.

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 SubscriptionModelCancelSubscription

Parameters:

subscriptionId - The subscription id to cancel

shutdown

@PreDestroy
public void shutdown()

Specified by:

shutdown in interface SubscriptionModel

globalSubscriptionPosition

public org.occurrent.subscription.SubscriptionPosition globalSubscriptionPosition()

Specified by:

globalSubscriptionPosition in interface PositionAwareSubscriptionModel

getDelegatedSubscriptionModel

public PositionAwareSubscriptionModel getDelegatedSubscriptionModel()

Specified by:

getDelegatedSubscriptionModel in interface DelegatingSubscriptionModel