com.adobe.cq.commerce.graphql.client.impl

Class GraphqlClientImpl

java.lang.Object

com.adobe.cq.commerce.graphql.client.impl.GraphqlClientImpl

All Implemented Interfaces:

GraphqlClient

public class GraphqlClientImpl
extends Object
implements GraphqlClient

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.http.client.HttpClient	client

Constructor Summary

Constructors

Constructor and Description
GraphqlClientImpl()

Method Summary

Modifier and Type	Method and Description
void	activate(GraphqlClientConfiguration configuration)
protected void	deactivate()
<T,U> GraphqlResponse<T,U>	execute(GraphqlRequest request, Type typeOfT, Type typeofU) Executes the given GraphQL request and deserializes the response data based on the types T and U.
<T,U> GraphqlResponse<T,U>	execute(GraphqlRequest request, Type typeOfT, Type typeofU, RequestOptions options) Executes the given GraphQL request and deserializes the response data based on the types T and U.
GraphqlClientConfiguration	getConfiguration() Returns the complete configuration of the GraphQL client.
String	getGraphQLEndpoint() Returns the URL of the used GraphQL server endpoint.
String	getIdentifier() Returns the identifier of this GraphQL client and backing OSGi service.

Methods inherited from class java.lang.Object

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

Field Detail

client

protected org.apache.http.client.HttpClient client

Constructor Detail

GraphqlClientImpl

public GraphqlClientImpl()

Method Detail

activate

public void activate(GraphqlClientConfiguration configuration)
              throws Exception

Throws:

Exception

deactivate

protected void deactivate()

getIdentifier

public String getIdentifier()

Description copied from interface: GraphqlClient

Returns the identifier of this GraphQL client and backing OSGi service. This can be set on JCR resources with the cq:graphqlClient property.

Specified by:

getIdentifier in interface GraphqlClient

Returns:

The identifier value of this client.

getGraphQLEndpoint

public String getGraphQLEndpoint()

Description copied from interface: GraphqlClient

Returns the URL of the used GraphQL server endpoint.

Specified by:

getGraphQLEndpoint in interface GraphqlClient

Returns:

The backend GraphQL server endpoint used by this client.

getConfiguration

public GraphqlClientConfiguration getConfiguration()

Description copied from interface: GraphqlClient

Returns the complete configuration of the GraphQL client.

Specified by:

getConfiguration in interface GraphqlClient

Returns:

GraphQL client configuration.

execute

public <T,U> GraphqlResponse<T,U> execute(GraphqlRequest request,
                                          Type typeOfT,
                                          Type typeofU)

Description copied from interface: GraphqlClient

Executes the given GraphQL request and deserializes the response data based on the types T and U. The type T is used to deserialize the 'data' object of the GraphQL response, and the type U is used to deserialize the 'errors' array of the GraphQL response. Each generic type can be a simple class or a generic class. To specify a simple class, just do:

 GraphqlResponse<MyData, MyError> response = graphqlClient.execute(request, MyData.class, MyError.class);
 MyData data = response.getData();
 List<MyError> errors = response.getErrors();
 

To specify a generic type (usually for the type T), one can use the TypeToken class. For example:

 Type typeOfT = new TypeToken<List<String>>() {}.getType();
 GraphqlResponse<List<String>, MyError> response = graphqlClient.execute(request, typeOfT, MyError.class);
 List<String> data = response.getData();
 

Specified by:

execute in interface GraphqlClient

Type Parameters:

T - The generic type of the 'data' object in the JSON GraphQL response.

U - The generic type of the elements of the 'errors' array in the JSON GraphQL response.

Parameters:

request - The GraphQL request.

typeOfT - The type of the expected GraphQL response 'data' field.

typeofU - The type of the elements of the expected GraphQL response 'errors' field.

Returns:

A GraphQL response.

execute

public <T,U> GraphqlResponse<T,U> execute(GraphqlRequest request,
                                          Type typeOfT,
                                          Type typeofU,
                                          RequestOptions options)

Description copied from interface: GraphqlClient

Executes the given GraphQL request and deserializes the response data based on the types T and U. The type T is used to deserialize the 'data' object of the GraphQL response, and the type U is used to deserialize the 'errors' array of the GraphQL response. Each generic type can be a simple class or a generic class. To specify a simple class, just do:

 GraphqlResponse<MyData, MyError> response = graphqlClient.execute(request, MyData.class, MyError.class);
 MyData data = response.getData();
 List<MyError> errors = response.getErrors();
 

To specify a generic type (usually for the type T), one can use the TypeToken class. For example:

 Type typeOfT = new TypeToken<List<String>>() {}.getType();
 GraphqlResponse<List<String>, MyError> response = graphqlClient.execute(request, typeOfT, MyError.class);
 List<String> data = response.getData();
 

Specified by:

execute in interface GraphqlClient

Type Parameters:

T - The generic type of the 'data' object in the JSON GraphQL response.

U - The generic type of the elements of the 'errors' array in the JSON GraphQL response.

Parameters:

request - The GraphQL request.

typeOfT - The type of the expected GraphQL response 'data' field.

typeofU - The type of the elements of the expected GraphQL response 'errors' field.

options - An object holding options that can be set when executing the request.

Returns:

A GraphQL response.