Package org.springframework.graphql.client

Class AbstractGraphQlClientBuilder<B extends AbstractGraphQlClientBuilder<B>>

java.lang.Object

org.springframework.graphql.client.AbstractGraphQlClientBuilder<B>

Type Parameters:

B - the type of builder

All Implemented Interfaces:

GraphQlClient.BaseBuilder<B>, GraphQlClient.Builder<B>

public abstract class AbstractGraphQlClientBuilder<B extends AbstractGraphQlClientBuilder<B>>
extends Object
implements GraphQlClient.Builder<B>

Abstract, base class for transport specific GraphQlClient.Builder implementations.

Subclasses must implement GraphQlClient.BaseBuilder.build() and call buildGraphQlClient(GraphQlTransport) to obtain a default, transport agnostic GraphQlClient. A transport specific extension can then wrap this default tester by extending AbstractDelegatingGraphQlClient.

Since:

1.0.0

Author:

Rossen Stoyanchev

See Also:

• AbstractDelegatingGraphQlClient

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractGraphQlClientBuilder.DefaultJackson2Codecs

Field Summary

Fields

Modifier and Type	Field	Description
protected static final boolean	jackson2Present

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractGraphQlClientBuilder()	Default constructor for use from subclasses.

Method Summary

Modifier and Type	Method	Description
B	blockingTimeout(Duration blockingTimeout)	Configure a timeout to use for blocking execution.
protected GraphQlClient	buildGraphQlClient(GraphQlTransport transport)	Build the default transport-agnostic client that subclasses can then wrap with AbstractDelegatingGraphQlClient.
B	documentSource(DocumentSource documentSource)	Configure a DocumentSource strategy to resolve a document by name.
protected Consumer<AbstractGraphQlClientBuilder<?>>	getBuilderInitializer()	Return a Consumer to initialize new builders from "this" builder.
protected List<GraphQlClientInterceptor>	getInterceptors()	Return the configured interceptors.
protected Decoder<?>	getJsonDecoder()	Access to the configured JSON encoder.
protected Encoder<?>	getJsonEncoder()	Access to the configured JSON encoder.
B	interceptor(GraphQlClientInterceptor... interceptors)	Configure interceptors to be invoked before delegating to the GraphQlTransport to perform the request.
B	interceptors(Consumer<List<GraphQlClientInterceptor>> interceptorsConsumer)	Customize the list of interceptors.
protected void	setJsonCodecs(Encoder<?> encoder, Decoder<?> decoder)	Transport-specific subclasses can provide their JSON Encoder and Decoder for use at the client level, for mapping response data to some target entity type.
protected void	setJsonDecoder(Decoder<?> decoder)	Variant of setJsonCodecs(org.springframework.core.codec.Encoder<?>, org.springframework.core.codec.Decoder<?>) for setting each codec individually.
protected void	setJsonEncoder(Encoder<?> encoder)	Variant of setJsonCodecs(org.springframework.core.codec.Encoder<?>, org.springframework.core.codec.Decoder<?>) for setting each codec individually.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.graphql.client.GraphQlClient.BaseBuilder

build

Field Details

jackson2Present

protected static final boolean jackson2Present

Constructor Details

AbstractGraphQlClientBuilder

protected AbstractGraphQlClientBuilder()

Default constructor for use from subclasses.

Subclasses must set the transport to use before GraphQlClient.BaseBuilder.build() or during, by overriding GraphQlClient.BaseBuilder.build().

Method Details

interceptor

public B interceptor(GraphQlClientInterceptor... interceptors)

Description copied from interface: GraphQlClient.Builder

Configure interceptors to be invoked before delegating to the GraphQlTransport to perform the request.

Specified by:

interceptor in interface GraphQlClient.Builder<B extends AbstractGraphQlClientBuilder<B>>

Parameters:

interceptors - the interceptors to add

Returns:

this builder

interceptors

public B interceptors(Consumer<List<GraphQlClientInterceptor>> interceptorsConsumer)

Description copied from interface: GraphQlClient.Builder

Customize the list of interceptors. The provided list is "live", so the consumer can inspect and insert interceptors accordingly.

Specified by:

interceptors in interface GraphQlClient.Builder<B extends AbstractGraphQlClientBuilder<B>>

Parameters:

interceptorsConsumer - consumer to customize the interceptors with

Returns:

this builder

documentSource

public B documentSource(DocumentSource documentSource)

Description copied from interface: GraphQlClient.BaseBuilder

Configure a DocumentSource strategy to resolve a document by name. For use within GraphQlClient.documentName(String).

By default, this is set to ResourceDocumentSource with classpath location "graphql-documents/" and ResourceDocumentSource.FILE_EXTENSIONS as extensions.

Specified by:

documentSource in interface GraphQlClient.BaseBuilder<B extends AbstractGraphQlClientBuilder<B>>

Parameters:

documentSource - the strategy for resolving documents by their names

blockingTimeout

public B blockingTimeout(@Nullable
 Duration blockingTimeout)

Description copied from interface: GraphQlClient.BaseBuilder

Configure a timeout to use for blocking execution.

By default this is not set, in which case the behavior depends on connection and request timeout settings of the underlying transport. We recommend configuring timeout values directly if possible on the underlying transport library such an HTTP client library as that can provide more control over such settings.

Specified by:

blockingTimeout in interface GraphQlClient.BaseBuilder<B extends AbstractGraphQlClientBuilder<B>>

Parameters:

blockingTimeout - the timeout to use

setJsonCodecs

protected void setJsonCodecs(Encoder<?> encoder,
 Decoder<?> decoder)

Transport-specific subclasses can provide their JSON Encoder and Decoder for use at the client level, for mapping response data to some target entity type.

Parameters:

encoder - the JSON encoder

decoder - the JSON decoder

setJsonEncoder

protected void setJsonEncoder(Encoder<?> encoder)

Variant of setJsonCodecs(org.springframework.core.codec.Encoder<?>, org.springframework.core.codec.Decoder<?>) for setting each codec individually.

Parameters:

encoder - the JSON encoder

getJsonEncoder

protected Encoder<?> getJsonEncoder()

Access to the configured JSON encoder.

setJsonDecoder

protected void setJsonDecoder(Decoder<?> decoder)

Variant of setJsonCodecs(org.springframework.core.codec.Encoder<?>, org.springframework.core.codec.Decoder<?>) for setting each codec individually.

Parameters:

decoder - the JSON decoder

getJsonDecoder

protected Decoder<?> getJsonDecoder()

Access to the configured JSON encoder.

getInterceptors

protected List<GraphQlClientInterceptor> getInterceptors()

Return the configured interceptors. For subclasses that look for a transport specific interceptor extensions.

buildGraphQlClient

protected GraphQlClient buildGraphQlClient(GraphQlTransport transport)

Build the default transport-agnostic client that subclasses can then wrap with AbstractDelegatingGraphQlClient.

Parameters:

transport - the GraphQL transport to be used by the client

getBuilderInitializer

protected Consumer<AbstractGraphQlClientBuilder<?>> getBuilderInitializer()

Return a Consumer to initialize new builders from "this" builder.