org.axonframework.queryhandling

Class GenericSubscriptionQueryMessage<Q,I,U>

java.lang.Object

org.axonframework.messaging.MessageDecorator<T>

org.axonframework.queryhandling.GenericQueryMessage<Q,I>

org.axonframework.queryhandling.GenericSubscriptionQueryMessage<Q,I,U>

Type Parameters:

Q - The type of payload expressing the query in this message

I - The type of initial response expected from this query

U - The type of incremental updates expected from this query

All Implemented Interfaces:

Serializable, Message<Q>, QueryMessage<Q,I>, SubscriptionQueryMessage<Q,I,U>

public class GenericSubscriptionQueryMessage<Q,I,U>
extends GenericQueryMessage<Q,I>
implements SubscriptionQueryMessage<Q,I,U>

Generic implementation of the SubscriptionQueryMessage. Unless explicitly provided, it assumes the queryName of the message is the fully qualified class name of the message's payload.

Since:

3.3

Author:

Allard Buijze

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GenericSubscriptionQueryMessage(Message<Q> delegate, String queryName, ResponseType<I> responseType, ResponseType<U> updateResponseType) Initializes the message, using given delegate as the carrier of payload and metadata and given queryName, expected responseType and expected updateResponseType.
GenericSubscriptionQueryMessage(Q payload, ResponseType<I> responseType, ResponseType<U> updateResponseType) Initializes the message with the given payload, expected responseType and expected updateResponseType.
GenericSubscriptionQueryMessage(Q payload, String queryName, ResponseType<I> responseType, ResponseType<U> updateResponseType) Initializes the message with the given payload, queryName, expected responseType and expected updateResponseType.

Method Summary

Modifier and Type	Method and Description
GenericSubscriptionQueryMessage<Q,I,U>	andMetaData(Map<String,?> metaData) Returns a copy of this QueryMessage with its MetaData merged with given metaData.
ResponseType<U>	getUpdateResponseType() Returns the type of incremental responses.
GenericSubscriptionQueryMessage<Q,I,U>	withMetaData(Map<String,?> metaData) Returns a copy of this QueryMessage with the given metaData.

Methods inherited from class org.axonframework.queryhandling.GenericQueryMessage

describeTo, describeType, getQueryName, getResponseType

Methods inherited from class org.axonframework.messaging.MessageDecorator

getDelegate, getIdentifier, getMetaData, getPayload, getPayloadType, serializeMetaData, serializePayload, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.queryhandling.QueryMessage

getQueryName, getResponseType, queryName

Methods inherited from interface org.axonframework.messaging.Message

getIdentifier, getMetaData, getPayload, getPayloadType, serializeMetaData, serializePayload

Constructor Detail

GenericSubscriptionQueryMessage

public GenericSubscriptionQueryMessage(Q payload,
                                       ResponseType<I> responseType,
                                       ResponseType<U> updateResponseType)

Initializes the message with the given payload, expected responseType and expected updateResponseType. The query name is set to the fully qualified class name of the payload.

Parameters:

payload - The payload expressing the query

responseType - The expected response type

updateResponseType - The expected type of incremental updates

GenericSubscriptionQueryMessage

public GenericSubscriptionQueryMessage(Q payload,
                                       String queryName,
                                       ResponseType<I> responseType,
                                       ResponseType<U> updateResponseType)

Initializes the message with the given payload, queryName, expected responseType and expected updateResponseType.

Parameters:

payload - The payload expressing the query

queryName - The name identifying the query to execute

responseType - The expected response type

updateResponseType - The expected type of incremental updates

GenericSubscriptionQueryMessage

public GenericSubscriptionQueryMessage(Message<Q> delegate,
                                       String queryName,
                                       ResponseType<I> responseType,
                                       ResponseType<U> updateResponseType)

Initializes the message, using given delegate as the carrier of payload and metadata and given queryName, expected responseType and expected updateResponseType.

Parameters:

delegate - The message containing the payload and meta data for this message

queryName - The name identifying the query to execute

responseType - The expected response type

updateResponseType - The expected type of incremental updates

Method Detail

getUpdateResponseType

public ResponseType<U> getUpdateResponseType()

Description copied from interface: SubscriptionQueryMessage

Returns the type of incremental responses.

Specified by:

getUpdateResponseType in interface SubscriptionQueryMessage<Q,I,U>

Returns:

the type of incremental responses

withMetaData

public GenericSubscriptionQueryMessage<Q,I,U> withMetaData(@Nonnull
                                                           Map<String,?> metaData)

Description copied from interface: QueryMessage

Returns a copy of this QueryMessage with the given metaData. The payload remains unchanged.

Specified by:

withMetaData in interface Message<Q>

Specified by:

withMetaData in interface QueryMessage<Q,I>

Specified by:

withMetaData in interface SubscriptionQueryMessage<Q,I,U>

Overrides:

withMetaData in class GenericQueryMessage<Q,I>

Parameters:

metaData - The new MetaData for the QueryMessage

Returns:

a copy of this message with the given MetaData

andMetaData

public GenericSubscriptionQueryMessage<Q,I,U> andMetaData(@Nonnull
                                                          Map<String,?> metaData)

Description copied from interface: QueryMessage

Returns a copy of this QueryMessage with its MetaData merged with given metaData. The payload remains unchanged.

Specified by:

andMetaData in interface Message<Q>

Specified by:

andMetaData in interface QueryMessage<Q,I>

Specified by:

andMetaData in interface SubscriptionQueryMessage<Q,I,U>

Overrides:

andMetaData in class GenericQueryMessage<Q,I>

Parameters:

metaData - The MetaData to merge into the QueryMessage

Returns:

a copy of this message with the given additional MetaData