Class AbstractGraphQlSourceBuilder<B extends GraphQlSource.Builder<B>>

java.lang.Object

org.springframework.graphql.execution.AbstractGraphQlSourceBuilder<B>

Type Parameters:

B - the builder type

All Implemented Interfaces:

GraphQlSource.Builder<B>

public abstract class AbstractGraphQlSourceBuilder<B extends GraphQlSource.Builder<B>>
extends Object
implements GraphQlSource.Builder<B>

Implementation of GraphQlSource.Builder that leaves it to subclasses to initialize GraphQLSchema.

Since:

1.0.0

Author:

Rossen Stoyanchev, Brian Clozel

Constructor Summary

Constructors

Constructor	Description
AbstractGraphQlSourceBuilder()

Method Summary

Modifier and Type	Method	Description
protected void	applyGraphQlConfigurers(graphql.GraphQL.Builder builder)	Protected method to apply the configured graphQlConfigurer's.
GraphQlSource	build()	Build the GraphQlSource instance.
B	configureGraphQl(Consumer<graphql.GraphQL.Builder> configurer)	Configure consumers to be given access to the GraphQL.Builder used to build GraphQL.
B	exceptionResolvers(List<DataFetcherExceptionResolver> resolvers)	Add DataFetcherExceptionResolver's that are invoked when a DataFetcher raises an exception.
B	graphQlSourceFactory(GraphQlSource.Factory factory)	Configure a factory to use to create the GraphQlSource instance to return from the GraphQlSource.Builder.build() method.
protected abstract graphql.schema.GraphQLSchema	initGraphQlSchema()	Subclasses must implement this method to provide the GraphQLSchema instance.
B	instrumentation(List<graphql.execution.instrumentation.Instrumentation> instrumentations)	Provide Instrumentation components to instrument the execution of GraphQL queries.
B	subscriptionExceptionResolvers(List<SubscriptionExceptionResolver> resolvers)	Add SubscriptionExceptionResolvers that are invoked when a GraphQL subscription Publisher ends with error, and given a chance to resolve the exception to one or more GraphQL errors to be sent to the client.
B	typeVisitors(List<graphql.schema.GraphQLTypeVisitor> typeVisitors)	Add GraphQLTypeVisitors to visit all element of the created GraphQLSchema and make changes to the GraphQLCodeRegistry.
B	typeVisitorsToTransformSchema(List<graphql.schema.GraphQLTypeVisitor> typeVisitorsToTransformSchema)	Alternative to GraphQlSource.Builder.typeVisitors(List) for visitors that also need to make schema changes.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractGraphQlSourceBuilder

public AbstractGraphQlSourceBuilder()

Method Details

exceptionResolvers

public B exceptionResolvers(List<DataFetcherExceptionResolver> resolvers)

Description copied from interface: GraphQlSource.Builder

Add DataFetcherExceptionResolver's that are invoked when a DataFetcher raises an exception. Resolvers are invoked in sequence until one emits a list.

Specified by:

exceptionResolvers in interface GraphQlSource.Builder<B extends GraphQlSource.Builder<B>>

Parameters:

resolvers - the resolvers to add

Returns:

the current builder

subscriptionExceptionResolvers

public B subscriptionExceptionResolvers(List<SubscriptionExceptionResolver> resolvers)

Description copied from interface: GraphQlSource.Builder

Add SubscriptionExceptionResolvers that are invoked when a GraphQL subscription Publisher ends with error, and given a chance to resolve the exception to one or more GraphQL errors to be sent to the client. Resolvers are invoked in sequence until one emits a list.

Specified by:

subscriptionExceptionResolvers in interface GraphQlSource.Builder<B extends GraphQlSource.Builder<B>>

Parameters:

resolvers - the subscription exception resolver

Returns:

the current builder

typeVisitors

public B typeVisitors(List<graphql.schema.GraphQLTypeVisitor> typeVisitors)

Description copied from interface: GraphQlSource.Builder

Add GraphQLTypeVisitors to visit all element of the created GraphQLSchema and make changes to the GraphQLCodeRegistry.

Note: Visitors are applied via SchemaTraverser and cannot change the schema.

Specified by:

typeVisitors in interface GraphQlSource.Builder<B extends GraphQlSource.Builder<B>>

Parameters:

typeVisitors - the type visitors

Returns:

the current builder

See Also:

• SchemaTransformer.transformSchema(GraphQLSchema, GraphQLTypeVisitor)

typeVisitorsToTransformSchema

public B typeVisitorsToTransformSchema(List<graphql.schema.GraphQLTypeVisitor> typeVisitorsToTransformSchema)

Description copied from interface: GraphQlSource.Builder

Alternative to GraphQlSource.Builder.typeVisitors(List) for visitors that also need to make schema changes.

Note: Visitors are applied via SchemaTransformer, and therefore can change the schema. However, this is more expensive than using SchemaTraverser, so generally prefer GraphQlSource.Builder.typeVisitors(List) if it's not necessary to change the schema.

Specified by:

typeVisitorsToTransformSchema in interface GraphQlSource.Builder<B extends GraphQlSource.Builder<B>>

Parameters:

typeVisitorsToTransformSchema - the type visitors to register

Returns:

the current builder

See Also:

• SchemaTransformer.transformSchema(GraphQLSchema, GraphQLTypeVisitor)

instrumentation

public B instrumentation(List<graphql.execution.instrumentation.Instrumentation> instrumentations)

Description copied from interface: GraphQlSource.Builder

Provide Instrumentation components to instrument the execution of GraphQL queries.

Specified by:

instrumentation in interface GraphQlSource.Builder<B extends GraphQlSource.Builder<B>>

Parameters:

instrumentations - the instrumentation components

Returns:

the current builder

See Also:

• GraphQL.Builder.instrumentation(Instrumentation)

configureGraphQl

public B configureGraphQl(Consumer<graphql.GraphQL.Builder> configurer)

Description copied from interface: GraphQlSource.Builder

Configure consumers to be given access to the GraphQL.Builder used to build GraphQL.

Specified by:

configureGraphQl in interface GraphQlSource.Builder<B extends GraphQlSource.Builder<B>>

Parameters:

configurer - the configurer

Returns:

the current builder

graphQlSourceFactory

public B graphQlSourceFactory(GraphQlSource.Factory factory)

Description copied from interface: GraphQlSource.Builder

Configure a factory to use to create the GraphQlSource instance to return from the GraphQlSource.Builder.build() method.

By default, the instance is a simple container of GraphQL and GraphQLSchema. Applications can use this to create a different implementation that applies additional per-request logic.

Specified by:

graphQlSourceFactory in interface GraphQlSource.Builder<B extends GraphQlSource.Builder<B>>

Parameters:

factory - the factory to use

Returns:

the current builder

build

public GraphQlSource build()

Description copied from interface: GraphQlSource.Builder

Build the GraphQlSource instance.

Specified by:

build in interface GraphQlSource.Builder<B extends GraphQlSource.Builder<B>>

initGraphQlSchema

protected abstract graphql.schema.GraphQLSchema initGraphQlSchema()

Subclasses must implement this method to provide the GraphQLSchema instance.

applyGraphQlConfigurers

protected void applyGraphQlConfigurers(graphql.GraphQL.Builder builder)

Protected method to apply the configured graphQlConfigurer's. Subclasses can use this to customize GraphQL.Builder further.

Parameters:

builder - the builder to be customized

Since:

1.2.5