graphql.execution.instrumentation

Class SimpleInstrumentation

java.lang.Object

graphql.execution.instrumentation.SimpleInstrumentation

All Implemented Interfaces:

Instrumentation

Direct Known Subclasses:

DataLoaderDispatcherInstrumentation, ExecutorInstrumentation, FieldValidationInstrumentation, MaxQueryComplexityInstrumentation, MaxQueryDepthInstrumentation, TracingInstrumentation

@PublicApi
public class SimpleInstrumentation
extends java.lang.Object
implements Instrumentation

An implementation of Instrumentation that does nothing. It can be used as a base for derived classes where you only implement the methods you want to

Field Summary

Fields

Modifier and Type	Field and Description
static SimpleInstrumentation	INSTANCE A singleton instance of a Instrumentation that does nothing

Constructor Summary

Constructors

Constructor and Description
SimpleInstrumentation()

Method Summary

Modifier and Type	Method and Description
InstrumentationContext<ExecutionResult>	beginExecuteOperation(InstrumentationExecuteOperationParameters parameters) This is called just before the execution of the query operation is started.
InstrumentationContext<ExecutionResult>	beginExecution(InstrumentationExecutionParameters parameters) This is called right at the start of query execution and its the first step in the instrumentation chain.
ExecutionStrategyInstrumentationContext	beginExecutionStrategy(InstrumentationExecutionStrategyParameters parameters) This is called each time an ExecutionStrategy is invoked, which may be multiple times per query as the engine recursively descends down over the query.
InstrumentationContext<ExecutionResult>	beginField(InstrumentationFieldParameters parameters) This is called just before a field is resolved into a value.
InstrumentationContext<java.lang.Object>	beginFieldFetch(InstrumentationFieldFetchParameters parameters) This is called just before a field DataFetcher is invoked.
InstrumentationContext<Document>	beginParse(InstrumentationExecutionParameters parameters) This is called just before a query is parsed.
InstrumentationContext<java.util.List<ValidationError>>	beginValidation(InstrumentationValidationParameters parameters) This is called just before the parsed query document is validated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface graphql.execution.instrumentation.Instrumentation

beginFieldComplete, beginFieldListComplete, beginSubscribedFieldEvent, createState, createState, instrumentDataFetcher, instrumentDocumentAndVariables, instrumentExecutionContext, instrumentExecutionInput, instrumentExecutionResult, instrumentSchema

Field Detail

INSTANCE

public static final SimpleInstrumentation INSTANCE

A singleton instance of a Instrumentation that does nothing

Constructor Detail

SimpleInstrumentation

public SimpleInstrumentation()

Method Detail

beginExecution

public InstrumentationContext<ExecutionResult> beginExecution(InstrumentationExecutionParameters parameters)

Description copied from interface: Instrumentation

This is called right at the start of query execution and its the first step in the instrumentation chain.

Specified by:

beginExecution in interface Instrumentation

Parameters:

parameters - the parameters to this step

Returns:

a non null InstrumentationContext object that will be called back when the step ends

beginParse

public InstrumentationContext<Document> beginParse(InstrumentationExecutionParameters parameters)

Description copied from interface: Instrumentation

This is called just before a query is parsed.

Specified by:

beginParse in interface Instrumentation

Parameters:

parameters - the parameters to this step

Returns:

a non null InstrumentationContext object that will be called back when the step ends

beginValidation

public InstrumentationContext<java.util.List<ValidationError>> beginValidation(InstrumentationValidationParameters parameters)

Description copied from interface: Instrumentation

This is called just before the parsed query document is validated.

Specified by:

beginValidation in interface Instrumentation

Parameters:

parameters - the parameters to this step

Returns:

a non null InstrumentationContext object that will be called back when the step ends

beginExecutionStrategy

public ExecutionStrategyInstrumentationContext beginExecutionStrategy(InstrumentationExecutionStrategyParameters parameters)

Description copied from interface: Instrumentation

This is called each time an ExecutionStrategy is invoked, which may be multiple times per query as the engine recursively descends down over the query.

Specified by:

beginExecutionStrategy in interface Instrumentation

Parameters:

parameters - the parameters to this step

Returns:

a non null InstrumentationContext object that will be called back when the step ends

beginExecuteOperation

public InstrumentationContext<ExecutionResult> beginExecuteOperation(InstrumentationExecuteOperationParameters parameters)

Description copied from interface: Instrumentation

This is called just before the execution of the query operation is started.

Specified by:

beginExecuteOperation in interface Instrumentation

Parameters:

parameters - the parameters to this step

Returns:

a non null InstrumentationContext object that will be called back when the step ends

beginField

public InstrumentationContext<ExecutionResult> beginField(InstrumentationFieldParameters parameters)

Description copied from interface: Instrumentation

This is called just before a field is resolved into a value.

Specified by:

beginField in interface Instrumentation

Parameters:

parameters - the parameters to this step

Returns:

a non null InstrumentationContext object that will be called back when the step ends

beginFieldFetch

public InstrumentationContext<java.lang.Object> beginFieldFetch(InstrumentationFieldFetchParameters parameters)

Description copied from interface: Instrumentation

This is called just before a field DataFetcher is invoked.

Specified by:

beginFieldFetch in interface Instrumentation

Parameters:

parameters - the parameters to this step

Returns:

a non null InstrumentationContext object that will be called back when the step ends