Package com.eventstore.dbclient

Class EventStoreDBPersistentSubscriptionsClient

java.lang.Object

com.eventstore.dbclient.EventStoreDBPersistentSubscriptionsClient

public class EventStoreDBPersistentSubscriptionsClient
extends Object

Represents EventStoreDB client for persistent subscriptions management. A client instance maintains a two-way communication to EventStoreDB. Many threads can use the EventStoreDB client simultaneously, or a single thread can make many asynchronous requests.

Method Summary

Modifier and Type	Method	Description
static EventStoreDBPersistentSubscriptionsClient	create(EventStoreDBClientSettings settings)	Creates a persistent subscription client instance.
CompletableFuture	createToAll(String group)	Creates a persistent subscription group on the $all stream.
CompletableFuture	createToAll(String group, CreatePersistentSubscriptionToAllOptions options)	Creates a persistent subscription group on the $all stream.
CompletableFuture	createToStream(String stream, String group)	Creates a persistent subscription group on a stream.
CompletableFuture	createToStream(String stream, String group, CreatePersistentSubscriptionToStreamOptions options)	Creates a persistent subscription group on a stream.
CompletableFuture	deleteToAll(String group)	Deletes a persistent subscription group on the $all stream.
CompletableFuture	deleteToAll(String group, DeletePersistentSubscriptionOptions options)	Deletes a persistent subscription group on the $all stream.
CompletableFuture	deleteToStream(String stream, String group)	Deletes a persistent subscription group on a stream.
CompletableFuture	deleteToStream(String stream, String group, DeletePersistentSubscriptionOptions options)	Deletes a persistent subscription group on a stream.
static EventStoreDBPersistentSubscriptionsClient	from(EventStoreDBClientBase existingClient)	Returns a Persistent Subscription Management client based on existing client.
CompletableFuture<Optional<PersistentSubscriptionToAllInfo>>	getInfoToAll(String groupName)	Gets a specific persistent subscription info to the $all stream.
CompletableFuture<Optional<PersistentSubscriptionToAllInfo>>	getInfoToAll(String groupName, GetPersistentSubscriptionInfoOptions options)	Gets a specific persistent subscription info to the $all stream.
CompletableFuture<Optional<PersistentSubscriptionToStreamInfo>>	getInfoToStream(String stream, String groupName)	Gets a specific persistent subscription info to a stream.
CompletableFuture<Optional<PersistentSubscriptionToStreamInfo>>	getInfoToStream(String stream, String groupName, GetPersistentSubscriptionInfoOptions options)	Gets a specific persistent subscription info.
boolean	isShutdown()	Checks if this client instance has been shutdown.
CompletableFuture<List<PersistentSubscriptionInfo>>	listAll()	Lists all existing persistent subscriptions.
CompletableFuture<List<PersistentSubscriptionInfo>>	listAll(ListPersistentSubscriptionsOptions options)	Lists all existing persistent subscriptions.
CompletableFuture<List<PersistentSubscriptionToAllInfo>>	listToAll()	Lists all persistent subscriptions of a specific to the $all stream.
CompletableFuture<List<PersistentSubscriptionToAllInfo>>	listToAll(ListPersistentSubscriptionsOptions options)	Lists all persistent subscriptions of a specific to the $all stream.
CompletableFuture<List<PersistentSubscriptionToStreamInfo>>	listToStream(String stream)	Lists all persistent subscriptions of a specific stream.
CompletableFuture<List<PersistentSubscriptionToStreamInfo>>	listToStream(String stream, ListPersistentSubscriptionsOptions options)	Lists all persistent subscriptions of a specific stream.
CompletableFuture	replayParkedMessagesToAll(String groupName)	Replays a persistent subscription to the $all stream parked events.
CompletableFuture	replayParkedMessagesToAll(String groupName, ReplayParkedMessagesOptions options)	Replays a persistent subscription to the $all stream parked events.
CompletableFuture	replayParkedMessagesToStream(String stream, String groupName)	Replays a persistent subscription to a stream parked events.
CompletableFuture	replayParkedMessagesToStream(String stream, String groupName, ReplayParkedMessagesOptions options)	Replays a persistent subscription to a stream parked events.
CompletableFuture	restartSubsystem()	Restarts the server persistent subscription subsystem.
CompletableFuture	restartSubsystem(RestartPersistentSubscriptionSubsystemOptions options)	Restarts the server persistent subscription subsystem.
CompletableFuture<Void>	shutdown()	Closes a connection and cleans all its allocated resources.
CompletableFuture<PersistentSubscription>	subscribeToAll(String group, PersistentSubscriptionListener listener)	Connects to a persistent subscription group on the $all stream.
CompletableFuture<PersistentSubscription>	subscribeToAll(String group, SubscribePersistentSubscriptionOptions options, PersistentSubscriptionListener listener)	Connects to a persistent subscription group on the $all stream.
CompletableFuture<PersistentSubscription>	subscribeToStream(String stream, String group, PersistentSubscriptionListener listener)	Connects to a persistent subscription group on a stream.
CompletableFuture<PersistentSubscription>	subscribeToStream(String stream, String group, SubscribePersistentSubscriptionOptions options, PersistentSubscriptionListener listener)	Connects to a persistent subscription group on a stream.
CompletableFuture	updateToAll(String group)	Updates a persistent subscription group on the $all stream.
CompletableFuture	updateToAll(String group, UpdatePersistentSubscriptionToAllOptions options)	Updates a persistent subscription group on the $all stream.
CompletableFuture	updateToStream(String stream, String group)	Updates a persistent subscription group on a stream.
CompletableFuture	updateToStream(String stream, String group, UpdatePersistentSubscriptionToStreamOptions options)	Updates a persistent subscription group on a stream.

Methods inherited from class java.lang.Object

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

Method Details

create

public static EventStoreDBPersistentSubscriptionsClient create(EventStoreDBClientSettings settings)

Creates a persistent subscription client instance.

from

public static EventStoreDBPersistentSubscriptionsClient from(EventStoreDBClientBase existingClient)

Returns a Persistent Subscription Management client based on existing client.

Parameters:

existingClient - Existing client.

createToStream

public CompletableFuture createToStream(String stream,
 String group)

Creates a persistent subscription group on a stream.

Persistent subscriptions are special kind of subscription where the server remembers the state of the subscription. This allows for many different modes of operations compared to a regular or catchup subscription where the client holds the subscription state. Persistent subscriptions don't guarantee ordering and unlike catchup-subscriptions, they start from the end of stream by default.

Parameters:

stream - stream's name.

group - group's name

createToAll

public CompletableFuture createToAll(String group)

Creates a persistent subscription group on the $all stream.

Persistent subscriptions are special kind of subscription where the server remembers the state of the subscription. This allows for many different modes of operations compared to a regular or catchup subscription where the client holds the subscription state. Persistent subscriptions don't guarantee ordering and unlike catchup-subscriptions, they start from the end of stream by default.

Parameters:

group - group's name

createToStream

public CompletableFuture createToStream(String stream,
 String group,
 CreatePersistentSubscriptionToStreamOptions options)

Creates a persistent subscription group on a stream.

Persistent subscriptions are special kind of subscription where the server remembers the state of the subscription. This allows for many different modes of operations compared to a regular or catchup subscription where the client holds the subscription state. Persistent subscriptions don't guarantee ordering and unlike catchup-subscriptions, they start from the end of stream by default.

Parameters:

stream - stream's name.

group - group's name

options - create persistent subscription request's options.

createToAll

public CompletableFuture createToAll(String group,
 CreatePersistentSubscriptionToAllOptions options)

Creates a persistent subscription group on the $all stream.

Persistent subscriptions are special kind of subscription where the server remembers the state of the subscription. This allows for many different modes of operations compared to a regular or catchup subscription where the client holds the subscription state. Persistent subscriptions don't guarantee ordering and unlike catchup-subscriptions, they start from the end of stream by default.

Parameters:

group - group's name

options - create persistent subscription request's options.

updateToStream

public CompletableFuture updateToStream(String stream,
 String group)

Updates a persistent subscription group on a stream.

Parameters:

stream - stream's name.

group - group's name.

updateToAll

public CompletableFuture updateToAll(String group)

Updates a persistent subscription group on the $all stream.

Parameters:

group - group's name.

updateToStream

public CompletableFuture updateToStream(String stream,
 String group,
 UpdatePersistentSubscriptionToStreamOptions options)

Updates a persistent subscription group on a stream.

Parameters:

stream - stream's name.

group - group's name.

options - update persistent subscription request's options.

updateToAll

public CompletableFuture updateToAll(String group,
 UpdatePersistentSubscriptionToAllOptions options)

Updates a persistent subscription group on the $all stream.

Parameters:

group - group's name.

options - update persistent subscription request's options.

deleteToStream

public CompletableFuture deleteToStream(String stream,
 String group)

Deletes a persistent subscription group on a stream.

Parameters:

stream - stream's name.

group - group's name.

deleteToAll

public CompletableFuture deleteToAll(String group)

Deletes a persistent subscription group on the $all stream.

Parameters:

group - group's name.

deleteToStream

public CompletableFuture deleteToStream(String stream,
 String group,
 DeletePersistentSubscriptionOptions options)

Deletes a persistent subscription group on a stream.

Parameters:

stream - stream's name.

group - group's name.

options - the delete persistent subscription request's options.

deleteToAll

public CompletableFuture deleteToAll(String group,
 DeletePersistentSubscriptionOptions options)

Deletes a persistent subscription group on the $all stream.

Parameters:

group - group's name.

options - the delete persistent subscription request's options.

subscribeToStream

public CompletableFuture<PersistentSubscription> subscribeToStream(String stream,
 String group,
 PersistentSubscriptionListener listener)

Connects to a persistent subscription group on a stream.

Parameters:

stream - stream's name.

group - group's name.

listener - persistent subscription event listener.

Returns:

a persistent subscription handle.

subscribeToAll

public CompletableFuture<PersistentSubscription> subscribeToAll(String group,
 PersistentSubscriptionListener listener)

Connects to a persistent subscription group on the $all stream.

Parameters:

group - group's name.

listener - persistent subscription event listener.

Returns:

a persistent subscription handle.

subscribeToStream

public CompletableFuture<PersistentSubscription> subscribeToStream(String stream,
 String group,
 SubscribePersistentSubscriptionOptions options,
 PersistentSubscriptionListener listener)

Connects to a persistent subscription group on a stream.

Parameters:

stream - stream's name.

group - group's name.

options - a persistent subscription subscribe's request.

listener - persistent subscription event listener.

Returns:

a persistent subscription handle.

subscribeToAll

public CompletableFuture<PersistentSubscription> subscribeToAll(String group,
 SubscribePersistentSubscriptionOptions options,
 PersistentSubscriptionListener listener)

Connects to a persistent subscription group on the $all stream.

Parameters:

group - group's name.

options - a persistent subscription subscribe's request.

listener - persistent subscription event listener.

Returns:

a persistent subscription handle.

listAll

public CompletableFuture<List<PersistentSubscriptionInfo>> listAll(ListPersistentSubscriptionsOptions options)

Lists all existing persistent subscriptions.

Parameters:

options - list persistent subscriptions request's options.

See Also:

• PersistentSubscriptionInfo

listAll

public CompletableFuture<List<PersistentSubscriptionInfo>> listAll()

Lists all existing persistent subscriptions.

See Also:

• PersistentSubscriptionInfo

listToStream

public CompletableFuture<List<PersistentSubscriptionToStreamInfo>> listToStream(String stream,
 ListPersistentSubscriptionsOptions options)

Lists all persistent subscriptions of a specific stream.

Parameters:

stream - stream's name.

options - list persistent subscriptions request's options.

listToStream

public CompletableFuture<List<PersistentSubscriptionToStreamInfo>> listToStream(String stream)

Lists all persistent subscriptions of a specific stream.

Parameters:

stream - stream's name.

See Also:

• PersistentSubscriptionToStreamInfo

listToAll

public CompletableFuture<List<PersistentSubscriptionToAllInfo>> listToAll()

Lists all persistent subscriptions of a specific to the $all stream.

See Also:

• PersistentSubscriptionToAllInfo

listToAll

public CompletableFuture<List<PersistentSubscriptionToAllInfo>> listToAll(ListPersistentSubscriptionsOptions options)

Lists all persistent subscriptions of a specific to the $all stream.

Parameters:

options - list persistent subscriptions request's options.

See Also:

• PersistentSubscriptionToAllInfo

getInfoToStream

public CompletableFuture<Optional<PersistentSubscriptionToStreamInfo>> getInfoToStream(String stream,
 String groupName,
 GetPersistentSubscriptionInfoOptions options)

Gets a specific persistent subscription info.

Parameters:

stream - stream's name.

groupName - group's name.

options - get persistent subscription info request's options.

See Also:

• PersistentSubscriptionInfo

getInfoToStream

public CompletableFuture<Optional<PersistentSubscriptionToStreamInfo>> getInfoToStream(String stream,
 String groupName)

Gets a specific persistent subscription info to a stream.

Parameters:

stream - stream's name.

groupName - group's name.

See Also:

• PersistentSubscriptionInfo

getInfoToAll

public CompletableFuture<Optional<PersistentSubscriptionToAllInfo>> getInfoToAll(String groupName,
 GetPersistentSubscriptionInfoOptions options)

Gets a specific persistent subscription info to the $all stream.

Parameters:

groupName - group's name.

options - get persistent subscription info request's options.

See Also:

• PersistentSubscriptionToAllInfo

getInfoToAll

public CompletableFuture<Optional<PersistentSubscriptionToAllInfo>> getInfoToAll(String groupName)

Gets a specific persistent subscription info to the $all stream.

Parameters:

groupName - group's name.

See Also:

• PersistentSubscriptionToAllInfo

replayParkedMessagesToStream

public CompletableFuture replayParkedMessagesToStream(String stream,
 String groupName,
 ReplayParkedMessagesOptions options)

Replays a persistent subscription to a stream parked events.

Parameters:

stream - stream's name.

groupName - group's name.

options - replay parked messages to stream request's options.

replayParkedMessagesToStream

public CompletableFuture replayParkedMessagesToStream(String stream,
 String groupName)

Replays a persistent subscription to a stream parked events.

Parameters:

stream - stream's name.

groupName - group's name.

replayParkedMessagesToAll

public CompletableFuture replayParkedMessagesToAll(String groupName,
 ReplayParkedMessagesOptions options)

Replays a persistent subscription to the $all stream parked events.

Parameters:

groupName - group's name.

options - replay parked messages to stream request's options.

replayParkedMessagesToAll

public CompletableFuture replayParkedMessagesToAll(String groupName)
                                            throws ExecutionException,
InterruptedException

Replays a persistent subscription to the $all stream parked events.

Parameters:

groupName - group's name.

Throws:

ExecutionException

InterruptedException

restartSubsystem

public CompletableFuture restartSubsystem()

Restarts the server persistent subscription subsystem.

restartSubsystem

public CompletableFuture restartSubsystem(RestartPersistentSubscriptionSubsystemOptions options)

Restarts the server persistent subscription subsystem.

Parameters:

options - restart persistent subscription subsystem request's options.

shutdown

public CompletableFuture<Void> shutdown()

Closes a connection and cleans all its allocated resources.

isShutdown

public boolean isShutdown()

Checks if this client instance has been shutdown. After shutdown a client instance can no longer process new operations and a new client instance has to be created.

Returns:

true if client instance has been shutdown.