Package graphql.execution

Class ExecutionContext

java.lang.Object

graphql.execution.ExecutionContext

@PublicApi
public class ExecutionContext
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
void	addError(GraphQLError error)	This method will allow you to add errors into the running execution context, without a check for per field unique-ness
void	addError(GraphQLError error, ResultPath fieldPath)	This method will only put one error per field path.
void	addErrors(java.util.List<GraphQLError> errors)	This method will allow you to add errors into the running execution context, without a check for per field unique-ness
CoercedVariables	getCoercedVariables()
<T> T	getContext()	Deprecated. use getGraphQLContext() instead
DataLoaderDispatchStrategy	getDataLoaderDispatcherStrategy()
org.dataloader.DataLoaderRegistry	getDataLoaderRegistry()
Document	getDocument()
java.util.List<GraphQLError>	getErrors()
ExecutionId	getExecutionId()
ExecutionInput	getExecutionInput()
FragmentDefinition	getFragment(java.lang.String name)
java.util.Map<java.lang.String,FragmentDefinition>	getFragmentsByName()
GraphQLContext	getGraphQLContext()
GraphQLSchema	getGraphQLSchema()
IncrementalCallState	getIncrementalCallState()
Instrumentation	getInstrumentation()
InstrumentationState	getInstrumentationState()
<T> T	getLocalContext()
java.util.Locale	getLocale()
ExecutionStrategy	getMutationStrategy()
java.util.function.Supplier<ExecutableNormalizedOperation>	getNormalizedQueryTree()
OperationDefinition	getOperationDefinition()
ExecutionStrategy	getQueryStrategy()
<T> T	getRoot()
ExecutionStrategy	getStrategy(OperationDefinition.Operation operation)
ExecutionStrategy	getSubscriptionStrategy()
ValueUnboxer	getValueUnboxer()
java.util.Map<java.lang.String,java.lang.Object>	getVariables()	Deprecated. use getCoercedVariables() instead
void	setDataLoaderDispatcherStrategy(DataLoaderDispatchStrategy dataLoaderDispatcherStrategy)
ExecutionContext	transform(java.util.function.Consumer<ExecutionContextBuilder> builderConsumer)	This helps you transform the current ExecutionContext object into another one by starting a builder with all the current values and allows you to transform it how you want.

Methods inherited from class java.lang.Object

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

Method Detail

getExecutionId

public ExecutionId getExecutionId()

getExecutionInput

public ExecutionInput getExecutionInput()

getInstrumentationState

public InstrumentationState getInstrumentationState()

getInstrumentation

public Instrumentation getInstrumentation()

getGraphQLSchema

public GraphQLSchema getGraphQLSchema()

getFragmentsByName

public java.util.Map<java.lang.String,FragmentDefinition> getFragmentsByName()

getDocument

public Document getDocument()

getOperationDefinition

public OperationDefinition getOperationDefinition()

getVariables

@Deprecated(since="2022-05-24")
public java.util.Map<java.lang.String,java.lang.Object> getVariables()

Deprecated.

use getCoercedVariables() instead

Returns:

map of coerced variables

getCoercedVariables

public CoercedVariables getCoercedVariables()

getContext

@Deprecated(since="2021-07-05")
public <T> T getContext()

Deprecated.

use getGraphQLContext() instead

Type Parameters:

T - for two

Returns:

the legacy context

getGraphQLContext

public GraphQLContext getGraphQLContext()

getLocalContext

public <T> T getLocalContext()

getRoot

public <T> T getRoot()

getFragment

public FragmentDefinition getFragment(java.lang.String name)

getDataLoaderRegistry

public org.dataloader.DataLoaderRegistry getDataLoaderRegistry()

getLocale

public java.util.Locale getLocale()

getValueUnboxer

public ValueUnboxer getValueUnboxer()

addError

public void addError(GraphQLError error,
                     ResultPath fieldPath)

This method will only put one error per field path.

Parameters:

error - the error to add

fieldPath - the field path to put it under

addError

public void addError(GraphQLError error)

This method will allow you to add errors into the running execution context, without a check for per field unique-ness

Parameters:

error - the error to add

addErrors

public void addErrors(java.util.List<GraphQLError> errors)

This method will allow you to add errors into the running execution context, without a check for per field unique-ness

Parameters:

errors - the errors to add

getErrors

public java.util.List<GraphQLError> getErrors()

Returns:

the total list of errors for this execution context

getQueryStrategy

public ExecutionStrategy getQueryStrategy()

getMutationStrategy

public ExecutionStrategy getMutationStrategy()

getSubscriptionStrategy

public ExecutionStrategy getSubscriptionStrategy()

getIncrementalCallState

public IncrementalCallState getIncrementalCallState()

getStrategy

public ExecutionStrategy getStrategy(OperationDefinition.Operation operation)

getNormalizedQueryTree

public java.util.function.Supplier<ExecutableNormalizedOperation> getNormalizedQueryTree()

setDataLoaderDispatcherStrategy

public void setDataLoaderDispatcherStrategy(DataLoaderDispatchStrategy dataLoaderDispatcherStrategy)

getDataLoaderDispatcherStrategy

public DataLoaderDispatchStrategy getDataLoaderDispatcherStrategy()

transform

public ExecutionContext transform(java.util.function.Consumer<ExecutionContextBuilder> builderConsumer)

This helps you transform the current ExecutionContext object into another one by starting a builder with all the current values and allows you to transform it how you want.

Parameters:

builderConsumer - the consumer code that will be given a builder to transform

Returns:

a new ExecutionContext object based on calling build on that builder