com.apollographql.federation.graphqljava.caching

Class CacheControlInstrumentation

java.lang.Object

graphql.execution.instrumentation.SimpleInstrumentation

com.apollographql.federation.graphqljava.caching.CacheControlInstrumentation

All Implemented Interfaces:

graphql.execution.instrumentation.Instrumentation

public class CacheControlInstrumentation
extends graphql.execution.instrumentation.SimpleInstrumentation

A GraphQL Java Instrumentation that computes a max age for an operation based on @cacheControl directives.

You can retrieve the "max-age=..." header value with a GraphQLContext: String cacheControlHeader = CacheControlInstrumentation.cacheControlContext(context);

See https://www.apollographql.com/docs/apollo-server/performance/caching/ and the original implementation at https://github.com/apollographql/apollo-server/blob/main/packages/apollo-server-core/src/plugin/cacheControl/index.ts

Field Summary

Fields inherited from class graphql.execution.instrumentation.SimpleInstrumentation

INSTANCE

Constructor Summary

Constructors

Constructor and Description
CacheControlInstrumentation()
CacheControlInstrumentation(int defaultMaxAge)

Method Summary

Modifier and Type	Method and Description
graphql.execution.instrumentation.InstrumentationContext<graphql.ExecutionResult>	beginExecution(graphql.execution.instrumentation.parameters.InstrumentationExecutionParameters parameters)
graphql.execution.instrumentation.InstrumentationContext<graphql.ExecutionResult>	beginField(graphql.execution.instrumentation.parameters.InstrumentationFieldParameters parameters)
static @Nullable java.lang.String	cacheControlHeaderFromGraphQLContext(graphql.GraphQLContext context)
graphql.execution.instrumentation.InstrumentationState	createState()

Methods inherited from class graphql.execution.instrumentation.SimpleInstrumentation

beginExecuteOperation, beginExecutionStrategy, beginFieldFetch, beginParse, beginValidation

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

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

Constructor Detail

CacheControlInstrumentation

public CacheControlInstrumentation()

CacheControlInstrumentation

public CacheControlInstrumentation(int defaultMaxAge)

Method Detail

cacheControlHeaderFromGraphQLContext

@Nullable
public static @Nullable java.lang.String cacheControlHeaderFromGraphQLContext(graphql.GraphQLContext context)

createState

public graphql.execution.instrumentation.InstrumentationState createState()

beginExecution

public graphql.execution.instrumentation.InstrumentationContext<graphql.ExecutionResult> beginExecution(graphql.execution.instrumentation.parameters.InstrumentationExecutionParameters parameters)

Specified by:

beginExecution in interface graphql.execution.instrumentation.Instrumentation

Overrides:

beginExecution in class graphql.execution.instrumentation.SimpleInstrumentation

beginField

public graphql.execution.instrumentation.InstrumentationContext<graphql.ExecutionResult> beginField(graphql.execution.instrumentation.parameters.InstrumentationFieldParameters parameters)

Specified by:

beginField in interface graphql.execution.instrumentation.Instrumentation

Overrides:

beginField in class graphql.execution.instrumentation.SimpleInstrumentation