Package org.axonframework.queryhandling

Interface StreamingQueryMessage<Q,R>

Type Parameters:
Q - the type of streaming query payload
R - the type of the result streamed via Publisher
All Superinterfaces:
Message<Q>, QueryMessage<Q,org.reactivestreams.Publisher<R>>, Serializable
All Known Implementing Classes:
GenericStreamingQueryMessage
public interface StreamingQueryMessage<Q,R> extends QueryMessage<Q,org.reactivestreams.Publisher<R>>
A special type of QueryMessage used for initiating streaming queries. It's special since it hard codes the response type to PublisherResponseType.
Since:
4.6.0
Author:
Milan Savic, Stefan Dragisic

  • Method Details

    • getResponseType

      ResponseType<org.reactivestreams.Publisher<R>> getResponseType()
      Description copied from interface: QueryMessage
      The type of response expected by the sender of the query
      Specified by:
      getResponseType in interface QueryMessage<Q,R>
      Returns:
      the type of response expected by the sender of the query

    • withMetaData

      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>
      Parameters:
      metaData - The new MetaData for the QueryMessage
      Returns:
      a copy of this message with the given MetaData

    • andMetaData

      StreamingQueryMessage<Q,R> andMetaData(Map<String,?> additionalMetaData)
      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>
      Parameters:
      additionalMetaData - The MetaData to merge into the QueryMessage
      Returns:
      a copy of this message with the given additional MetaData