Package com.linecorp.armeria.server.graphql

Class GraphqlServiceBuilder

java.lang.Object

com.linecorp.armeria.server.graphql.GraphqlServiceBuilder

@UnstableApi
public final class GraphqlServiceBuilder
extends Object

Constructs a GraphqlService to serve GraphQL within Armeria.

Method Summary

Modifier and Type	Method	Description
GraphqlService	build()	Creates a GraphqlService.
GraphqlServiceBuilder	configureDataLoaderRegistry(Iterable<? extends Consumer<? super org.dataloader.DataLoaderRegistry>> configurers)	Deprecated. Use dataLoaderRegistry(Function) instead.
GraphqlServiceBuilder	configureDataLoaderRegistry(Consumer<org.dataloader.DataLoaderRegistry>... configurers)	Deprecated. Use dataLoaderRegistry(Function) instead.
GraphqlServiceBuilder	configureGraphql(GraphqlConfigurator... configurers)	Adds the GraphqlConfigurator consumers.
GraphqlServiceBuilder	configureGraphql(Iterable<? extends GraphqlConfigurator> configurers)	Adds the GraphqlConfigurator consumers.
GraphqlServiceBuilder	dataLoaderRegistry(Function<? super com.linecorp.armeria.server.ServiceRequestContext,? extends org.dataloader.DataLoaderRegistry> dataLoaderRegistryFactory)	Sets DataLoaderRegistry creation function.
GraphqlServiceBuilder	enableWebSocket(boolean enableWebSocket)	Enables GraphQL over WebSocket Protocol.
GraphqlServiceBuilder	errorHandler(GraphqlErrorHandler errorHandler)	Adds the GraphqlErrorHandler.
GraphqlServiceBuilder	executionIdGenerator(ExecutionIdGenerator executionIdGenerator)	Sets the ExecutionIdGenerator.
GraphqlServiceBuilder	instrumentation(graphql.execution.instrumentation.Instrumentation... instrumentations)	Adds the Instrumentations.
GraphqlServiceBuilder	instrumentation(Iterable<? extends graphql.execution.instrumentation.Instrumentation> instrumentations)	Adds the Instrumentations.
GraphqlServiceBuilder	runtimeWiring(RuntimeWiringConfigurator... runtimeWiringConfigurators)	Adds the RuntimeWiringConfigurators.
GraphqlServiceBuilder	runtimeWiring(Iterable<? extends RuntimeWiringConfigurator> configurators)	Adds the RuntimeWiringConfigurators.
GraphqlServiceBuilder	schema(graphql.schema.GraphQLSchema schema)	Sets the GraphQLSchema.
GraphqlServiceBuilder	schemaFile(File... schemaFiles)	Adds the schema Files.
GraphqlServiceBuilder	schemaFile(Iterable<? extends File> schemaFiles)	Adds the schema Files.
GraphqlServiceBuilder	schemaUrls(Iterable<String> schemaUrls)	Adds the schema loaded from the given URLs.
GraphqlServiceBuilder	schemaUrls(String... schemaUrls)	Adds the schema loaded from the given URLs.
GraphqlServiceBuilder	typeVisitors(graphql.schema.GraphQLTypeVisitor... typeVisitors)	Adds the GraphQLTypeVisitors.
GraphqlServiceBuilder	typeVisitors(Iterable<? extends graphql.schema.GraphQLTypeVisitor> typeVisitors)	Adds the GraphQLTypeVisitors.
GraphqlServiceBuilder	useBlockingTaskExecutor(boolean useBlockingTaskExecutor)	Sets whether the service executes service methods using the blocking executor.
GraphqlServiceBuilder	webSocketServiceCustomizer(Consumer<com.linecorp.armeria.server.websocket.WebSocketServiceBuilder> webSocketServiceCustomizer)	Sets an optional WebSocketServiceBuilder customizer.

Methods inherited from class java.lang.Object

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

Method Details

schemaFile

public GraphqlServiceBuilder schemaFile(File... schemaFiles)

Adds the schema Files. If not set, the schema.graphql or schema.graphqls will be imported from the resource.

schemaFile

public GraphqlServiceBuilder schemaFile(Iterable<? extends File> schemaFiles)

Adds the schema Files. If not set, the schema.graphql or schema.graphqls will be imported from the resource.

schemaUrls

public GraphqlServiceBuilder schemaUrls(String... schemaUrls)

Adds the schema loaded from the given URLs. If not set, the schema.graphql or schema.graphqls will be imported from the resource.

schemaUrls

public GraphqlServiceBuilder schemaUrls(Iterable<String> schemaUrls)

Adds the schema loaded from the given URLs. If not set, the schema.graphql or schema.graphqls will be imported from the resource.

schema

public GraphqlServiceBuilder schema(graphql.schema.GraphQLSchema schema)

Sets the GraphQLSchema.

dataLoaderRegistry

public GraphqlServiceBuilder dataLoaderRegistry(Function<? super com.linecorp.armeria.server.ServiceRequestContext,? extends org.dataloader.DataLoaderRegistry> dataLoaderRegistryFactory)

Sets DataLoaderRegistry creation function.

configureDataLoaderRegistry

@Deprecated
public GraphqlServiceBuilder configureDataLoaderRegistry(Consumer<org.dataloader.DataLoaderRegistry>... configurers)

Deprecated.

Use dataLoaderRegistry(Function) instead.

Adds the DataLoaderRegistry consumers.

configureDataLoaderRegistry

@Deprecated
public GraphqlServiceBuilder configureDataLoaderRegistry(Iterable<? extends Consumer<? super org.dataloader.DataLoaderRegistry>> configurers)

Deprecated.

Use dataLoaderRegistry(Function) instead.

Adds the DataLoaderRegistry consumers.

runtimeWiring

public GraphqlServiceBuilder runtimeWiring(RuntimeWiringConfigurator... runtimeWiringConfigurators)

Adds the RuntimeWiringConfigurators.

runtimeWiring

public GraphqlServiceBuilder runtimeWiring(Iterable<? extends RuntimeWiringConfigurator> configurators)

Adds the RuntimeWiringConfigurators.

typeVisitors

public GraphqlServiceBuilder typeVisitors(graphql.schema.GraphQLTypeVisitor... typeVisitors)

Adds the GraphQLTypeVisitors.

typeVisitors

public GraphqlServiceBuilder typeVisitors(Iterable<? extends graphql.schema.GraphQLTypeVisitor> typeVisitors)

Adds the GraphQLTypeVisitors.

instrumentation

public GraphqlServiceBuilder instrumentation(graphql.execution.instrumentation.Instrumentation... instrumentations)

Adds the Instrumentations.

instrumentation

public GraphqlServiceBuilder instrumentation(Iterable<? extends graphql.execution.instrumentation.Instrumentation> instrumentations)

Adds the Instrumentations.

configureGraphql

public GraphqlServiceBuilder configureGraphql(GraphqlConfigurator... configurers)

Adds the GraphqlConfigurator consumers.

configureGraphql

public GraphqlServiceBuilder configureGraphql(Iterable<? extends GraphqlConfigurator> configurers)

Adds the GraphqlConfigurator consumers.

useBlockingTaskExecutor

public GraphqlServiceBuilder useBlockingTaskExecutor(boolean useBlockingTaskExecutor)

Sets whether the service executes service methods using the blocking executor.

enableWebSocket

public GraphqlServiceBuilder enableWebSocket(boolean enableWebSocket)

Enables GraphQL over WebSocket Protocol.

webSocketServiceCustomizer

public GraphqlServiceBuilder webSocketServiceCustomizer(Consumer<com.linecorp.armeria.server.websocket.WebSocketServiceBuilder> webSocketServiceCustomizer)

Sets an optional WebSocketServiceBuilder customizer.

errorHandler

public GraphqlServiceBuilder errorHandler(GraphqlErrorHandler errorHandler)

Adds the GraphqlErrorHandler. If multiple handlers are added, the latter is composed with the former one using GraphqlErrorHandler.orElse(GraphqlErrorHandler).

If not specified, GraphqlErrorHandler.of() is used by default.

executionIdGenerator

public GraphqlServiceBuilder executionIdGenerator(ExecutionIdGenerator executionIdGenerator)

Sets the ExecutionIdGenerator. If not specified, ExecutionIdGenerator.of() is used by default.

build

public GraphqlService build()

Creates a GraphqlService.