Class MaxQueryDepthInstrumentation

java.lang.Object

graphql.execution.instrumentation.SimplePerformantInstrumentation

graphql.analysis.MaxQueryDepthInstrumentation

All Implemented Interfaces:

Instrumentation

@PublicApi
public class MaxQueryDepthInstrumentation
extends SimplePerformantInstrumentation

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

Modifier and Type	Field	Description
private static final org.slf4j.Logger	log
private final int	maxDepth
private final Function<QueryDepthInfo, Boolean>	maxQueryDepthExceededFunction

Fields inherited from class SimplePerformantInstrumentation

INSTANCE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
@Nullable InstrumentationContext<ExecutionResult>	beginExecuteOperation(InstrumentationExecuteOperationParameters parameters, InstrumentationState state)	This is called just before the execution of the query operation is started.
private int	getPathLength(QueryVisitorFieldEnvironment path)
protected AbortExecutionException	mkAbortException(int depth, int maxDepth)	Called to generate your own error message or custom exception class
(package private) QueryTraverser	newQueryTraverser(ExecutionContext executionContext)

Methods inherited from class SimplePerformantInstrumentation

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

Methods inherited from class Object

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

Field Details

log

private static final org.slf4j.Logger log

maxDepth

private final int maxDepth

maxQueryDepthExceededFunction

private final Function<QueryDepthInfo, Boolean> maxQueryDepthExceededFunction

Constructor Details

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,
 Function<QueryDepthInfo, 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 Details

beginExecuteOperation

@Nullable
public @Nullable InstrumentationContext<ExecutionResult> beginExecuteOperation(InstrumentationExecuteOperationParameters parameters,
 InstrumentationState state)

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:

parameters - the parameters to this step

state - 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 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:

an instance of AbortExecutionException

newQueryTraverser

QueryTraverser newQueryTraverser(ExecutionContext executionContext)

getPathLength

private int getPathLength(QueryVisitorFieldEnvironment path)