org.axonframework.axonserver.connector.event

Class AxonServerEventStoreClient

java.lang.Object

org.axonframework.axonserver.connector.event.AxonServerEventStoreClient

public class AxonServerEventStoreClient
extends Object

Generic client for EventStore through AxonServer. Does not require any Axon Framework specific classes.

Since:

4.0

Author:

Marc Gathier

Constructor Summary

Constructors

Constructor and Description
AxonServerEventStoreClient(AxonServerConfiguration eventStoreConfiguration, AxonServerConnectionManager axonServerConnectionManager) Initialize the Event Store Client using given eventStoreConfiguration and given platformConnectionManager.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Confirmation>	appendSnapshot(Event snapshot) Deprecated. in favor of appendSnapshot(String, Event), as the context should always be specified when dealing with an Event Store
CompletableFuture<Confirmation>	appendSnapshot(String context, Event snapshot) Add a snapshot event to the Event Store.
AppendEventTransaction	createAppendEventConnection() Deprecated. in favor of createAppendEventConnection(String), as the context should always be specified when dealing with an Event Store
AppendEventTransaction	createAppendEventConnection(String context) Create a transaction to append events with.
CompletableFuture<TrackingToken>	getFirstToken() Deprecated. in favor of getFirstToken(String), as the context should always be specified when dealing with an Event Store
CompletableFuture<TrackingToken>	getFirstToken(String context) Asynchronously returns the first TrackingToken available in Event Store.
CompletableFuture<TrackingToken>	getLastToken() Deprecated. in favor of getLastToken(String), as the context should always be specified when dealing with an Event Store
CompletableFuture<TrackingToken>	getLastToken(String context) Asynchronously returns the last TrackingToken committed in Event Store.
CompletableFuture<TrackingToken>	getTokenAt(Instant instant) Deprecated. in favor of getTokenAt(String, Instant), as the context should always be specified when dealing with an Event Store
CompletableFuture<TrackingToken>	getTokenAt(String context, Instant instant) Asynchronously returns a TrackingToken at the given instant from the Event Store.
CompletableFuture<ReadHighestSequenceNrResponse>	lastSequenceNumberFor(String aggregateIdentifier) Deprecated. in favor of lastSequenceNumberFor(String, String), as the context should always be specified when dealing with an Event Store
CompletableFuture<ReadHighestSequenceNrResponse>	lastSequenceNumberFor(String context, String aggregateIdentifier) Asynchronously retrieve the last sequence number used for the aggregate referenced through the given aggregateIdentifier.
Stream<Event>	listAggregateEvents(GetAggregateEventsRequest request) Deprecated. in favor of listAggregateEvents(String, GetAggregateEventsRequest), as the context should always be specified when dealing with an Event Store
Stream<Event>	listAggregateEvents(String context, GetAggregateEventsRequest request) Retrieves the events for an aggregate described in given request.
Stream<Event>	listAggregateSnapshots(GetAggregateSnapshotsRequest request) Deprecated. in favor of listAggregateSnapshots(String, GetAggregateSnapshotsRequest), as the context should always be specified when dealing with an Event Store
Stream<Event>	listAggregateSnapshots(String context, GetAggregateSnapshotsRequest request) Retrieve a stream of all the snapshot events utilizing the given GetAggregateSnapshotsRequest
io.grpc.stub.StreamObserver<GetEventsRequest>	listEvents(io.grpc.stub.StreamObserver<EventWithToken> responseStreamObserver) Deprecated. in favor of listEvents(String, StreamObserver), as the context should always be specified when dealing with an Event Store
io.grpc.stub.StreamObserver<GetEventsRequest>	listEvents(String context, io.grpc.stub.StreamObserver<EventWithToken> responseStreamObserver) Provide a list of events by using a StreamObserver for type GetEventsRequest.
io.grpc.stub.StreamObserver<QueryEventsRequest>	query(io.grpc.stub.StreamObserver<QueryEventsResponse> responseStreamObserver) Deprecated. in favor of query(String, StreamObserver), as the context should always be specified when dealing with an Event Store
io.grpc.stub.StreamObserver<QueryEventsRequest>	query(String context, io.grpc.stub.StreamObserver<QueryEventsResponse> responseStreamObserver) Query the Event Store using the given responseStreamObserver to put results on and the returned StreamObserver of type QueryEventsRequest to populate with the query request.
void	shutdown() Deprecated. no-op method. To close connections, call AxonServerConnectionManager.shutdown() instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

AxonServerEventStoreClient

public AxonServerEventStoreClient(AxonServerConfiguration eventStoreConfiguration,
                                  AxonServerConnectionManager axonServerConnectionManager)

Initialize the Event Store Client using given eventStoreConfiguration and given platformConnectionManager.

Parameters:

eventStoreConfiguration - The configuration describing the bounded context that this application operates in

axonServerConnectionManager - manager for connections to AxonServer platform

Method Detail

shutdown

@Deprecated
public void shutdown()

Deprecated. no-op method. To close connections, call AxonServerConnectionManager.shutdown() instead.

Shutdown the connection of this AxonServerEventStoreClient.

listAggregateEvents

@Deprecated
public Stream<Event> listAggregateEvents(GetAggregateEventsRequest request)

Deprecated. in favor of listAggregateEvents(String, GetAggregateEventsRequest), as the context should always be specified when dealing with an Event Store

Retrieves the events for an aggregate described in given request.

Parameters:

request - the request describing the aggregate to retrieve messages for

Returns:

a Stream providing access to Events published by the aggregate described in the request

listAggregateEvents

public Stream<Event> listAggregateEvents(String context,
                                         GetAggregateEventsRequest request)

Retrieves the events for an aggregate described in given request.

Parameters:

context - defines the (Bounded) Context within which a list of events for a given Aggregate should be retrieved

request - the request describing the aggregate to retrieve messages for

Returns:

a Stream providing access to Events published by the aggregate described in the request

listEvents

@Deprecated
public io.grpc.stub.StreamObserver<GetEventsRequest> listEvents(io.grpc.stub.StreamObserver<EventWithToken> responseStreamObserver)

Deprecated. in favor of listEvents(String, StreamObserver), as the context should always be specified when dealing with an Event Store

Provide a list of events by using a StreamObserver for type GetEventsRequest.

Parameters:

responseStreamObserver - a StreamObserver for messages from the server

Returns:

the StreamObserver to send request messages to server with

listEvents

public io.grpc.stub.StreamObserver<GetEventsRequest> listEvents(String context,
                                                                io.grpc.stub.StreamObserver<EventWithToken> responseStreamObserver)

Provide a list of events by using a StreamObserver for type GetEventsRequest.

Parameters:

context - defines the (Bounded) Context within which a list of events should be retrieved

responseStreamObserver - a StreamObserver for messages from the server

Returns:

the StreamObserver to send request messages to server with

appendSnapshot

@Deprecated
public CompletableFuture<Confirmation> appendSnapshot(Event snapshot)

Deprecated. in favor of appendSnapshot(String, Event), as the context should always be specified when dealing with an Event Store

Add a snapshot event to the Event Store.

Parameters:

snapshot - the snapshot-event to store

Returns:

a CompletableFuture containing the Confirmation if the operation succeeded

appendSnapshot

public CompletableFuture<Confirmation> appendSnapshot(String context,
                                                      Event snapshot)

Add a snapshot event to the Event Store.

Parameters:

context - defines the (Bounded) Context within which the snapshot-event should be added

snapshot - the snapshot-event to store

Returns:

a CompletableFuture containing the Confirmation if the operation succeeded

getLastToken

@Deprecated
public CompletableFuture<TrackingToken> getLastToken()

Deprecated. in favor of getLastToken(String), as the context should always be specified when dealing with an Event Store

Asynchronously returns the last TrackingToken committed in Event Store.

Returns:

the last TrackingToken committed in Event Store asynchronously

getLastToken

public CompletableFuture<TrackingToken> getLastToken(String context)

Asynchronously returns the last TrackingToken committed in Event Store.

Parameters:

context - defines the (Bounded) Context from which the last committed TrackingToken should be retrieved

Returns:

the last TrackingToken committed in Event Store asynchronously

getFirstToken

@Deprecated
public CompletableFuture<TrackingToken> getFirstToken()

Deprecated. in favor of getFirstToken(String), as the context should always be specified when dealing with an Event Store

Asynchronously returns the first TrackingToken available in Event Store.

Returns:

the first TrackingToken available in Event Store asynchronously

getFirstToken

public CompletableFuture<TrackingToken> getFirstToken(String context)

Asynchronously returns the first TrackingToken available in Event Store.

Parameters:

context - defines the (Bounded) Context from which the first available TrackingToken should be retrieved

Returns:

the first TrackingToken available in Event Store asynchronously

getTokenAt

@Deprecated
public CompletableFuture<TrackingToken> getTokenAt(Instant instant)

Deprecated. in favor of getTokenAt(String, Instant), as the context should always be specified when dealing with an Event Store

Asynchronously returns a TrackingToken at the given instant from the Event Store.

Parameters:

instant - the moment in time the returned TrackingToken should correspond to

Returns:

a TrackingToken at the given instant from the Event Store asynchronously

getTokenAt

public CompletableFuture<TrackingToken> getTokenAt(String context,
                                                   Instant instant)

Asynchronously returns a TrackingToken at the given instant from the Event Store.

Parameters:

context - defines the (Bounded) Context from which the TrackingToken should be retrieved

instant - the moment in time the returned TrackingToken should correspond to

Returns:

a TrackingToken at the given instant from the Event Store asynchronously

createAppendEventConnection

@Deprecated
public AppendEventTransaction createAppendEventConnection()

Deprecated. in favor of createAppendEventConnection(String), as the context should always be specified when dealing with an Event Store

Create a transaction to append events with.

Returns:

a transaction to append events with.

createAppendEventConnection

public AppendEventTransaction createAppendEventConnection(String context)

Create a transaction to append events with.

Parameters:

context - defines the (Bounded) Context within which the transaction should append new events

Returns:

a transaction to append events with.

query

@Deprecated
public io.grpc.stub.StreamObserver<QueryEventsRequest> query(io.grpc.stub.StreamObserver<QueryEventsResponse> responseStreamObserver)

Deprecated. in favor of query(String, StreamObserver), as the context should always be specified when dealing with an Event Store

Query the Event Store using the given responseStreamObserver to put results on and the returned StreamObserver of type QueryEventsRequest to populate with the query request.

Parameters:

responseStreamObserver - used to stream the query responses on

Returns:

a stream of query request used to query the Event Store

query

public io.grpc.stub.StreamObserver<QueryEventsRequest> query(String context,
                                                             io.grpc.stub.StreamObserver<QueryEventsResponse> responseStreamObserver)

Query the Event Store using the given responseStreamObserver to put results on and the returned StreamObserver of type QueryEventsRequest to populate with the query request.

Parameters:

context - defines the (Bounded) Context within which the query on the Event Store should be performed

responseStreamObserver - used to stream the query responses on

Returns:

a stream of query request used to query the Event Store

lastSequenceNumberFor

@Deprecated
public CompletableFuture<ReadHighestSequenceNrResponse> lastSequenceNumberFor(String aggregateIdentifier)

Deprecated. in favor of lastSequenceNumberFor(String, String), as the context should always be specified when dealing with an Event Store

Asynchronously retrieve the last sequence number used for the aggregate referenced through the given aggregateIdentifier.

Parameters:

aggregateIdentifier - specifies the aggregate for which the last sequence number should be returned

Returns:

the last sequence number stored for the aggregate referenced through the given aggregateIdentifier

lastSequenceNumberFor

public CompletableFuture<ReadHighestSequenceNrResponse> lastSequenceNumberFor(String context,
                                                                              String aggregateIdentifier)

Asynchronously retrieve the last sequence number used for the aggregate referenced through the given aggregateIdentifier.

Parameters:

context - defines the (Bounded) Context where the aggregate resides in, for which the last sequence number should be returned

aggregateIdentifier - specifies the aggregate for which the last sequence number should be returned

Returns:

the last sequence number stored for the aggregate referenced through the given aggregateIdentifier

listAggregateSnapshots

@Deprecated
public Stream<Event> listAggregateSnapshots(GetAggregateSnapshotsRequest request)

Deprecated. in favor of listAggregateSnapshots(String, GetAggregateSnapshotsRequest), as the context should always be specified when dealing with an Event Store

Retrieve a stream of all the snapshot events utilizing the given GetAggregateSnapshotsRequest

Parameters:

request - the object describing the exact snapshot event stream request

Returns:

a stream of snapshot events corresponding to the given request

listAggregateSnapshots

public Stream<Event> listAggregateSnapshots(String context,
                                            GetAggregateSnapshotsRequest request)

Retrieve a stream of all the snapshot events utilizing the given GetAggregateSnapshotsRequest

Parameters:

context - defines the (Bounded) Context where the aggregate resides in, for which the stream of snapshot events should be retrieved

request - the object describing the exact snapshot event stream request

Returns:

a stream of snapshot events corresponding to the given request