java.com.graphql_java_generator.client.RequestExecution Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of graphql-java-client-runtime Show documentation
The newest version!
/**
* 
*/
package com.graphql_java_generator.client;

import java.io.IOException;
import java.util.Map;

import org.slf4j.Marker;
import org.slf4j.MarkerFactory;
import org.springframework.web.reactive.socket.client.WebSocketClient;

import com.graphql_java_generator.client.request.AbstractGraphQLRequest;
import com.graphql_java_generator.exception.GraphQLRequestExecutionException;

/**
 * This class is responsible for actual execution of the request toward the GraphQL erver. It's a generic class,
 * responsible for calling the GraphQL server, and return its response as POJOs.

 * Note: its name ends with Execution to avoid collision with the Executor classes generated by the
 * plugin.
 * 
 * @author etienne-sf
 */
@Deprecated
public interface RequestExecution {

	Marker GRAPHQL_MARKER = MarkerFactory.getMarker("GRAPHQL");
	Marker GRAPHQL_QUERY_MARKER = MarkerFactory.getMarker("GRAPHQL_QUERY");
	Marker GRAPHQL_MUTATION_MARKER = MarkerFactory.getMarker("GRAPHQL_MUTATION");
	Marker GRAPHQL_SUBSCRIPTION_MARKER = MarkerFactory.getMarker("GRAPHQL_SUBSCRIPTION");

	/**
	 * Execution of the given query or mutation GraphQL request, and return its response mapped in the
	 * relevant POJO. This method executes a partial GraphQL query, or a full GraphQL request.
	 * 
	 * @param 
	 *            The class that is generated from the query or the mutation definition in the GraphQL schema
	 * 
	 * @param graphQLRequest
	 *            Defines what response is expected from the server.
	 * @param parameters
	 *            the input parameters for this query. If the query has no parameters, it may be null or an empty list.
	 * @param dataResponseType
	 *            The class generated for the query or the mutation type. The data tag of the GraphQL server response
	 *            will be mapped into an instance of this class.
	 * @return The response mapped to the code, generated from the GraphQl server. Or a wrapper for composite responses.
	 * @throws GraphQLRequestExecutionException
	 *             When an error occurs during the request execution, typically a network error, an error from the
	 *             GraphQL server or if the server response can't be parsed
	 * @throws IOException
	 */
	public  R execute(AbstractGraphQLRequest graphQLRequest,
			Map parameters, Class dataResponseType) throws GraphQLRequestExecutionException;

	/**
	 * Executes the given subscription GraphQL request, and returns the relevant {@link WebSocketClient}. The
	 * given subscriptionCallback will receive the notifications that have been subscribed by this subscription.
	 * Only one Subscription may be executed at a time: it may be a partial Request (always limited to one query), or a
	 * full request that contains only one subscription.

	 * Note: Don't forget to free the server's resources by calling the {@link WebSocketClient#stop()} method of
	 * the returned object.
	 * 
	 * @param 
	 *            The class that is generated from the subscription definition in the GraphQL schema. It contains one
	 *            attribute, for each available subscription. The data tag of the GraphQL server response will be mapped
	 *            into an instance of this class.
	 * @param 
	 *            The type that must be returned by the query or mutation: it's the class that maps to the GraphQL type
	 *            returned by this subscription.
	 * @param graphQLRequest
	 *            Defines what response is expected from the server.
	 * @param parameters
	 *            The input parameters for this subscription. If the query has no parameters, it may be null or an empty
	 *            list.
	 * @param subscriptionCallback
	 *            The object that will be called each time a message is received, or an error on the subscription
	 *            occurs. This object is provided by the application.
	 * @param subscriptionType
	 *            The R class
	 * @param messageType
	 *            The T class
	 * @return The Subscription client. It allows to stop the subscription, by executing its
	 *         {@link SubscriptionClient#unsubscribe()} method. This will stop the incoming notification flow, and will
	 *         free resources on both the client and the server.
	 * @throws GraphQLRequestExecutionException
	 *             When an error occurs during the request execution, typically a network error, an error from the
	 *             GraphQL server or if the server response can't be parsed
	 * @throws IOException
	 */
	public  SubscriptionClient execute(AbstractGraphQLRequest graphQLRequest,
			Map parameters, SubscriptionCallback subscriptionCallback, Class subscriptionType,
			Class messageType) throws GraphQLRequestExecutionException;

}