graphql.servlet.context

Enum ContextSetting

java.lang.Object

java.lang.Enum<ContextSetting>

graphql.servlet.context.ContextSetting

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ContextSetting>

public enum ContextSetting
extends java.lang.Enum<ContextSetting>

An enum representing possible context settings. These are modeled after Apollo's link settings.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PER_QUERY_WITH_INSTRUMENTATION Each GraphQL execution should always have its own context.
PER_QUERY_WITHOUT_INSTRUMENTATION
PER_REQUEST_WITH_INSTRUMENTATION A context object, and therefor dataloader registry and subject, should be shared between all GraphQL executions in a http request.
PER_REQUEST_WITHOUT_INSTRUMENTATION

Method Summary

Modifier and Type	Method and Description
java.util.function.Supplier<graphql.execution.instrumentation.Instrumentation>	configureInstrumentationForContext(java.util.function.Supplier<graphql.execution.instrumentation.Instrumentation> instrumentation, java.util.List<graphql.ExecutionInput> executionInputs, graphql.execution.instrumentation.dataloader.DataLoaderDispatcherInstrumentationOptions options) Augments the provided instrumentation supplier to also supply the correct dispatching instrumentation.
GraphQLBatchedInvocationInput	getBatch(java.util.List<GraphQLRequest> requests, graphql.schema.GraphQLSchema schema, java.util.function.Supplier<GraphQLContext> contextSupplier, java.lang.Object root) Creates a set of inputs with the correct context based on the setting.
static ContextSetting	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ContextSetting[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PER_REQUEST_WITH_INSTRUMENTATION

public static final ContextSetting PER_REQUEST_WITH_INSTRUMENTATION

A context object, and therefor dataloader registry and subject, should be shared between all GraphQL executions in a http request.

PER_REQUEST_WITHOUT_INSTRUMENTATION

public static final ContextSetting PER_REQUEST_WITHOUT_INSTRUMENTATION

PER_QUERY_WITH_INSTRUMENTATION

public static final ContextSetting PER_QUERY_WITH_INSTRUMENTATION

Each GraphQL execution should always have its own context.

PER_QUERY_WITHOUT_INSTRUMENTATION

public static final ContextSetting PER_QUERY_WITHOUT_INSTRUMENTATION

Method Detail

values

public static ContextSetting[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ContextSetting c : ContextSetting.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ContextSetting valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getBatch

public GraphQLBatchedInvocationInput getBatch(java.util.List<GraphQLRequest> requests,
                                              graphql.schema.GraphQLSchema schema,
                                              java.util.function.Supplier<GraphQLContext> contextSupplier,
                                              java.lang.Object root)

Creates a set of inputs with the correct context based on the setting.

Parameters:

requests - the GraphQL requests to execute.

schema - the GraphQL schema to execute the requests against.

contextSupplier - method that returns the context to use for each execution or for the request as a whole.

root - the root object to use for each execution.

Returns:

a configured batch input.

configureInstrumentationForContext

public java.util.function.Supplier<graphql.execution.instrumentation.Instrumentation> configureInstrumentationForContext(java.util.function.Supplier<graphql.execution.instrumentation.Instrumentation> instrumentation,
                                                                                                                         java.util.List<graphql.ExecutionInput> executionInputs,
                                                                                                                         graphql.execution.instrumentation.dataloader.DataLoaderDispatcherInstrumentationOptions options)

Augments the provided instrumentation supplier to also supply the correct dispatching instrumentation.

Parameters:

instrumentation - the instrumentation supplier to augment

executionInputs - the inputs that will be dispatched by the instrumentation

options - the DataLoader dispatching instrumentation options that will be used.

Returns:

augmented instrumentation supplier.