ChainedInstrumentation (graphql-java 7.0 API)

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

All Implemented Interfaces:

Instrumentation
```
@PublicApi
public class ChainedInstrumentation
extends java.lang.Object
implements Instrumentation
```
This allows you to chain together a number of Instrumentation implementations and run them in sequence. The list order of instrumentation objects is always guaranteed to be followed and the InstrumentationState objects they create will be passed back to the originating implementation.

See Also:

Instrumentation

Constructor Summary

Constructors
Constructor and Description

ChainedInstrumentation(java.util.List<Instrumentation> instrumentations)

Constructors
Constructor and Description
`ChainedInstrumentation(java.util.List<Instrumentation> instrumentations)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InstrumentationContext<java.util.concurrent.CompletableFuture<ExecutionResult>>`	`beginCompleteField(InstrumentationFieldCompleteParameters parameters)` This is called just before the complete field is started 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>>`	`beginCompleteFieldList(InstrumentationFieldCompleteParameters parameters)` This is called just before the complete field list is started and when this step finishes the `InstrumentationContext.onEnd(Object, Throwable)` will be called indicating that the step has finished.
`InstrumentationContext<ExecutionResult>`	`beginDataFetch(InstrumentationDataFetchParameters parameters)` This is called just before the data fetching stage is started, waits for all data to be completed 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>>`	`beginDataFetchDispatch(InstrumentationDataFetchParameters parameters)` This is called just before the data fetching stage is started and finishes as soon as the query is dispatched ready for completion.
`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<java.util.Map<java.lang.String,java.util.List<Field>>>`	`beginFields(InstrumentationExecutionStrategyParameters parameters)` This is called just before a selection set of fields is resolved 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.
`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.
`ExecutionInput`	`instrumentExecutionInput(ExecutionInput executionInput, InstrumentationExecutionParameters parameters)` This is called to instrument a `ExecutionInput` before it is used to parse, validate and execute a query, allowing you to adjust what query input parameters are 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

- Constructor Detail
  - ChainedInstrumentation
```
public ChainedInstrumentation(java.util.List<Instrumentation> instrumentations)
```
- 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 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
  - beginDataFetch
```
public InstrumentationContext<ExecutionResult> beginDataFetch(InstrumentationDataFetchParameters parameters)
```
    Description copied from interface: Instrumentation
    
    This is called just before the data fetching stage is started, waits for all data to be completed 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
  - 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
  - beginDataFetchDispatch
```
public InstrumentationContext<java.util.concurrent.CompletableFuture<ExecutionResult>> beginDataFetchDispatch(InstrumentationDataFetchParameters parameters)
```
    Description copied from interface: Instrumentation
    
    This is called just before the data fetching stage is started and finishes as soon as the query is dispatched ready for completion. This is different to Instrumentation.beginDataFetch(graphql.execution.instrumentation.parameters.InstrumentationDataFetchParameters) in that this step does not wait for the values to be completed, only dispatched for completion.
    
    Specified by:
    
    beginDataFetchDispatch 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
  - beginFields
```
public InstrumentationContext<java.util.Map<java.lang.String,java.util.List<Field>>> beginFields(InstrumentationExecutionStrategyParameters parameters)
```
    Description copied from interface: Instrumentation
    
    This is called just before a selection set of fields is resolved and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
    
    Specified by:
    
    beginFields 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
  - beginCompleteField
```
public InstrumentationContext<java.util.concurrent.CompletableFuture<ExecutionResult>> beginCompleteField(InstrumentationFieldCompleteParameters parameters)
```
    Description copied from interface: Instrumentation
    
    This is called just before the complete field is started and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
    
    Specified by:
    
    beginCompleteField 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
  - beginCompleteFieldList
```
public InstrumentationContext<java.util.concurrent.CompletableFuture<ExecutionResult>> beginCompleteFieldList(InstrumentationFieldCompleteParameters parameters)
```
    Description copied from interface: Instrumentation
    
    This is called just before the complete field list is started and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
    
    Specified by:
    
    beginCompleteFieldList 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
  - instrumentExecutionInput
```
public ExecutionInput instrumentExecutionInput(ExecutionInput executionInput,
                                               InstrumentationExecutionParameters parameters)
```
    Description copied from interface: Instrumentation
    
    This is called to instrument a ExecutionInput before it is used to parse, validate and execute a query, allowing you to adjust what query input parameters are used
    
    Specified by:
    
    instrumentExecutionInput in interface Instrumentation
    
    Parameters:
    
    executionInput - the execution input to be used
    
    parameters - the parameters describing the field to be fetched
    
    Returns:
    
    a non null instrumented ExecutionInput, the default is to return to the same object
  - 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 ChainedInstrumentation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChainedInstrumentation

Method Detail

createState

beginExecution

beginParse

beginValidation

beginDataFetch

beginExecutionStrategy

beginDataFetchDispatch

beginFields

beginField

beginFieldFetch

beginCompleteField

beginCompleteFieldList

instrumentExecutionInput

instrumentSchema

instrumentExecutionContext

instrumentDataFetcher

instrumentExecutionResult