Class DefaultGraphQLInvocation

java.lang.Object

io.micronaut.configuration.graphql.DefaultGraphQLInvocation

All Implemented Interfaces:

GraphQLInvocation

@Singleton
public class DefaultGraphQLInvocation
extends Object
implements GraphQLInvocation

The default implementation for invoking GraphQL requests.

Since:

1.0

Author:

Marcel Overdijk, Graeme Rocher, James Kleeh

See Also:

• GraphQLExecutionInputCustomizer.customize(ExecutionInput, HttpRequest, MutableHttpResponse)
• GraphQL.executeAsync(ExecutionInput.Builder)

Constructor Summary

Constructors

Constructor	Description
DefaultGraphQLInvocation(graphql.GraphQL graphQL, GraphQLExecutionInputCustomizer graphQLExecutionInputCustomizer, @Nullable io.micronaut.context.BeanProvider<org.dataloader.DataLoaderRegistry> dataLoaderRegistry)	Deprecated, for removal: This API element is subject to removal in a future version. Use DefaultGraphQLInvocation(io.micronaut.context.BeanContext,io.micronaut.configuration.graphql.GraphQLExecutionInputCustomizer,io.micronaut.context.@org.jspecify.annotations.Nullable BeanProvider<org.dataloader.DataLoaderRegistry>) instead.
DefaultGraphQLInvocation(io.micronaut.context.BeanContext beanContext, GraphQLExecutionInputCustomizer graphQLExecutionInputCustomizer, @Nullable io.micronaut.context.BeanProvider<org.dataloader.DataLoaderRegistry> dataLoaderRegistry)	Default constructor.

Method Summary

Modifier and Type	Method	Description
org.reactivestreams.Publisher<graphql.ExecutionResult>	invoke(GraphQLInvocationData invocationData, io.micronaut.http.HttpRequest httpRequest, @Nullable io.micronaut.http.MutableHttpResponse<String> httpResponse)	Invokes the GraphQL request and returns a publisher that emits ExecutionResult objects.

Methods inherited from class Object

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

Constructor Details

DefaultGraphQLInvocation

@Inject
public DefaultGraphQLInvocation(io.micronaut.context.BeanContext beanContext,
 GraphQLExecutionInputCustomizer graphQLExecutionInputCustomizer,
 @Nullable io.micronaut.context.BeanProvider<org.dataloader.DataLoaderRegistry> dataLoaderRegistry)

Default constructor.

Parameters:

beanContext - the bean context used to resolve the current GraphQL bean

graphQLExecutionInputCustomizer - the GraphQLExecutionInputCustomizer instance

dataLoaderRegistry - the DataLoaderRegistry instance

DefaultGraphQLInvocation

@Deprecated(forRemoval=true,
            since="5.1.0")
public DefaultGraphQLInvocation(graphql.GraphQL graphQL,
 GraphQLExecutionInputCustomizer graphQLExecutionInputCustomizer,
 @Nullable io.micronaut.context.BeanProvider<org.dataloader.DataLoaderRegistry> dataLoaderRegistry)

Deprecated, for removal: This API element is subject to removal in a future version.

Use DefaultGraphQLInvocation(io.micronaut.context.BeanContext,io.micronaut.configuration.graphql.GraphQLExecutionInputCustomizer,io.micronaut.context.@org.jspecify.annotations.Nullable BeanProvider<org.dataloader.DataLoaderRegistry>) instead.

Compatibility constructor for direct instantiation.

Parameters:

graphQL - the GraphQL instance

graphQLExecutionInputCustomizer - the GraphQLExecutionInputCustomizer instance

dataLoaderRegistry - the DataLoaderRegistry instance

Method Details

invoke

public org.reactivestreams.Publisher<graphql.ExecutionResult> invoke(GraphQLInvocationData invocationData,
 io.micronaut.http.HttpRequest httpRequest,
 @Nullable io.micronaut.http.MutableHttpResponse<String> httpResponse)

Invokes the GraphQL request and returns a publisher that emits ExecutionResult objects.

Specified by:

invoke in interface GraphQLInvocation

Parameters:

invocationData - the GraphQL invocation data

httpRequest - the HTTP request

httpResponse - the mutable HTTP response, can be null when using websocket

Returns:

the GraphQL execution result