graphql.analysis

Class MaxQueryComplexityInstrumentation

java.lang.Object

graphql.execution.instrumentation.NoOpInstrumentation

graphql.analysis.MaxQueryComplexityInstrumentation

All Implemented Interfaces:

Instrumentation

@PublicApi
public class MaxQueryComplexityInstrumentation
extends NoOpInstrumentation

Prevents execution if the query complexity is greater than the specified maxComplexity

Nested Class Summary

Nested classes/interfaces inherited from class graphql.execution.instrumentation.NoOpInstrumentation

NoOpInstrumentation.NoOpInstrumentationContext<T>

Field Summary

Fields inherited from class graphql.execution.instrumentation.NoOpInstrumentation

INSTANCE

Constructor Summary

Constructors

Constructor and Description
MaxQueryComplexityInstrumentation(int maxComplexity) new Instrumentation with default complexity calculator which is `1 + childComplexity`
MaxQueryComplexityInstrumentation(int maxComplexity, FieldComplexityCalculator fieldComplexityCalculator) new Instrumentation with custom complexity calculator

Method Summary

Modifier and Type	Method and Description
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 graphql.execution.instrumentation.NoOpInstrumentation

beginDataFetch, beginExecution, beginExecutionStrategy, beginField, beginFieldFetch, beginParse

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

Constructor Detail

MaxQueryComplexityInstrumentation

public MaxQueryComplexityInstrumentation(int maxComplexity)

new Instrumentation with default complexity calculator which is `1 + childComplexity`

Parameters:

maxComplexity - max allowed complexity, otherwise execution will be aborted

MaxQueryComplexityInstrumentation

public MaxQueryComplexityInstrumentation(int maxComplexity,
                                         FieldComplexityCalculator fieldComplexityCalculator)

new Instrumentation with custom complexity calculator

Parameters:

maxComplexity - max allowed complexity, otherwise execution will be aborted

fieldComplexityCalculator - custom complexity calculator

Method Detail

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

Overrides:

beginValidation in class NoOpInstrumentation

Parameters:

parameters - the parameters to this step

Returns:

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