Package org.axonframework.queryhandling

Class GenericStreamingQueryMessage<Q,R>

java.lang.Object

org.axonframework.messaging.MessageDecorator<Q>

org.axonframework.queryhandling.GenericQueryMessage<Q,org.reactivestreams.Publisher<R>>

org.axonframework.queryhandling.GenericStreamingQueryMessage<Q,R>

Type Parameters:

Q - the type of streaming query payload

R - the type of the result streamed via Flux

All Implemented Interfaces:

Serializable, Message<Q>, QueryMessage<Q,org.reactivestreams.Publisher<R>>, StreamingQueryMessage<Q,R>

public class GenericStreamingQueryMessage<Q,R>
extends GenericQueryMessage<Q,org.reactivestreams.Publisher<R>>
implements StreamingQueryMessage<Q,R>

Generic implementation of the StreamingQueryMessage.

Since:

4.6.0

Author:

Milan Savic, Stefan Dragisic

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
GenericStreamingQueryMessage(Message<Q> delegate, String queryName, Class<R> responseType)	Initializes the message with the given delegate, queryName and expected responseType.
GenericStreamingQueryMessage(Message<Q> delegate, String queryName, ResponseType<org.reactivestreams.Publisher<R>> responseType)	Initialize the Query Message, using given delegate as the carrier of payload and metadata and given queryName and expecting the given responseType.
GenericStreamingQueryMessage(Q payload, Class<R> responseType)	Initializes the message with the given payload and expected responseType.
GenericStreamingQueryMessage(Q payload, String queryName, Class<R> responseType)	Initializes the message with the given payload, queryName and expected responseType.
GenericStreamingQueryMessage(Q payload, String queryName, ResponseType<org.reactivestreams.Publisher<R>> responseType)	Initializes the message with the given payload, queryName and expected responseType.
GenericStreamingQueryMessage(Q payload, ResponseType<org.reactivestreams.Publisher<R>> responseType)	Initializes the message with the given payload and expected responseType.

Method Summary

Modifier and Type	Method	Description
StreamingQueryMessage<Q,R>	andMetaData(Map<String,?> metaData)	Returns a copy of this QueryMessage with its MetaData merged with given metaData.
protected String	describeType()	Describe the type of message, used in MessageDecorator.toString().
StreamingQueryMessage<Q,R>	withMetaData(Map<String,?> metaData)	Returns a copy of this QueryMessage with the given metaData.

Methods inherited from class org.axonframework.queryhandling.GenericQueryMessage

describeTo, 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.messaging.Message

getIdentifier, getMetaData, getPayload, getPayloadType, serializeMetaData, serializePayload

Methods inherited from interface org.axonframework.queryhandling.QueryMessage

getQueryName

Methods inherited from interface org.axonframework.queryhandling.StreamingQueryMessage

getResponseType

Constructor Details

GenericStreamingQueryMessage

public GenericStreamingQueryMessage(Q payload,
 Class<R> responseType)

Initializes the message with the given payload and expected responseType. 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

GenericStreamingQueryMessage

public GenericStreamingQueryMessage(Q payload,
 String queryName,
 Class<R> responseType)

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

Parameters:

payload - The payload expressing the query

queryName - The name identifying the query to execute

responseType - The expected response type

GenericStreamingQueryMessage

public GenericStreamingQueryMessage(Q payload,
 ResponseType<org.reactivestreams.Publisher<R>> responseType)

Initializes the message with the given payload and expected responseType. 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

GenericStreamingQueryMessage

public GenericStreamingQueryMessage(Q payload,
 String queryName,
 ResponseType<org.reactivestreams.Publisher<R>> responseType)

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

Parameters:

payload - The payload expressing the query

queryName - The name identifying the query to execute

responseType - The expected response type

GenericStreamingQueryMessage

public GenericStreamingQueryMessage(Message<Q> delegate,
 String queryName,
 Class<R> responseType)

Initializes the message with the given delegate, queryName and expected responseType.

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

GenericStreamingQueryMessage

public GenericStreamingQueryMessage(Message<Q> delegate,
 String queryName,
 ResponseType<org.reactivestreams.Publisher<R>> responseType)

Initialize the Query Message, using given delegate as the carrier of payload and metadata and given queryName and expecting the given responseType.

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

Method Details

withMetaData

public StreamingQueryMessage<Q,R> withMetaData(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,R>

Specified by:

withMetaData in interface StreamingQueryMessage<Q,R>

Overrides:

withMetaData in class GenericQueryMessage<Q,org.reactivestreams.Publisher<R>>

Parameters:

metaData - The new MetaData for the QueryMessage

Returns:

a copy of this message with the given MetaData

andMetaData

public StreamingQueryMessage<Q,R> andMetaData(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,R>

Specified by:

andMetaData in interface StreamingQueryMessage<Q,R>

Overrides:

andMetaData in class GenericQueryMessage<Q,org.reactivestreams.Publisher<R>>

Parameters:

metaData - The MetaData to merge into the QueryMessage

Returns:

a copy of this message with the given additional MetaData

describeType

protected String describeType()

Description copied from class: MessageDecorator

Describe the type of message, used in MessageDecorator.toString().

Defaults to the simple class name of the actual instance.

Overrides:

describeType in class GenericQueryMessage<Q,org.reactivestreams.Publisher<R>>

Returns:

the type of message