com.adobe.aem.graphql.client

Class AEMHeadlessClient

java.lang.Object

com.adobe.aem.graphql.client.AEMHeadlessClient

public class AEMHeadlessClient
extends java.lang.Object

Client that simplifies interaction with AEM GraphQL endpoints.

Constructor Summary

Constructors

Constructor and Description
AEMHeadlessClient(@NotNull java.lang.String endpoint) Creates a simple client (no authentication or other configuration).

Method Summary

Modifier and Type	Method and Description
static @NotNull AEMHeadlessClientBuilder	builder() Builder that allows to configure all available options of the AEMHeadlessClient
@NotNull java.util.List<PersistedQuery>	listPersistedQueries(@NotNull java.lang.String configurationName) Lists all persisted queries for the given configuration name.
@NotNull PersistedQuery	persistQuery(@NotNull java.lang.String queryToPersist, @NotNull java.lang.String persistedQueryPath) Adds a new persisted query on the server.
@NotNull GraphQlResponse	runPersistedQuery(@NotNull PersistedQuery persistedQuery) Runs a persisted query on the server.
@NotNull GraphQlResponse	runPersistedQuery(@NotNull PersistedQuery persistedQuery, java.util.Map<java.lang.String,java.lang.Object> variables) Runs a persisted query on the server.
@NotNull GraphQlResponse	runPersistedQuery(@NotNull java.lang.String persistedQueryPath) Runs a persisted query on the server.
@NotNull GraphQlResponse	runPersistedQuery(@NotNull java.lang.String persistedQueryPath, java.util.Map<java.lang.String,java.lang.Object> variables) Runs a persisted query on the server.
@NotNull GraphQlResponse	runQuery(@NotNull java.lang.String query) Runs the given GraphQL query on server.
@NotNull GraphQlResponse	runQuery(@NotNull java.lang.String query, java.util.Map<java.lang.String,java.lang.Object> variables) Runs the given GraphQL query on server.

Methods inherited from class java.lang.Object

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

Constructor Detail

AEMHeadlessClient

public AEMHeadlessClient(@NotNull
                         @NotNull java.lang.String endpoint)
                  throws java.net.URISyntaxException

Creates a simple client (no authentication or other configuration). For more complex cases use builder(). If the endpoint points to a server only without path (e.g. http:/myserver:8080), then the default endpoint for GraphQL queries /content/graphql/global/endpoint.json is taken.

Parameters:

endpoint - the endpoint to run queries against

Throws:

java.net.URISyntaxException - if the endpoint is an invalid URI

Method Detail

builder

@NotNull
public static @NotNull AEMHeadlessClientBuilder builder()

Builder that allows to configure all available options of the AEMHeadlessClient

Returns:

builder

runQuery

@NotNull
public @NotNull GraphQlResponse runQuery(@NotNull
                                                  @NotNull java.lang.String query)

Runs the given GraphQL query on server.

Parameters:

query - the query to execute

Returns:

the GraphQlResponse

Throws:

AEMHeadlessClientException - if the query cannot be executed

runQuery

@NotNull
public @NotNull GraphQlResponse runQuery(@NotNull
                                                  @NotNull java.lang.String query,
                                                  java.util.Map<java.lang.String,java.lang.Object> variables)

Runs the given GraphQL query on server.

Parameters:

query - the query to execute

variables - variables for the query

Returns:

the GraphQlResponse

Throws:

AEMHeadlessClientException - if the query cannot be executed

listPersistedQueries

@NotNull
public @NotNull java.util.List<PersistedQuery> listPersistedQueries(@NotNull
                                                                             @NotNull java.lang.String configurationName)

Lists all persisted queries for the given configuration name.

Parameters:

configurationName - the configuration name to list queries for

Returns:

list of PersistedQuerys

Throws:

AEMHeadlessClientException - if the persisted queries cannot be retrieved

runPersistedQuery

@NotNull
public @NotNull GraphQlResponse runPersistedQuery(@NotNull
                                                           @NotNull PersistedQuery persistedQuery)

Runs a persisted query on the server.

Parameters:

persistedQuery - a PersistedQuery as retrieved by listPersistedQueries(String).

Returns:

the GraphQlResponse

Throws:

AEMHeadlessClientException - if the persisted query cannot be executed

runPersistedQuery

@NotNull
public @NotNull GraphQlResponse runPersistedQuery(@NotNull
                                                           @NotNull PersistedQuery persistedQuery,
                                                           java.util.Map<java.lang.String,java.lang.Object> variables)

Runs a persisted query on the server.

Parameters:

persistedQuery - a PersistedQuery as retrieved by listPersistedQueries(String)

variables - variables for the persisted query

Returns:

the GraphQlResponse

Throws:

AEMHeadlessClientException - if the persisted query cannot be executed

runPersistedQuery

@NotNull
public @NotNull GraphQlResponse runPersistedQuery(@NotNull
                                                           @NotNull java.lang.String persistedQueryPath)

Runs a persisted query on the server.

Parameters:

persistedQueryPath - the persisted query path, e.g. /myproj/myquery

Returns:

the GraphQlResponse

Throws:

AEMHeadlessClientException - if the persisted query cannot be executed

runPersistedQuery

@NotNull
public @NotNull GraphQlResponse runPersistedQuery(@NotNull
                                                           @NotNull java.lang.String persistedQueryPath,
                                                           java.util.Map<java.lang.String,java.lang.Object> variables)

Runs a persisted query on the server.

Parameters:

persistedQueryPath - the persisted query path, e.g. /myproj/myquery

variables - variables for the persisted query

Returns:

the GraphQlResponse

Throws:

AEMHeadlessClientException - if the persisted query cannot be executed

persistQuery

@NotNull
public @NotNull PersistedQuery persistQuery(@NotNull
                                                     @NotNull java.lang.String queryToPersist,
                                                     @NotNull
                                                     @NotNull java.lang.String persistedQueryPath)

Adds a new persisted query on the server.

Parameters:

queryToPersist - the query

persistedQueryPath - the path to persist the query, e.g. /myproj/myquery

Returns:

the saved PersistedQuery

Throws:

AEMHeadlessClientException - if the query cannot be persisted