Package graphql.normalized

Class ExecutableNormalizedOperationFactory.Options

java.lang.Object

graphql.normalized.ExecutableNormalizedOperationFactory.Options

Enclosing class:

ExecutableNormalizedOperationFactory

public static class ExecutableNormalizedOperationFactory.Options
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAX_FIELDS_COUNT	The default max fields count is 100,000.

Method Summary

Modifier and Type	Method	Description
static ExecutableNormalizedOperationFactory.Options	defaultOptions()	Returns the default options used when creating instances of ExecutableNormalizedOperation.
ExecutableNormalizedOperationFactory.Options	deferSupport(boolean deferSupport)	Controls whether defer execution is supported when creating instances of ExecutableNormalizedOperation.
boolean	getDeferSupport()
GraphQLContext	getGraphQLContext()
Locale	getLocale()
int	getMaxChildrenDepth()
int	getMaxFieldsCount()
ExecutableNormalizedOperationFactory.Options	graphQLContext(GraphQLContext graphQLContext)	Context object to use when parsing the operation.
ExecutableNormalizedOperationFactory.Options	locale(Locale locale)	Locale to use when parsing the query.
ExecutableNormalizedOperationFactory.Options	maxChildrenDepth(int maxChildrenDepth)	Controls the maximum depth of the operation.
ExecutableNormalizedOperationFactory.Options	maxFieldsCount(int maxFieldsCount)	Controls the maximum number of ENFs created.
static void	setDefaultOptions(ExecutableNormalizedOperationFactory.Options options)	Sets new default Options used when creating instances of ExecutableNormalizedOperation.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_MAX_FIELDS_COUNT

public static final int DEFAULT_MAX_FIELDS_COUNT

The default max fields count is 100,000. This is big enough for even very large queries, but can be changed via {#setDefaultOptions

See Also:

• Constant Field Values

Method Details

setDefaultOptions

public static void setDefaultOptions(ExecutableNormalizedOperationFactory.Options options)

Sets new default Options used when creating instances of ExecutableNormalizedOperation.

Parameters:

options - new default options

defaultOptions

public static ExecutableNormalizedOperationFactory.Options defaultOptions()

Returns the default options used when creating instances of ExecutableNormalizedOperation.

Returns:

the default options

locale

public ExecutableNormalizedOperationFactory.Options locale(Locale locale)

Locale to use when parsing the query.

e.g. can be passed to Coercing for parsing.

Parameters:

locale - the locale to use

Returns:

new options object to use

graphQLContext

public ExecutableNormalizedOperationFactory.Options graphQLContext(GraphQLContext graphQLContext)

Context object to use when parsing the operation.

Can be used to intercept input values e.g. using InputInterceptor.

Parameters:

graphQLContext - the context to use

Returns:

new options object to use

maxChildrenDepth

public ExecutableNormalizedOperationFactory.Options maxChildrenDepth(int maxChildrenDepth)

Controls the maximum depth of the operation. Can be used to prevent against malicious operations.

Parameters:

maxChildrenDepth - the max depth

Returns:

new options object to use

maxFieldsCount

public ExecutableNormalizedOperationFactory.Options maxFieldsCount(int maxFieldsCount)

Controls the maximum number of ENFs created. Can be used to prevent against malicious operations.

Parameters:

maxFieldsCount - the max number of ENFs created

Returns:

new options object to use

deferSupport

@ExperimentalApi
public ExecutableNormalizedOperationFactory.Options deferSupport(boolean deferSupport)

Controls whether defer execution is supported when creating instances of ExecutableNormalizedOperation.

Parameters:

deferSupport - true to enable support for defer

Returns:

new options object to use

getGraphQLContext

public GraphQLContext getGraphQLContext()

Returns:

context to use during operation parsing

See Also:

• graphQLContext(GraphQLContext)

getLocale

public Locale getLocale()

Returns:

locale to use during operation parsing

See Also:

• locale(Locale)

getMaxChildrenDepth

public int getMaxChildrenDepth()

Returns:

maximum children depth before aborting parsing

See Also:

• maxChildrenDepth(int)

getMaxFieldsCount

public int getMaxFieldsCount()

getDeferSupport

@ExperimentalApi
public boolean getDeferSupport()

Returns:

whether support for defer is enabled

See Also:

• deferSupport(boolean)