com.adobe.aem.graphql.client

Class AEMHeadlessClientBuilder

java.lang.Object

com.adobe.aem.graphql.client.AEMHeadlessClientBuilder

public class AEMHeadlessClientBuilder
extends java.lang.Object

Builder to configure and create an instance of AEMHeadlessClient.

Method Summary

Modifier and Type	Method and Description
@NotNull AEMHeadlessClientBuilder	basicAuth(@NotNull java.lang.String user, @NotNull java.lang.String password) Configures the client for basic authentication.
@NotNull AEMHeadlessClient	build()
@NotNull AEMHeadlessClientBuilder	connectTimeout(int connectTimeout) Configures the connect timeout.
@NotNull AEMHeadlessClientBuilder	endpoint(@NotNull java.lang.String uri) Convenience method to allow to set the URI as string.
@NotNull AEMHeadlessClientBuilder	endpoint(@NotNull java.net.URI uri) Sets the endpoint for the GraphQL client.
@NotNull AEMHeadlessClientBuilder	readTimeout(int readTimeout) Configures the read timeout.
@NotNull AEMHeadlessClientBuilder	tokenAuth(@NotNull java.lang.String token) Configures the client for token authentication.

Methods inherited from class java.lang.Object

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

Method Detail

endpoint

@NotNull
public @NotNull AEMHeadlessClientBuilder endpoint(@NotNull
                                                           @NotNull java.net.URI uri)

Sets the endpoint for the GraphQL client. 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:

uri - the endpoint URI

Returns:

the builder

endpoint

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

Convenience method to allow to set the URI as string. See endpoint(URI) on how URIs are interpreted.

Parameters:

uri - the uri in string format

Returns:

the builder

Throws:

java.net.URISyntaxException - if the uri is invalid

basicAuth

@NotNull
public @NotNull AEMHeadlessClientBuilder basicAuth(@NotNull
                                                            @NotNull java.lang.String user,
                                                            @NotNull
                                                            @NotNull java.lang.String password)

Configures the client for basic authentication.

Parameters:

user - the user

password - the password

Returns:

the builder

tokenAuth

@NotNull
public @NotNull AEMHeadlessClientBuilder tokenAuth(@NotNull
                                                            @NotNull java.lang.String token)

Configures the client for token authentication.

Parameters:

token - the bearer token

Returns:

the builder

connectTimeout

@NotNull
public @NotNull AEMHeadlessClientBuilder connectTimeout(int connectTimeout)

Configures the connect timeout.

Parameters:

connectTimeout - the connect timeout

Returns:

the builder

readTimeout

@NotNull
public @NotNull AEMHeadlessClientBuilder readTimeout(int readTimeout)

Configures the read timeout.

Parameters:

readTimeout - the connect timeout

Returns:

the builder

build

@NotNull
public @NotNull AEMHeadlessClient build()