Class ApolloPersistedQuerySupport

java.lang.Object

graphql.execution.preparsed.persisted.PersistedQuerySupport

graphql.execution.preparsed.persisted.ApolloPersistedQuerySupport

All Implemented Interfaces:

PreparsedDocumentProvider

@PublicApi
public class ApolloPersistedQuerySupport
extends PersistedQuerySupport

This persisted query support class supports the Apollo scheme where the persisted query id is in ExecutionInput.getExtensions().

You need to provide a PersistedQueryCache cache implementation as the backing cache.

See Apollo Persisted Queries

The Apollo client sends a hash of the persisted query in the input extensions in the following form

    {
     "extensions":{
      "persistedQuery":{
       "version":1,
       "sha256Hash":"fcf31818e50ac3e818ca4bdbc433d6ab73176f0b9d5f9d5ad17e200cdab6fba4"
     }
   }
 }

See Also:

• ExecutionInput.getExtensions()

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	CHECKSUM_TYPE

Fields inherited from class PersistedQuerySupport

PERSISTED_QUERY_MARKER

Constructor Summary

Constructors

Constructor	Description
ApolloPersistedQuerySupport(PersistedQueryCache persistedQueryCache)

Method Summary

Modifier and Type	Method	Description
protected Optional<Object>	getPersistedQueryId(ExecutionInput executionInput)	This method is required for concrete types to work out the query id (often a hash) that should be used to look up the persisted query in the cache.
protected boolean	persistedQueryIdIsInvalid(Object persistedQueryId, String queryText)

Methods inherited from class PersistedQuerySupport

getDocument, mkMissingError

Methods inherited from class Object

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

Methods inherited from interface PreparsedDocumentProvider

getDocumentAsync

Field Details

CHECKSUM_TYPE

private static final String CHECKSUM_TYPE

See Also:

• Constant Field Values

Constructor Details

ApolloPersistedQuerySupport

public ApolloPersistedQuerySupport(PersistedQueryCache persistedQueryCache)

Method Details

getPersistedQueryId

protected Optional<Object> getPersistedQueryId(ExecutionInput executionInput)

Description copied from class: PersistedQuerySupport

This method is required for concrete types to work out the query id (often a hash) that should be used to look up the persisted query in the cache.

Specified by:

getPersistedQueryId in class PersistedQuerySupport

Parameters:

executionInput - the execution input

Returns:

an optional id of the persisted query

persistedQueryIdIsInvalid

protected boolean persistedQueryIdIsInvalid(Object persistedQueryId,
 String queryText)

Overrides:

persistedQueryIdIsInvalid in class PersistedQuerySupport