Package org.axonframework.axonserver.connector.query.subscription

Class AxonServerSubscriptionQueryResult<I,U>

java.lang.Object

org.axonframework.axonserver.connector.query.subscription.AxonServerSubscriptionQueryResult<I,U>

All Implemented Interfaces:

AutoCloseable, Registration, SubscriptionQueryResult<QueryResponseMessage<I>,SubscriptionQueryUpdateMessage<U>>

public class AxonServerSubscriptionQueryResult<I,U>
extends Object
implements SubscriptionQueryResult<QueryResponseMessage<I>,SubscriptionQueryUpdateMessage<U>>

A SubscriptionQueryResult that emits initial response and update when subscription query response message is received.

Since:

4.0

Author:

Sara Pellegrini, Stefan Dragisic, Steven van Beelen, Allard Buijze

Constructor Summary

Constructors

Constructor	Description
AxonServerSubscriptionQueryResult(io.axoniq.axonserver.connector.query.SubscriptionQueryResult result, SubscriptionMessageSerializer subscriptionSerializer)	Deprecated. Deprecated in favor of constructor with a SpanFactory.
AxonServerSubscriptionQueryResult(io.axoniq.axonserver.connector.query.SubscriptionQueryResult result, SpanFactory spanFactory, SubscriptionMessageSerializer subscriptionSerializer)	Deprecated. Deprecated in favor of constructor with a QueryBusSpanFactory.
AxonServerSubscriptionQueryResult(SubscriptionQueryMessage<?,?,?> queryMessage, io.axoniq.axonserver.connector.query.SubscriptionQueryResult result, SubscriptionMessageSerializer subscriptionSerializer, QueryBusSpanFactory spanFactory, Span parentSpan)	Instantiate a AxonServerSubscriptionQueryResult which will emit its initial response and the updates of the subscription query.

Method Summary

Modifier and Type	Method	Description
boolean	cancel()	Cancels this Registration.
reactor.core.publisher.Mono<QueryResponseMessage<I>>	initialResult()	Subscribing to this mono will trigger invocation of query handler.
reactor.core.publisher.Flux<SubscriptionQueryUpdateMessage<U>>	updates()	When there is an update to the subscription query, it will be emitted to this flux.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.common.Registration

close

Methods inherited from interface org.axonframework.queryhandling.SubscriptionQueryResult

handle, handle

Constructor Details

AxonServerSubscriptionQueryResult

@Deprecated
public AxonServerSubscriptionQueryResult(io.axoniq.axonserver.connector.query.SubscriptionQueryResult result,
 SubscriptionMessageSerializer subscriptionSerializer)

Deprecated.

Deprecated in favor of constructor with a SpanFactory. This constructor defaults to a NoOpSpanFactory.

Instantiate a AxonServerSubscriptionQueryResult which will emit its initial response and the updates of the subscription query.

AxonServerSubscriptionQueryResult

@Deprecated
public AxonServerSubscriptionQueryResult(io.axoniq.axonserver.connector.query.SubscriptionQueryResult result,
 SpanFactory spanFactory,
 SubscriptionMessageSerializer subscriptionSerializer)

Deprecated.

Deprecated in favor of constructor with a QueryBusSpanFactory. This constructor defaults to a DefaultQueryBusSpanFactory with the provided SpanFactory.

Instantiate a AxonServerSubscriptionQueryResult which will emit its initial response and the updates of the subscription query.

AxonServerSubscriptionQueryResult

public AxonServerSubscriptionQueryResult(SubscriptionQueryMessage<?,?,?> queryMessage,
 io.axoniq.axonserver.connector.query.SubscriptionQueryResult result,
 SubscriptionMessageSerializer subscriptionSerializer,
 QueryBusSpanFactory spanFactory,
 Span parentSpan)

Instantiate a AxonServerSubscriptionQueryResult which will emit its initial response and the updates of the subscription query.

Method Details

initialResult

public reactor.core.publisher.Mono<QueryResponseMessage<I>> initialResult()

Description copied from interface: SubscriptionQueryResult

Subscribing to this mono will trigger invocation of query handler. The return value of that query handler will be passed to the mono, once it's ready.

Specified by:

initialResult in interface SubscriptionQueryResult<I,U>

Returns:

the mono representing the initial result

updates

public reactor.core.publisher.Flux<SubscriptionQueryUpdateMessage<U>> updates()

Description copied from interface: SubscriptionQueryResult

When there is an update to the subscription query, it will be emitted to this flux.

Specified by:

updates in interface SubscriptionQueryResult<I,U>

Returns:

the flux representing the incremental updates

cancel

public boolean cancel()

Description copied from interface: Registration

Cancels this Registration. If the Registration was already cancelled, no action is taken.

Specified by:

cancel in interface Registration

Returns:

true if this handler is successfully deregistered, false if this handler was not currently registered.