com.generated.graphql

Class Query

java.lang.Object

com.generated.graphql.Query

public class Query
extends Object

Author:

generated by graphql-java-generator

See Also:

https://github.com/graphql-java-generator/graphql-java-generator

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Builder	getHelloResponseBuilder() Get the ObjectResponse.Builder for the String, as expected by the hello query.
String	hello(ObjectResponse objectResponse, String name) This method is expected by the graphql-java framework.
String	hello(String queryResponseDef, String name) This method is expected by the graphql-java framework.

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

public Query(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

Query

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

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

SSLContext and HostnameVerifier are regular Java stuff. You'll find lots of documentation on the web. The StarWars sample is based on the http://www.thinkcode.se/blog/2019/01/27/a-jersey-client-supporting-https blog. But this sample implements a noHostVerification, which of course, is the simplest but the safest way to go.

Parameters:

graphqlEndpoint - the https URI for the GraphQL endpoint

sslContext -

hostnameVerifier -

Method Detail

hello

public String hello(String queryResponseDef,
                    String name)
             throws GraphQLExecutionException,
                    GraphQLRequestPreparationException

This method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writting the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of the String GraphQL type. It can be something like "{ id name }", if you want these fields of this type. Please take a look at the StarWars, Forum and other samples for more complex queries.

Parameters:

queryResponseDef - The response definition of the query, in the native GraphQL format (see here above)

episode - Parameter 1 of this query

Throws:

IOException

GraphQLRequestPreparationException - When an error occurs during the request preparation, typically when building the ObjectResponse

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

hello

public String hello(ObjectResponse objectResponse,
                    String name)
             throws GraphQLExecutionException

This method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).

Parameters:

objectResponse - The definition of the response format, that describes what the GraphQL server is expected to return

episode -

Throws:

IOException

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

getHelloResponseBuilder

public Builder getHelloResponseBuilder()
                                throws GraphQLRequestPreparationException

Get the ObjectResponse.Builder for the String, as expected by the hello query.

Returns:

Throws:

GraphQLRequestPreparationException