graphql.analysis

Class MaxQueryDepthInstrumentation

java.lang.Object

graphql.execution.instrumentation.SimpleInstrumentation

graphql.analysis.MaxQueryDepthInstrumentation

All Implemented Interfaces:

Instrumentation

@PublicApi
public class MaxQueryDepthInstrumentation
extends SimpleInstrumentation

Prevents execution if the query depth is greater than the specified maxDepth. Use the Function<QueryDepthInfo, Boolean> parameter to supply a function to perform a custom action when the max depth is exceeded. If the function returns true a AbortExecutionException is thrown.

Field Summary

Fields inherited from class graphql.execution.instrumentation.SimpleInstrumentation

INSTANCE

Constructor Summary

Constructors

Constructor and Description
MaxQueryDepthInstrumentation(int maxDepth) Creates a new instrumentation that tracks the query depth.
MaxQueryDepthInstrumentation(int maxDepth, java.util.function.Function<QueryDepthInfo,java.lang.Boolean> maxQueryDepthExceededFunction) Creates a new instrumentation that tracks the query depth.

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.
protected AbortExecutionException	mkAbortException(int depth, int maxDepth) Called to generate your own error message or custom exception class

Methods inherited from class graphql.execution.instrumentation.SimpleInstrumentation

beginDeferredField, beginExecuteOperation, beginExecution, beginExecutionStrategy, beginField, beginFieldComplete, beginFieldFetch, beginFieldListComplete, beginParse, createState, instrumentDataFetcher, instrumentExecutionContext, instrumentExecutionResult, instrumentSchema

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

beginSubscribedFieldEvent, createState, instrumentDocumentAndVariables, instrumentExecutionInput

Constructor Detail

MaxQueryDepthInstrumentation

public MaxQueryDepthInstrumentation(int maxDepth)

Creates a new instrumentation that tracks the query depth.

Parameters:

maxDepth - max allowed depth, otherwise execution will be aborted

MaxQueryDepthInstrumentation

public MaxQueryDepthInstrumentation(int maxDepth,
                                    java.util.function.Function<QueryDepthInfo,java.lang.Boolean> maxQueryDepthExceededFunction)

Creates a new instrumentation that tracks the query depth.

Parameters:

maxDepth - max allowed depth, otherwise execution will be aborted

maxQueryDepthExceededFunction - the function to perform when the max depth is exceeded

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.

Specified by:

beginValidation in interface Instrumentation

Overrides:

beginValidation in class SimpleInstrumentation

Parameters:

parameters - the parameters to this step

Returns:

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

mkAbortException

protected AbortExecutionException mkAbortException(int depth,
                                                   int maxDepth)

Called to generate your own error message or custom exception class

Parameters:

depth - the depth of the query

maxDepth - the maximum depth allowed

Returns:

a instance of AbortExecutionException