graphql.java.client

Class QueryExecutorImpl

java.lang.Object

graphql.java.client.QueryExecutorImpl

All Implemented Interfaces:

QueryExecutor

public class QueryExecutorImpl
extends Object
implements QueryExecutor

This class is the query executor : a generic class, reponsible for calling the GraphQL server, for query, mutation and subscription.
It has one major parameter: the GraphQL endpoint. See the QueryExecutorImpl(String) for more information.

Author:

EtienneSF

Field Summary

Fields inherited from interface graphql.java.client.QueryExecutor

GRAPHQL_MARKER, GRAPHQL_MUTATION_MARKER, GRAPHQL_QUERY_MARKER, GRAPHQL_SUBSCRIPTION_MARKER

Constructor Summary

Constructors

Constructor and Description
QueryExecutorImpl(String graphqlEndpoint) This constructor expects the URI of the GraphQL server.
QueryExecutorImpl(String graphqlEndpoint, SSLContext sslContext, HostnameVerifier hostnameVerifier) This constructor expects the URI of the GraphQL server.

Method Summary

Modifier and Type	Method and Description
<T> T	execute(String query, Class<T> valueType) Execution of the given simple GraphQL query, and return its response mapped in the relevant POJO.
<T> T	execute(String requestType, ObjectResponse objectResponse, List<InputParameter> parameters, Class<T> valueType) Execution of the given simple GraphQL query, and return its response mapped in the relevant POJO.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryExecutorImpl

public QueryExecutorImpl(String graphqlEndpoint)

This constructor expects the URI of the GraphQL server. This constructor works only for http servers, not for https ones.
For example: http://my.server.com/graphql

Parameters:

graphqlEndpoint - the http URI for the GraphQL endpoint

QueryExecutorImpl

public QueryExecutorImpl(String graphqlEndpoint,
                         SSLContext sslContext,
                         HostnameVerifier hostnameVerifier)

This constructor expects the URI of the GraphQL server. This constructor works only for http servers, not for https ones.
For example: https://my.server.com/graphql

Parameters:

graphqlEndpoint - the https URI for the GraphQL endpoint

sslContext -

hostnameVerifier -

Method Detail

execute

public <T> T execute(String requestType,
                     ObjectResponse objectResponse,
                     List<InputParameter> parameters,
                     Class<T> valueType)
              throws GraphQLExecutionException

Execution of the given simple GraphQL query, and return its response mapped in the relevant POJO. This method execute a single GraphQL query, not a multi-operational request.
The advantage of this method is that you can build all the ObjectResponse for your application in your constructor, or in whatever initialization code you have. Using this allows to be sure at startup that the syntax for all your GraphQL request is valid.

Specified by:

execute in interface QueryExecutor

Parameters:

requestType - One of "query", "mutation" or "subscription"

objectResponse - Defines what response is expected from the server. The ObjectResponse.getFieldAlias() method returns the field of the query, that is: the query name.

parameters - the input parameters for this query. If the query has no parameters, it may be null or an empty list.

Returns:

The response mapped to the code, generated from the GraphQl server. Or a wrapper for composite responses.

Throws:

GraphQLExecutionException - 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

execute

public <T> T execute(String query,
                     Class<T> valueType)
              throws IOException,
                     GraphQLExecutionException

Execution of the given simple GraphQL query, and return its response mapped in the relevant POJO. This method execute a single GraphQL query, not a multi-operational request.
With this method, there is no check that the query is valid, before calling the server. And it's up to the caller of this method, to properly insert (that is: in compliance with GraphQL grammar) the parameters for the query, and for any field that would have parameters.
Note: you can call this query directly. But the easiest way is to all the generated method from the generated QueryType relevant for you schema. This method will take care of the parameters for the query itself, in pure java.

Specified by:

execute in interface QueryExecutor

Type Parameters:

T - The GraphQL type to map the response into

Parameters:

query - A string which contains the query, in the GraphQL language. For instance: "{ hero { name } }"

valueType - The GraphQL type to map the response into

Returns:

The response mapped to the code, generated from the GraphQl server. Or a wrapper for composite responses.

Throws:

IOException

GraphQLExecutionException