Class ExecutionContext

java.lang.Object

graphql.execution.ExecutionContext

@PublicApi
public class ExecutionContext
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private final CoercedVariables	coercedVariables
private final Object	context
private final org.dataloader.DataLoaderRegistry	dataLoaderRegistry
private final Document	document
private final Set<ResultPath>	errorPaths
private final AtomicReference<com.google.common.collect.ImmutableList<GraphQLError>>	errors
private final LockKit.ReentrantLock	errorsLock
private final ExecutionId	executionId
private final ExecutionInput	executionInput
private final com.google.common.collect.ImmutableMap<String, FragmentDefinition>	fragmentsByName
private final GraphQLContext	graphQLContext
private final GraphQLSchema	graphQLSchema
private final Instrumentation	instrumentation
private final InstrumentationState	instrumentationState
private final Object	localContext
private final Locale	locale
private final ExecutionStrategy	mutationStrategy
private final OperationDefinition	operationDefinition
private final ExecutionStrategy	queryStrategy
private final Supplier<ExecutableNormalizedOperation>	queryTree
private final ResultNodesInfo	resultNodesInfo
private final Object	root
private final ExecutionStrategy	subscriptionStrategy
private final ValueUnboxer	valueUnboxer

Constructor Summary

Constructors

Constructor	Description
ExecutionContext(ExecutionContextBuilder builder)

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(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
org.dataloader.DataLoaderRegistry	getDataLoaderRegistry()
Document	getDocument()
List<GraphQLError>	getErrors()
ExecutionId	getExecutionId()
ExecutionInput	getExecutionInput()
FragmentDefinition	getFragment(String name)
Map<String, FragmentDefinition>	getFragmentsByName()
GraphQLContext	getGraphQLContext()
GraphQLSchema	getGraphQLSchema()
Instrumentation	getInstrumentation()
InstrumentationState	getInstrumentationState()
<T> T	getLocalContext()
Locale	getLocale()
ExecutionStrategy	getMutationStrategy()
Supplier<ExecutableNormalizedOperation>	getNormalizedQueryTree()
OperationDefinition	getOperationDefinition()
ExecutionStrategy	getQueryStrategy()
ResultNodesInfo	getResultNodesInfo()
<T> T	getRoot()
ExecutionStrategy	getStrategy(OperationDefinition.Operation operation)
ExecutionStrategy	getSubscriptionStrategy()
ValueUnboxer	getValueUnboxer()
Map<String,Object>	getVariables()	Deprecated. use getCoercedVariables() instead
ExecutionContext	transform(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 Object

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

Field Details

graphQLSchema

private final GraphQLSchema graphQLSchema

executionId

private final ExecutionId executionId

instrumentationState

private final InstrumentationState instrumentationState

queryStrategy

private final ExecutionStrategy queryStrategy

mutationStrategy

private final ExecutionStrategy mutationStrategy

subscriptionStrategy

private final ExecutionStrategy subscriptionStrategy

fragmentsByName

private final com.google.common.collect.ImmutableMap<String, FragmentDefinition> fragmentsByName

operationDefinition

private final OperationDefinition operationDefinition

document

private final Document document

coercedVariables

private final CoercedVariables coercedVariables

root

private final Object root

context

private final Object context

graphQLContext

private final GraphQLContext graphQLContext

localContext

private final Object localContext

instrumentation

private final Instrumentation instrumentation

errors

private final AtomicReference<com.google.common.collect.ImmutableList<GraphQLError>> errors

errorsLock

private final LockKit.ReentrantLock errorsLock

errorPaths

private final Set<ResultPath> errorPaths

dataLoaderRegistry

private final org.dataloader.DataLoaderRegistry dataLoaderRegistry

locale

private final Locale locale

valueUnboxer

private final ValueUnboxer valueUnboxer

executionInput

private final ExecutionInput executionInput

queryTree

private final Supplier<ExecutableNormalizedOperation> queryTree

resultNodesInfo

private final ResultNodesInfo resultNodesInfo

Constructor Details

ExecutionContext

ExecutionContext(ExecutionContextBuilder builder)

Method Details

getExecutionId

public ExecutionId getExecutionId()

getExecutionInput

public ExecutionInput getExecutionInput()

getInstrumentationState

public InstrumentationState getInstrumentationState()

getInstrumentation

public Instrumentation getInstrumentation()

getGraphQLSchema

public GraphQLSchema getGraphQLSchema()

getFragmentsByName

public Map<String, FragmentDefinition> getFragmentsByName()

getDocument

public Document getDocument()

getOperationDefinition

public OperationDefinition getOperationDefinition()

getVariables

@Deprecated
public Map<String,Object> getVariables()

Deprecated.

use getCoercedVariables() instead

Returns:

map of coerced variables

getCoercedVariables

public CoercedVariables getCoercedVariables()

getContext

@Deprecated
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(String name)

getDataLoaderRegistry

public org.dataloader.DataLoaderRegistry getDataLoaderRegistry()

getLocale

public 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(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 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()

getStrategy

public ExecutionStrategy getStrategy(OperationDefinition.Operation operation)

getNormalizedQueryTree

public Supplier<ExecutableNormalizedOperation> getNormalizedQueryTree()

transform

public ExecutionContext transform(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

getResultNodesInfo

public ResultNodesInfo getResultNodesInfo()