graphql.execution.instrumentation

Class NoOpInstrumentation

java.lang.Object

graphql.execution.instrumentation.NoOpInstrumentation

All Implemented Interfaces:

Instrumentation

Direct Known Subclasses:

MaxQueryComplexityInstrumentation, MaxQueryDepthInstrumentation

@PublicApi
public class NoOpInstrumentation
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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NoOpInstrumentation.NoOpInstrumentationContext<T>

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
NoOpInstrumentation()

Method Summary

Modifier and Type	Method and Description
InstrumentationContext<ExecutionResult>	beginDataFetch(InstrumentationDataFetchParameters parameters) This is called just before the data fetch is started and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
InstrumentationContext<ExecutionResult>	beginExecution(InstrumentationExecutionParameters parameters) This is called just before a query is executed and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
InstrumentationContext<java.util.concurrent.CompletableFuture<ExecutionResult>>	beginExecutionStrategy(InstrumentationExecutionStrategyParameters parameters) This is called each time the ExecutionStrategy is invoked and when the CompletableFuture has been dispatched for the query fields the InstrumentationContext.onEnd(Object, Throwable) is called.
InstrumentationContext<ExecutionResult>	beginField(InstrumentationFieldParameters parameters) This is called just before a field is resolved and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
InstrumentationContext<java.lang.Object>	beginFieldFetch(InstrumentationFieldFetchParameters parameters) This is called just before a field DataFetcher is invoked and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
InstrumentationContext<Document>	beginParse(InstrumentationExecutionParameters parameters) This is called just before a query is parsed and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
InstrumentationContext<java.util.List<ValidationError>>	beginValidation(InstrumentationValidationParameters parameters) This is called just before the parsed query Document is validated and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.

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

createState, instrumentDataFetcher, instrumentExecutionResult

Field Detail

INSTANCE

public static final NoOpInstrumentation INSTANCE

A singleton instance of a Instrumentation that does nothing

Constructor Detail

NoOpInstrumentation

public NoOpInstrumentation()

Method Detail

beginExecution

public InstrumentationContext<ExecutionResult> beginExecution(InstrumentationExecutionParameters parameters)

Description copied from interface: Instrumentation

This is called just before a query is executed and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.

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 and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.

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 and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.

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 InstrumentationContext<java.util.concurrent.CompletableFuture<ExecutionResult>> beginExecutionStrategy(InstrumentationExecutionStrategyParameters parameters)

Description copied from interface: Instrumentation

This is called each time the ExecutionStrategy is invoked and when the CompletableFuture has been dispatched for the query fields the InstrumentationContext.onEnd(Object, Throwable) is called. Note because the execution strategy execution is asynchronous, the query data is not guaranteed to be completed when this step finishes. It is however a chance to dispatch side effects that might cause asynchronous data fetching code to actually run or attach CompletableFuture handlers onto the result via Instrumentation.

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

beginDataFetch

public InstrumentationContext<ExecutionResult> beginDataFetch(InstrumentationDataFetchParameters parameters)

Description copied from interface: Instrumentation

This is called just before the data fetch is started and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.

Specified by:

beginDataFetch 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 and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.

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 and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.

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