SimpleInstrumentation (graphql-java 11.0 API)

java.lang.Object
- graphql.execution.instrumentation.SimpleInstrumentation

All Implemented Interfaces:

Instrumentation

Direct Known Subclasses:

DataLoaderDispatcherInstrumentation, 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

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

Constructors
Constructor and Description
`SimpleInstrumentation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DeferredFieldInstrumentationContext`	`beginDeferredField(InstrumentationDeferredFieldParameters parameters)` This is called just before a deferred field is resolved into a value.
`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<ExecutionResult>`	`beginFieldComplete(InstrumentationFieldCompleteParameters parameters)` This is called just before the complete field is started.
`InstrumentationContext<java.lang.Object>`	`beginFieldFetch(InstrumentationFieldFetchParameters parameters)` This is called just before a field `DataFetcher` is invoked.
`InstrumentationContext<ExecutionResult>`	`beginFieldListComplete(InstrumentationFieldCompleteParameters parameters)` This is called just before the complete field list is started.
`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.
`InstrumentationState`	`createState()` This will be called just before execution to create an object that is given back to all instrumentation methods to allow them to have per execution request state
`DataFetcher<?>`	`instrumentDataFetcher(DataFetcher<?> dataFetcher, InstrumentationFieldFetchParameters parameters)` This is called to instrument a `DataFetcher` just before it is used to fetch a field, allowing you to adjust what information is passed back or record information about specific data fetches.
`ExecutionContext`	`instrumentExecutionContext(ExecutionContext executionContext, InstrumentationExecutionParameters parameters)` This is called to instrument a `ExecutionContext` before it is used to execute a query, allowing you to adjust the base data used.
`java.util.concurrent.CompletableFuture<ExecutionResult>`	`instrumentExecutionResult(ExecutionResult executionResult, InstrumentationExecutionParameters parameters)` This is called to allow instrumentation to instrument the execution result in some way
`GraphQLSchema`	`instrumentSchema(GraphQLSchema schema, InstrumentationExecutionParameters parameters)` This is called to instrument a `GraphQLSchema` before it is used to parse, validate and execute a query, allowing you to adjust what types are used.

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, instrumentExecutionInput

- Field Detail
  - INSTANCE
```
public static final SimpleInstrumentation INSTANCE
```
    A singleton instance of a Instrumentation that does nothing
- Constructor Detail
  - SimpleInstrumentation
```
public SimpleInstrumentation()
```
- Method Detail
  - createState
```
public InstrumentationState createState()
```
    Description copied from interface: Instrumentation
    
    This will be called just before execution to create an object that is given back to all instrumentation methods to allow them to have per execution request state
    
    Specified by:
    
    createState in interface Instrumentation
    
    Returns:
    
    a state object that is passed to each method
  - 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
  - beginDeferredField
```
public DeferredFieldInstrumentationContext beginDeferredField(InstrumentationDeferredFieldParameters parameters)
```
    Description copied from interface: Instrumentation
    
    This is called just before a deferred field is resolved into a value.
    
    Specified by:
    
    beginDeferredField 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
  - beginFieldComplete
```
public InstrumentationContext<ExecutionResult> beginFieldComplete(InstrumentationFieldCompleteParameters parameters)
```
    Description copied from interface: Instrumentation
    
    This is called just before the complete field is started.
    
    Specified by:
    
    beginFieldComplete 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
  - beginFieldListComplete
```
public InstrumentationContext<ExecutionResult> beginFieldListComplete(InstrumentationFieldCompleteParameters parameters)
```
    Description copied from interface: Instrumentation
    
    This is called just before the complete field list is started.
    
    Specified by:
    
    beginFieldListComplete 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
  - instrumentSchema
```
public GraphQLSchema instrumentSchema(GraphQLSchema schema,
                                      InstrumentationExecutionParameters parameters)
```
    Description copied from interface: Instrumentation
    
    This is called to instrument a GraphQLSchema before it is used to parse, validate and execute a query, allowing you to adjust what types are used.
    
    Specified by:
    
    instrumentSchema in interface Instrumentation
    
    Parameters:
    
    schema - the schema to be used
    
    parameters - the parameters describing the field to be fetched
    
    Returns:
    
    a non null instrumented GraphQLSchema, the default is to return to the same object
  - instrumentExecutionContext
```
public ExecutionContext instrumentExecutionContext(ExecutionContext executionContext,
                                                   InstrumentationExecutionParameters parameters)
```
    Description copied from interface: Instrumentation
    
    This is called to instrument a ExecutionContext before it is used to execute a query, allowing you to adjust the base data used.
    
    Specified by:
    
    instrumentExecutionContext in interface Instrumentation
    
    Parameters:
    
    executionContext - the execution context to be used
    
    parameters - the parameters describing the field to be fetched
    
    Returns:
    
    a non null instrumented ExecutionContext, the default is to return to the same object
  - instrumentDataFetcher
```
public DataFetcher<?> instrumentDataFetcher(DataFetcher<?> dataFetcher,
                                            InstrumentationFieldFetchParameters parameters)
```
    Description copied from interface: Instrumentation
    
    This is called to instrument a DataFetcher just before it is used to fetch a field, allowing you to adjust what information is passed back or record information about specific data fetches. Note the same data fetcher instance maybe presented to you many times and that data fetcher implementations widely vary.
    
    Specified by:
    
    instrumentDataFetcher in interface Instrumentation
    
    Parameters:
    
    dataFetcher - the data fetcher about to be used
    
    parameters - the parameters describing the field to be fetched
    
    Returns:
    
    a non null instrumented DataFetcher, the default is to return to the same object
  - instrumentExecutionResult
```
public java.util.concurrent.CompletableFuture<ExecutionResult> instrumentExecutionResult(ExecutionResult executionResult,
                                                                                         InstrumentationExecutionParameters parameters)
```
    Description copied from interface: Instrumentation
    
    This is called to allow instrumentation to instrument the execution result in some way
    
    Specified by:
    
    instrumentExecutionResult in interface Instrumentation
    
    Parameters:
    
    executionResult - CompletableFuture of the result to instrument
    
    parameters - the parameters to this step
    
    Returns:
    
    a new execution result completable future

Class SimpleInstrumentation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface graphql.execution.instrumentation.Instrumentation

Field Detail

INSTANCE

Constructor Detail

SimpleInstrumentation

Method Detail

createState

beginExecution

beginParse

beginValidation

beginExecutionStrategy

beginDeferredField

beginExecuteOperation

beginField

beginFieldFetch

beginFieldComplete

beginFieldListComplete

instrumentSchema

instrumentExecutionContext

instrumentDataFetcher

instrumentExecutionResult