manifold.graphql.rt.api.request

Class Executor<T>

java.lang.Object

manifold.graphql.rt.api.request.Executor<T>

Type Parameters:

T -

public class Executor<T>
extends java.lang.Object

Based on: "How to make GraphQL HTTP request using cUrl"

Based on the GET/POST and the Content-Type header, it expects the input params differently. This behaviour was ported from express-graphql.

So given the following operation:

 mutation M {
   newTodo: createTodo(text: "This is a mutation example") {
     text
     done
   }
 }
 

 using GET
 $ curl -g -GET 'http://localhost:8080/graphql?query=mutation+M{newTodo:createTodo(text:"This+is+a+mutation+example"){text+done}}'
 using POST + Content-Type: application/graphql
 $ curl -XPOST http://localhost:8080/graphql -H 'Content-Type: application/graphql' -d 'mutation M { newTodo: createTodo(text: "This is a mutation example") { text done } }'
 using POST + Content-Type: application/json
 $ curl -XPOST http://localhost:8080/graphql -H 'Content-Type: application/json' -d '{"query": "mutation M { newTodo: createTodo(text: \"This is a mutation example\") { text done } }"}'
 

Constructor Summary

Constructors

Constructor and Description
Executor(Endpoint endpoint, java.lang.String operation, java.lang.String query, manifold.rt.api.Bindings variables, java.lang.Class<T> resultType)
Executor(java.lang.String url, java.lang.String operation, java.lang.String query, manifold.rt.api.Bindings variables, java.lang.Class<T> resultType)
Executor(java.util.function.Supplier<Requester<manifold.rt.api.Bindings>> requester, java.lang.String operation, java.lang.String query, manifold.rt.api.Bindings variables, java.lang.Class<T> resultType)

Method Summary

Modifier and Type	Method and Description
T	get() Make an HTTP GET request to url.
T	get(Requester.Format format) Make an HTTP GET request to url.
Endpoint	getEndpoint() Access the GraphQL request endpoint.
Requester.Format	getFormat() Access the GraphQL request format.
java.util.Map<java.lang.String,java.lang.String>	getHeaders() Access an unmodifiable view of the GraphQL request headers.
java.util.function.Function<manifold.rt.api.Bindings,java.lang.Object>	getRawResponseHandler()
GqlRequestBody	getRequestBody() Access the full GraphQL request body, which includes query and variables bindings.
int	getTimeout() Access the GraphqL request timeout.
T	post() Make an HTTP POST request to url.
T	post(Requester.Format format) Make an HTTP POST request to url.
Executor<T>	withAuthorization(java.lang.String tokenType, java.lang.String accessToken)
Executor<T>	withBasicAuthorization(java.lang.String username, java.lang.String password) Set the Basic Authorization header using the provided username and password
Executor<T>	withBearerAuthorization(java.lang.String accessToken) Set the Bearer Authorization header using the provided accessToken.
Executor<T>	withHeader(java.lang.String name, java.lang.String value) Set an HTTP request header name : value pair See HTTP header fields
Executor<T>	withParam(java.lang.String name, java.lang.String value) Add a name=value parameter to the request URL.
Executor<T>	withRawResponseHandler(java.util.function.Function<manifold.rt.api.Bindings,java.lang.Object> handler)
Executor<T>	withTimeout(int timeout) The connection timeout setting in milliseconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

Executor

public Executor(java.lang.String url,
                java.lang.String operation,
                java.lang.String query,
                manifold.rt.api.Bindings variables,
                java.lang.Class<T> resultType)

Executor

public Executor(Endpoint endpoint,
                java.lang.String operation,
                java.lang.String query,
                manifold.rt.api.Bindings variables,
                java.lang.Class<T> resultType)

Executor

public Executor(java.util.function.Supplier<Requester<manifold.rt.api.Bindings>> requester,
                java.lang.String operation,
                java.lang.String query,
                manifold.rt.api.Bindings variables,
                java.lang.Class<T> resultType)

Method Detail

getRequestBody

public GqlRequestBody getRequestBody()

Access the full GraphQL request body, which includes query and variables bindings.

Returns:

the GraphQL request body consisting of bindings for both the query and variables.

getHeaders

public java.util.Map<java.lang.String,java.lang.String> getHeaders()

Access an unmodifiable view of the GraphQL request headers.

getEndpoint

public Endpoint getEndpoint()

Access the GraphQL request endpoint.

getFormat

public Requester.Format getFormat()

Access the GraphQL request format.

getTimeout

public int getTimeout()

Access the GraphqL request timeout.

withHeader

public Executor<T> withHeader(java.lang.String name,
                              java.lang.String value)

Set an HTTP request header name : value pair See HTTP header fields

withParam

public Executor<T> withParam(java.lang.String name,
                             java.lang.String value)

Add a name=value parameter to the request URL.

withBasicAuthorization

public Executor<T> withBasicAuthorization(java.lang.String username,
                                          java.lang.String password)

Set the Basic Authorization header using the provided username and password

withBearerAuthorization

public Executor<T> withBearerAuthorization(java.lang.String accessToken)

Set the Bearer Authorization header using the provided accessToken. For instance, if using OAuth, accessToken is the token response from:

 curl -d "grant_type=password&client_id=[...]&client_secret=[...]&username=[...]&password=[...]"
   https://[domain]/[oauth-service]
 

withAuthorization

public Executor<T> withAuthorization(java.lang.String tokenType,
                                     java.lang.String accessToken)

withTimeout

public Executor<T> withTimeout(int timeout)

The connection timeout setting in milliseconds. If the timeout expires before the connection can be established, a {@link java.net.SocketTimeoutException) is thrown. A value of zero is interpreted as an infinite timeout, this is the default setting.

withRawResponseHandler

public Executor<T> withRawResponseHandler(java.util.function.Function<manifold.rt.api.Bindings,java.lang.Object> handler)

Parameters:

handler - An optional handler for processing the raw response as an arbitrary Bindings instance. The handler may return a custom bindings object which overrides the default, type-safe result instance. In any case, the handler can process the response in any way. Note, modifications made to the response persist and, therefore, affect default internal data and error processing.

Returns:

this Executor instance.

getRawResponseHandler

public java.util.function.Function<manifold.rt.api.Bindings,java.lang.Object> getRawResponseHandler()

post

public T post()
       throws GqlRequestException

Make an HTTP POST request to url. The payload, if non-null, is sent as JSON encoded text in the request's message body.

Returns:

A JSON value parsed from the format specified encoded response (primitive/boxed type, String, List of JSON values, or Bindings of String/JSON value)

Throws:

GqlRequestException - If the response contains errors, wraps them in a list of GqlError and throws

post

public T post(Requester.Format format)
       throws GqlRequestException

Make an HTTP POST request to url. The payload, if non-null, is sent as JSON encoded text in the request's message body.

Parameters:

format - The expected format of the response. One of: Json, Yaml, or Plain

Returns:

A JSON value parsed from the format specified encoded response (primitive/boxed type, String, List of JSON values, or Bindings of String/JSON value)

Throws:

GqlRequestException - If the response contains errors, wraps them in a list of GqlError and throws

get

public T get()
      throws GqlRequestException

Make an HTTP GET request to url. The payload, if non-null, is sent as JSON encoded text in the request's message body.

Returns:

A JSON value parsed from the format specified encoded response (primitive/boxed type, String, List of JSON values, or Bindings of String/JSON value)

Throws:

GqlRequestException - If the response contains errors, wraps them in a list of GqlError and throws

get

public T get(Requester.Format format)
      throws GqlRequestException

Make an HTTP GET request to url. The payload, if non-null, is sent as JSON encoded text in the request's message body.

Parameters:

format - The expected format of the response. One of: Json, Yaml, or Plain

Returns:

A JSON value parsed from the format specified encoded response (primitive/boxed type, String, List of JSON values, or Bindings of String/JSON value)

Throws:

GqlRequestException - If the response contains errors, wraps them in a list of GqlError and throws