QueryGatewayExtensions.kt

/*
 * Copyright (c) 2010-2021. Axon Framework
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.axonframework.extensions.kotlin

import org.axonframework.messaging.responsetypes.ResponseTypes
import org.axonframework.queryhandling.QueryGateway
import org.axonframework.queryhandling.SubscriptionQueryResult
import java.util.*
import java.util.concurrent.CompletableFuture
import java.util.concurrent.TimeUnit
import java.util.stream.Stream

/**
 * Query Gateway extensions.
 *
 * @author Henrique Sena
 */

/**
 * Reified version of [QueryGateway.query]
 * which expects a collection as a response using [org.axonframework.messaging.responsetypes.MultipleInstancesResponseType]
 * @param query Query to send
 * @param Q the type of payload of the query
 * @param R the type of result of the query
 * @return [CompletableFuture] wrapping the result of the query
 * @see QueryGateway.query
 * @see ResponseTypes
 * @since 0.1.0
 */
inline fun <reified R, reified Q> QueryGateway.queryMany(query: Q): CompletableFuture<List<R>> {
    return this.query(query, ResponseTypes.multipleInstancesOf(R::class.java))
}

/**
 * Reified version of [QueryGateway.query] with explicit query name
 * which expects a collection as a response using [org.axonframework.messaging.responsetypes.MultipleInstancesResponseType]
 * @param queryName Name of the query
 * @param query Query to send
 * @param Q the type of payload of the query
 * @param R the type of result of the query
 * @return [CompletableFuture] wrapping the result of the query
 * @see QueryGateway.query
 * @see ResponseTypes
 * @since 0.1.0
 */
inline fun <reified R, reified Q> QueryGateway.queryMany(queryName: String, query: Q): CompletableFuture<List<R>> {
    return this.query(queryName, query, ResponseTypes.multipleInstancesOf(R::class.java))
}

/**
 * Reified version of [QueryGateway.query]
 * which expects a single object as a response using [org.axonframework.messaging.responsetypes.InstanceResponseType]
 * @param query Query to send
 * @param Q the type of payload of the query
 * @param R the type of result of the query
 * @return [CompletableFuture] wrapping the result of the query
 * @see QueryGateway.query
 * @see ResponseTypes
 * @since 0.1.0
 */
inline fun <reified R, reified Q> QueryGateway.query(query: Q): CompletableFuture<R> {
    return this.query(query, ResponseTypes.instanceOf(R::class.java))
}

/**
 * Reified version of [QueryGateway.query] with explicit query name
 * which expects a single object as a response using [org.axonframework.messaging.responsetypes.InstanceResponseType]
 * @param queryName Name of the query
 * @param query Query to send
 * @param Q the type of payload of the query
 * @param R the type of result of the query
 * @return [CompletableFuture] wrapping the result of the query
 * @see QueryGateway.query
 * @see ResponseTypes
 * @since 0.1.0
 */
inline fun <reified R, reified Q> QueryGateway.query(queryName: String, query: Q): CompletableFuture<R> {
    return this.query(queryName, query, ResponseTypes.instanceOf(R::class.java))
}

/**
 * Reified version of [QueryGateway.query]
 * which expects an Optional object as a response using [org.axonframework.messaging.responsetypes.OptionalResponseType]
 * @param query Query to send
 * @param Q the type of payload of the query
 * @param R the type of result of the query
 * @return [CompletableFuture] wrapping the result of the query
 * @see QueryGateway.query
 * @see ResponseTypes
 * @since 0.1.0
 */
inline fun <reified R, reified Q> QueryGateway.queryOptional(query: Q): CompletableFuture<Optional<R>> {
    return this.query(query, ResponseTypes.optionalInstanceOf(R::class.java))
}

/**
 * Reified version of [QueryGateway.query] with explicit query name
 * which expects an Optional object as a response using [org.axonframework.messaging.responsetypes.OptionalResponseType]
 * @param queryName Name of the query
 * @param query Query to send
 * @param Q the type of payload of the query
 * @param R the type of result of the query
 * @return [CompletableFuture] wrapping the result of the query
 * @see QueryGateway.query
 * @see ResponseTypes
 * @since 0.1.0
 */
inline fun <reified R, reified Q> QueryGateway.queryOptional(queryName: String, query: Q): CompletableFuture<Optional<R>> {
    return this.query(queryName, query, ResponseTypes.optionalInstanceOf(R::class.java))
}

/**
 * Reified version of [QueryGateway.scatterGather]
 * which expects an Stream object as a response using [org.axonframework.messaging.responsetypes.InstanceResponseType]
 * @param query Query to send
 * @param timeout a timeout for the query
 * @param timeUnit the selected TimeUnit for the given timeout
 * @param [Q] the type of payload of the query
 * @param [R] the response class contained in the given responseType
 * @return [Stream] a stream of results
 * @see QueryGateway.scatterGather
 * @see ResponseTypes
 * @since 0.2.0
 */
inline fun <reified R, reified Q> QueryGateway.scatterGather(query: Q, timeout: Long,
                                                             timeUnit: TimeUnit): Stream<R> {
    return this.scatterGather(query, ResponseTypes.instanceOf(R::class.java), timeout, timeUnit)
}

/**
 * Reified version of [QueryGateway.scatterGather] with explicit query name
 * which expects an Stream object as a response using [org.axonframework.messaging.responsetypes.InstanceResponseType]
 * @param query Query to send
 * @param queryName Name of the query
 * @param timeout a timeout for the query
 * @param timeUnit the selected TimeUnit for the given timeout
 * @param [Q] the type of payload of the query
 * @param [R] the response class contained in the given responseType
 * @return [Stream] a stream of results
 * @see QueryGateway.scatterGather
 * @see ResponseTypes
 * @since 0.2.0
 */
inline fun <reified R, reified Q> QueryGateway.scatterGather(queryName: String, query: Q, timeout: Long,
                                                             timeUnit: TimeUnit): Stream<R> {
    return this.scatterGather(queryName, query, ResponseTypes.instanceOf(R::class.java), timeout, timeUnit)
}

/**
 * Reified version of [QueryGateway.scatterGather]
 * which expects a collection as a response using [org.axonframework.messaging.responsetypes.MultipleInstancesResponseType]
 * @param query Query to send
 * @param timeout a timeout for the query
 * @param timeUnit the selected TimeUnit for the given timeout
 * @param [Q] the type of payload of the query
 * @param [R] the response class contained in the given responseType
 * @return [Stream] a stream of results
 * @see QueryGateway.scatterGather
 * @see ResponseTypes
 * @since 0.2.0
 */
inline fun <reified R, reified Q> QueryGateway.scatterGatherMany(query: Q, timeout: Long,
                                                                 timeUnit: TimeUnit): Stream<List<R>> {
    return this.scatterGather(query, ResponseTypes.multipleInstancesOf(R::class.java), timeout, timeUnit)
}

/**
 * Reified version of [QueryGateway.scatterGather] with explicit query name
 * which expects a collection as a response using [org.axonframework.messaging.responsetypes.MultipleInstancesResponseType]
 * @param query Query to send
 * @param queryName Name of the query
 * @param timeout a timeout for the query
 * @param timeUnit the selected TimeUnit for the given timeout
 * @param [Q] the type of payload of the query
 * @param [R] the response class contained in the given responseType
 * @return [Stream] a stream of results
 * @see QueryGateway.scatterGather
 * @see ResponseTypes
 * @since 0.2.0
 */
inline fun <reified R, reified Q> QueryGateway.scatterGatherMany(queryName: String, query: Q, timeout: Long,
                                                                 timeUnit: TimeUnit): Stream<List<R>> {
    return this.scatterGather(queryName, query, ResponseTypes.multipleInstancesOf(R::class.java), timeout, timeUnit)
}

/**
 * Reified version of [QueryGateway.scatterGather]
 * which expects a collection as a response using [org.axonframework.messaging.responsetypes.OptionalResponseType]
 * @param query Query to send
 * @param timeout a timeout for the query
 * @param timeUnit the selected TimeUnit for the given timeout
 * @param [Q] the type of payload of the query
 * @param [R] the response class contained in the given responseType
 * @return [Stream] a stream of results
 * @see QueryGateway.scatterGather
 * @see ResponseTypes
 * @since 0.2.0
 */
inline fun <reified R, reified Q> QueryGateway.scatterGatherOptional(query: Q, timeout: Long,
                                                                     timeUnit: TimeUnit): Stream<Optional<R>> {
    return this.scatterGather(query, ResponseTypes.optionalInstanceOf(R::class.java), timeout, timeUnit)
}

/**
 * Reified version of [QueryGateway.scatterGather] with explicit query name
 * which expects a collection as a response using [org.axonframework.messaging.responsetypes.OptionalResponseType]
 * @param query Query to send
 * @param queryName Name of the query
 * @param timeout a timeout for the query
 * @param timeUnit the selected TimeUnit for the given timeout
 * @param [Q] the type of payload of the query
 * @param [R] the response class contained in the given responseType
 * @return [Stream] a stream of results
 * @see QueryGateway.scatterGather
 * @see ResponseTypes
 * @since 0.2.0
 */
inline fun <reified R, reified Q> QueryGateway.scatterGatherOptional(queryName: String, query: Q, timeout: Long,
                                                                     timeUnit: TimeUnit): Stream<Optional<R>> {
    return this.scatterGather(queryName, query, ResponseTypes.optionalInstanceOf(R::class.java), timeout, timeUnit)
}

/**
 * Reified version of [QueryGateway.subscriptionQuery]
 * which expects a single object as a response using [org.axonframework.messaging.responsetypes.InstanceResponseType]
 * @param query Query to send
 * @param Q the type of payload of the query
 * @param I the type of initial response
 * @param U the type of update response
 * @return [SubscriptionQueryResult] wrapping the result of the query
 * @see QueryGateway.subscriptionQuery
 * @see ResponseTypes
 * @since 0.3.0
 */
inline fun <reified Q, reified I, reified U> QueryGateway.subscriptionQuery(query: Q): SubscriptionQueryResult<I, U> =
        this.subscriptionQuery(query, ResponseTypes.instanceOf(I::class.java), ResponseTypes.instanceOf(U::class.java))

/**
 * Reified version of [QueryGateway.subscriptionQuery]
 * which expects a single object as a response using [org.axonframework.messaging.responsetypes.InstanceResponseType]
 * @param queryName Name of the query
 * @param query Query to send
 * @param Q the type of payload of the query
 * @param I the type of initial response
 * @param U the type of update response
 * @return [SubscriptionQueryResult] wrapping the result of the query
 * @see QueryGateway.subscriptionQuery
 * @see ResponseTypes
 * @since 0.3.0
 */
inline fun <reified Q, reified I, reified U> QueryGateway.subscriptionQuery(queryName: String, query: Q): SubscriptionQueryResult<I, U> =
        this.subscriptionQuery(queryName, query, ResponseTypes.instanceOf(I::class.java), ResponseTypes.instanceOf(U::class.java))