Package org.axonframework.messaging.queryhandling

Class SimpleQueryUpdateEmitter

java.lang.Object

org.axonframework.messaging.queryhandling.SimpleQueryUpdateEmitter

All Implemented Interfaces:

DescribableComponent, QueryUpdateEmitter

public class SimpleQueryUpdateEmitter
extends Object
implements QueryUpdateEmitter

Simple implementation of the QueryUpdateEmitter, delegating operations to a QueryBus for emitting update, completing subscription queries, and completing subscription queries exceptionally.

Uses the ProcessingContext given during construction of the SimpleQueryUpdateEmitter to perform all operations in the expected lifecycle order.

Since:

4.0.0

Author:

Milan Savic, Stefan Dragisic, Steven van Beelen

Constructor Summary

Constructors

Constructor	Description
SimpleQueryUpdateEmitter(QueryBus queryBus, MessageTypeResolver messageTypeResolver, MessageConverter converter, ProcessingContext context)	Construct a SimpleQueryUpdateEmitter with the given messageTypeResolver, queryBus, and context.

Method Summary

Modifier and Type	Method	Description
<Q> void	complete(Class<Q> queryType, Predicate<? super Q> filter)	Completes subscription queries matching the given queryType and filter.
void	complete(QualifiedName queryName, Predicate<Object> filter)	Completes subscription queries matching the given queryName and filter.
<Q> OptionalInt	completeAndCount(Class<Q> queryType, Predicate<? super Q> filter)	Completes subscription queries matching the given queryType and filter, returning the number of subscription queries that were completed.
OptionalInt	completeAndCount(QualifiedName queryName, Predicate<Object> filter)	Completes subscription queries matching the given queryName and filter, returning the number of subscription queries that were completed.
<Q> void	completeExceptionally(Class<Q> queryType, Predicate<? super Q> filter, Throwable cause)	Completes subscription queries with the given cause matching given queryType and filter.
void	completeExceptionally(QualifiedName queryName, Predicate<Object> filter, Throwable cause)	Completes subscription queries with the given cause matching given queryName and filter.
<Q> OptionalInt	completeExceptionallyAndCount(Class<Q> queryType, Predicate<? super Q> filter, Throwable cause)	Completes subscription queries with the given cause matching given queryType and filter, returning the number of subscription queries that were completed exceptionally.
OptionalInt	completeExceptionallyAndCount(QualifiedName queryName, Predicate<Object> filter, Throwable cause)	Completes subscription queries with the given cause matching given queryName and filter, returning the number of subscription queries that were completed exceptionally.
void	describeTo(ComponentDescriptor descriptor)	Describe the properties of this DescribableComponent with the given descriptor.
<Q> void	emit(Class<Q> queryType, Predicate<? super Q> filter, Supplier<Object> updateSupplier)	Emits the outcome of the updateSupplier to subscription queries matching the given queryType and given filter.
void	emit(QualifiedName queryName, Predicate<Object> filter, Supplier<Object> updateSupplier)	Emits the outcome of the updateSupplier to subscription queries matching the given queryName and given filter.
<Q> OptionalInt	emitAndCount(Class<Q> queryType, Predicate<? super Q> filter, Supplier<Object> updateSupplier)	Emits the outcome of the updateSupplier to subscription queries matching the given queryType and given filter, returning the number of subscription queries the update was emitted to.
OptionalInt	emitAndCount(QualifiedName queryName, Predicate<Object> filter, Supplier<Object> updateSupplier)	Emits the outcome of the updateSupplier to subscription queries matching the given queryName and given filter, returning the number of subscription queries the update was emitted to.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.messaging.queryhandling.QueryUpdateEmitter

emit, emit

Constructor Details

SimpleQueryUpdateEmitter

public SimpleQueryUpdateEmitter(QueryBus queryBus,
 MessageTypeResolver messageTypeResolver,
 MessageConverter converter,
 ProcessingContext context)

Construct a SimpleQueryUpdateEmitter with the given messageTypeResolver, queryBus, and context.

The messageTypeResolver is used to construct update messages for QueryUpdateEmitter.emit(Class, Predicate, Object) invocations. Any QueryUpdateEmitter.emit(Class, Predicate, Object) or QueryUpdateEmitter.emit(QualifiedName, Predicate, Object) is delegated to QueryBus.emitUpdate(Predicate, Supplier, ProcessingContext), while their match-count-returning counterparts, emitAndCount(Class, Predicate, Supplier) and emitAndCount(QualifiedName, Predicate, Supplier), are delegated to QueryBus.emitUpdateAndCount(Predicate, Supplier, ProcessingContext). Similarly, complete(Class, Predicate)/complete(QualifiedName, Predicate) and completeExceptionally(Class, Predicate, Throwable)/completeExceptionally(QualifiedName, Predicate, Throwable) are respectively delegated to QueryBus.completeSubscriptions(Predicate, ProcessingContext) and QueryBus.completeSubscriptionsExceptionally(Predicate, Throwable, ProcessingContext), with their match-count-returning counterparts delegated to QueryBus.completeSubscriptionsAndCount(Predicate, ProcessingContext) and QueryBus.completeSubscriptionsExceptionallyAndCount(Predicate, Throwable, ProcessingContext).

Parameters:

queryBus - The QueryBus to delegate the QueryUpdateEmitter.emit(Class, Predicate, Object), complete(Class, Predicate), and completeExceptionally(Class, Predicate, Throwable) invocations to.

messageTypeResolver - The MessageType resolver used to construct update messages for QueryUpdateEmitter.emit(Class, Predicate, Object) invocations

converter - The MessageConverter used to convert the payload whenever a filter is used based on a concrete type. For example, through QueryUpdateEmitter.emit(Class, Predicate, Object).

context - The ProcessingContext within which update are emitted, subscription query are completed, and subscription queries are completed exceptionally in.

Method Details

emit

public <Q> void emit(Class<Q> queryType,
 Predicate<? super Q> filter,
 Supplier<Object> updateSupplier)

Description copied from interface: QueryUpdateEmitter

Emits the outcome of the updateSupplier to subscription queries matching the given queryType and given filter.

The updateSupplier is only invoked whenever there are matching queries.

Specified by:

emit in interface QueryUpdateEmitter

Type Parameters:

Q - the type of the QueryMessage to filter on

Parameters:

queryType - the type of the QueryMessage to filter on

filter - a predicate to filter matching subscription queries based on the Message.payload() converted to the given queryType

updateSupplier - the update supplier to emit for subscription queries matching the given queryType and filter

emitAndCount

public <Q> OptionalInt emitAndCount(Class<Q> queryType,
 Predicate<? super Q> filter,
 Supplier<Object> updateSupplier)

Description copied from interface: QueryUpdateEmitter

Emits the outcome of the updateSupplier to subscription queries matching the given queryType and given filter, returning the number of subscription queries the update was emitted to.

Implementations that cannot determine this number return OptionalInt.empty() instead.

A subscription query to which delivery of the update fails (for example due to a full update buffer) is excluded from this count, even though that failure still terminates the subscription.

Specified by:

emitAndCount in interface QueryUpdateEmitter

Type Parameters:

Q - the type of the QueryMessage to filter on

Parameters:

queryType - the type of the QueryMessage to filter on

filter - a predicate to filter matching subscription queries based on the Message.payload() converted to the given queryType

updateSupplier - the update supplier to emit for subscription queries matching the given queryType and filter

Returns:

the number of subscription queries the update was emitted to as an OptionalInt, which is empty when we couldn't match

emit

public void emit(QualifiedName queryName,
 Predicate<Object> filter,
 Supplier<Object> updateSupplier)

Description copied from interface: QueryUpdateEmitter

Emits the outcome of the updateSupplier to subscription queries matching the given queryName and given filter.

The updateSupplier is only invoked whenever there are matching queries.

Specified by:

emit in interface QueryUpdateEmitter

Parameters:

queryName - the qualified name of the Message.type() to filter on

filter - a predicate to filter matching subscription queries based on the raw Message.payload()

updateSupplier - the update supplier to emit for subscription queries matching the given queryName and filter

emitAndCount

public OptionalInt emitAndCount(QualifiedName queryName,
 Predicate<Object> filter,
 Supplier<Object> updateSupplier)

Description copied from interface: QueryUpdateEmitter

Emits the outcome of the updateSupplier to subscription queries matching the given queryName and given filter, returning the number of subscription queries the update was emitted to.

Implementations that cannot determine this number return OptionalInt.empty() instead.

A subscription query to which delivery of the update fails (for example due to a full update buffer) is excluded from this count, even though that failure still terminates the subscription.

Specified by:

emitAndCount in interface QueryUpdateEmitter

Parameters:

queryName - the qualified name of the Message.type() to filter on

filter - a predicate to filter matching subscription queries based on the raw Message.payload()

updateSupplier - the update supplier to emit for subscription queries matching the given queryName and filter

Returns:

the number of subscription queries the update was emitted to as an OptionalInt, which is empty when we couldn't match

complete

public <Q> void complete(Class<Q> queryType,
 Predicate<? super Q> filter)

Description copied from interface: QueryUpdateEmitter

Completes subscription queries matching the given queryType and filter.

Specified by:

complete in interface QueryUpdateEmitter

Type Parameters:

Q - the type of the QueryMessage to filter on

Parameters:

queryType - the type of the QueryMessage to filter on

filter - a predicate to filter matching subscription queries based on the Message.payload() converted to the given queryType

completeAndCount

public <Q> OptionalInt completeAndCount(Class<Q> queryType,
 Predicate<? super Q> filter)

Description copied from interface: QueryUpdateEmitter

Completes subscription queries matching the given queryType and filter, returning the number of subscription queries that were completed.

Implementations that cannot determine this number return OptionalInt.empty() instead.

A subscription query for which completion fails is excluded from this count.

Specified by:

completeAndCount in interface QueryUpdateEmitter

Type Parameters:

Q - the type of the QueryMessage to filter on.

Parameters:

queryType - the type of the QueryMessage to filter on.

filter - a predicate to filter matching subscription queries based on the Message.payload() converted to the given queryType

Returns:

the number of subscription queries that were completed as an OptionalInt, which is empty when we couldn't match

complete

public void complete(QualifiedName queryName,
 Predicate<Object> filter)

Description copied from interface: QueryUpdateEmitter

Completes subscription queries matching the given queryName and filter.

Specified by:

complete in interface QueryUpdateEmitter

Parameters:

queryName - the qualified name of the Message.type() to filter on

filter - a predicate testing the raw Message.payload() as is

completeAndCount

public OptionalInt completeAndCount(QualifiedName queryName,
 Predicate<Object> filter)

Description copied from interface: QueryUpdateEmitter

Completes subscription queries matching the given queryName and filter, returning the number of subscription queries that were completed.

Implementations that cannot determine this number return OptionalInt.empty() instead.

A subscription query for which completion fails is excluded from this count.

Specified by:

completeAndCount in interface QueryUpdateEmitter

Parameters:

queryName - the qualified name of the Message.type() to filter on

filter - a predicate testing the raw Message.payload() as is

Returns:

the number of subscription queries that were completed as an OptionalInt, which is empty when we couldn't match

completeExceptionally

public <Q> void completeExceptionally(Class<Q> queryType,
 Predicate<? super Q> filter,
 Throwable cause)

Description copied from interface: QueryUpdateEmitter

Completes subscription queries with the given cause matching given queryType and filter.

Specified by:

completeExceptionally in interface QueryUpdateEmitter

Type Parameters:

Q - the type of the QueryMessage to filter on

Parameters:

queryType - the type of the QueryMessage to filter on

filter - a predicate to filter matching subscription queries based on the Message.payload() converted to the given queryType

cause - the cause of an error leading to exceptionally complete subscription queries

completeExceptionallyAndCount

public <Q> OptionalInt completeExceptionallyAndCount(Class<Q> queryType,
 Predicate<? super Q> filter,
 Throwable cause)

Description copied from interface: QueryUpdateEmitter

Completes subscription queries with the given cause matching given queryType and filter, returning the number of subscription queries that were completed exceptionally.

Implementations that cannot determine this number return OptionalInt.empty() instead.

A subscription query for which the exceptional completion fails to be delivered is excluded from this count.

Specified by:

completeExceptionallyAndCount in interface QueryUpdateEmitter

Type Parameters:

Q - the type of the QueryMessage to filter on

Parameters:

queryType - the type of the QueryMessage to filter on

filter - a predicate to filter matching subscription queries based on the Message.payload() converted to the given queryType

cause - the cause of an error leading to exceptionally complete subscription queries

Returns:

the number of subscription queries that were completed exceptionally as an OptionalInt, which is empty when we couldn't match

completeExceptionally

public void completeExceptionally(QualifiedName queryName,
 Predicate<Object> filter,
 Throwable cause)

Description copied from interface: QueryUpdateEmitter

Completes subscription queries with the given cause matching given queryName and filter.

Specified by:

completeExceptionally in interface QueryUpdateEmitter

Parameters:

queryName - the qualified name of the Message.type() to filter on

filter - a predicate to filter matching subscription queries based on the raw Message.payload()

cause - the cause of an error leading to exceptionally complete subscription queries

completeExceptionallyAndCount

public OptionalInt completeExceptionallyAndCount(QualifiedName queryName,
 Predicate<Object> filter,
 Throwable cause)

Description copied from interface: QueryUpdateEmitter

Completes subscription queries with the given cause matching given queryName and filter, returning the number of subscription queries that were completed exceptionally.

Implementations that cannot determine this number return OptionalInt.empty() instead.

A subscription query for which the exceptional completion fails to be delivered is excluded from this count.

Specified by:

completeExceptionallyAndCount in interface QueryUpdateEmitter

Parameters:

queryName - the qualified name of the Message.type() to filter on

filter - a predicate to filter matching subscription queries based on the raw Message.payload()

cause - the cause of an error leading to exceptionally complete subscription queries

Returns:

the number of subscription queries that were completed exceptionally as an OptionalInt, which is empty when we couldn't match

describeTo

public void describeTo(ComponentDescriptor descriptor)

Description copied from interface: DescribableComponent

Describe the properties of this DescribableComponent with the given descriptor.

Components should call the appropriate describeProperty methods on the descriptor to register their properties. The descriptor is responsible for determining how these properties are formatted and structured in the final output.

Best Practices: As a general rule, all relevant fields of a DescribableComponent implementation should be described in this method. However, developers have discretion to include only the fields that make sense in the context. Not every field may be meaningful for description purposes, especially internal implementation details. Furthermore, components might want to expose different information based on their current state. The final decision on what properties to include lies with the person implementing the describeTo method, who should focus on providing information that is useful for understanding the component's configuration and state.

Example implementation:

 public void describeTo(ComponentDescriptor descriptor) {
     descriptor.describeProperty("name", this.name);
     descriptor.describeProperty("enabled", this.enabled);
     descriptor.describeProperty("configuration", this.configuration); // A nested component
     descriptor.describeProperty("handlers", this.eventHandlers);      // A collection
 }
 

Specified by:

describeTo in interface DescribableComponent

Parameters:

descriptor - The component descriptor to describe this DescribableComponentn its properties in.