graphql.analysis

Class MaxQueryComplexityInstrumentation

java.lang.Object

graphql.execution.instrumentation.SimplePerformantInstrumentation

graphql.analysis.MaxQueryComplexityInstrumentation

All Implemented Interfaces:

Instrumentation

@PublicApi
public class MaxQueryComplexityInstrumentation
extends SimplePerformantInstrumentation

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

Use the Function<QueryComplexityInfo, Boolean> parameter to supply a function to perform a custom action when the max complexity is exceeded. If the function returns true a AbortExecutionException is thrown.

Field Summary

Fields inherited from class graphql.execution.instrumentation.SimplePerformantInstrumentation

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
MaxQueryComplexityInstrumentation(int maxComplexity, FieldComplexityCalculator fieldComplexityCalculator, java.util.function.Function<QueryComplexityInfo,java.lang.Boolean> maxQueryComplexityExceededFunction) new Instrumentation with custom complexity calculator
MaxQueryComplexityInstrumentation(int maxComplexity, java.util.function.Function<QueryComplexityInfo,java.lang.Boolean> maxQueryComplexityExceededFunction) new Instrumentation with default complexity calculator which is `1 + childComplexity`

Method Summary

Modifier and Type	Method and Description
@Nullable InstrumentationContext<ExecutionResult>	beginExecuteOperation(InstrumentationExecuteOperationParameters instrumentationExecuteOperationParameters, InstrumentationState rawState) This is called just before the execution of the query operation is started.
@Nullable InstrumentationContext<java.util.List<ValidationError>>	beginValidation(InstrumentationValidationParameters parameters, InstrumentationState rawState) This is called just before the parsed query document is validated.
InstrumentationState	createState(InstrumentationCreateStateParameters parameters) 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
protected AbortExecutionException	mkAbortException(int totalComplexity, int maxComplexity) Called to generate your own error message or custom exception class

Methods inherited from class graphql.execution.instrumentation.SimplePerformantInstrumentation

beginExecuteOperation, beginExecution, beginExecution, beginExecutionStrategy, beginExecutionStrategy, beginField, beginField, beginFieldComplete, beginFieldComplete, beginFieldFetch, beginFieldFetch, beginFieldListComplete, beginFieldListComplete, beginParse, beginParse, beginSubscribedFieldEvent, beginSubscribedFieldEvent, beginValidation, createState, instrumentDataFetcher, instrumentDataFetcher, instrumentDocumentAndVariables, instrumentDocumentAndVariables, instrumentExecutionContext, instrumentExecutionContext, instrumentExecutionInput, instrumentExecutionInput, instrumentExecutionResult, instrumentExecutionResult, instrumentSchema, instrumentSchema

Methods inherited from class java.lang.Object

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

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,
                                         java.util.function.Function<QueryComplexityInfo,java.lang.Boolean> maxQueryComplexityExceededFunction)

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

Parameters:

maxComplexity - max allowed complexity, otherwise execution will be aborted

maxQueryComplexityExceededFunction - the function to perform when the max complexity is exceeded

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

MaxQueryComplexityInstrumentation

public MaxQueryComplexityInstrumentation(int maxComplexity,
                                         FieldComplexityCalculator fieldComplexityCalculator,
                                         java.util.function.Function<QueryComplexityInfo,java.lang.Boolean> maxQueryComplexityExceededFunction)

new Instrumentation with custom complexity calculator

Parameters:

maxComplexity - max allowed complexity, otherwise execution will be aborted

fieldComplexityCalculator - custom complexity calculator

maxQueryComplexityExceededFunction - the function to perform when the max complexity is exceeded

Method Detail

createState

public InstrumentationState createState(InstrumentationCreateStateParameters parameters)

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

Overrides:

createState in class SimplePerformantInstrumentation

Parameters:

parameters - the parameters to this step

Returns:

a state object that is passed to each method

beginValidation

@Nullable
public @Nullable InstrumentationContext<java.util.List<ValidationError>> beginValidation(InstrumentationValidationParameters parameters,
                                                                                                   InstrumentationState rawState)

Description copied from interface: Instrumentation

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

Specified by:

beginValidation in interface Instrumentation

Overrides:

beginValidation in class SimplePerformantInstrumentation

Parameters:

parameters - the parameters to this step

rawState - the state created during the call to Instrumentation.createState(InstrumentationCreateStateParameters)

Returns:

a nullable InstrumentationContext object that will be called back when the step ends (assuming it's not null)

beginExecuteOperation

@Nullable
public @Nullable InstrumentationContext<ExecutionResult> beginExecuteOperation(InstrumentationExecuteOperationParameters instrumentationExecuteOperationParameters,
                                                                                         InstrumentationState rawState)

Description copied from interface: Instrumentation

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

Specified by:

beginExecuteOperation in interface Instrumentation

Overrides:

beginExecuteOperation in class SimplePerformantInstrumentation

Parameters:

instrumentationExecuteOperationParameters - the parameters to this step

rawState - the state created during the call to Instrumentation.createState(InstrumentationCreateStateParameters)

Returns:

a nullable InstrumentationContext object that will be called back when the step ends (assuming it's not null)

mkAbortException

protected AbortExecutionException mkAbortException(int totalComplexity,
                                                   int maxComplexity)

Called to generate your own error message or custom exception class

Parameters:

totalComplexity - the complexity of the query

maxComplexity - the maximum complexity allowed

Returns:

an instance of AbortExecutionException