Index

A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractAuthenticationWebSocketInterceptor - Class in org.springframework.graphql.server.support
Base class for interceptors that extract an Authentication from the payload of a "connection_init" GraphQL over WebSocket message.
AbstractAuthenticationWebSocketInterceptor(AuthenticationExtractor) - Constructor for class org.springframework.graphql.server.support.AbstractAuthenticationWebSocketInterceptor
Constructor with the strategy to use to extract the authentication value from the "connection_init" message.
AbstractDelegatingGraphQlClient - Class in org.springframework.graphql.client
Base class for GraphQlClient extensions that assist with building an underlying transport, but otherwise delegate to the default GraphQlClient implementation to execute requests.
AbstractDelegatingGraphQlClient(GraphQlClient) - Constructor for class org.springframework.graphql.client.AbstractDelegatingGraphQlClient
 
AbstractGraphQlClientBuilder<B extends AbstractGraphQlClientBuilder<B>> - Class in org.springframework.graphql.client
Abstract, base class for transport specific GraphQlClient.Builder implementations.
AbstractGraphQlClientBuilder() - Constructor for class org.springframework.graphql.client.AbstractGraphQlClientBuilder
Default constructor for use from subclasses.
AbstractGraphQlClientBuilder.DefaultJackson2Codecs - Class in org.springframework.graphql.client
 
AbstractGraphQlClientSyncBuilder<B extends AbstractGraphQlClientSyncBuilder<B>> - Class in org.springframework.graphql.client
Abstract, base class for transport specific GraphQlClient.SyncBuilder implementations.
AbstractGraphQlClientSyncBuilder() - Constructor for class org.springframework.graphql.client.AbstractGraphQlClientSyncBuilder
Default constructor for use from subclasses.
AbstractGraphQlHttpHandler - Class in org.springframework.graphql.server.webflux
Abstract base class for GraphQL over HTTP handlers.
AbstractGraphQlHttpHandler - Class in org.springframework.graphql.server.webmvc
Abstract base class for GraphQL over HTTP handlers.
AbstractGraphQlHttpHandler(WebGraphQlHandler, CodecConfigurer) - Constructor for class org.springframework.graphql.server.webflux.AbstractGraphQlHttpHandler
 
AbstractGraphQlHttpHandler(WebGraphQlHandler, HttpMessageConverter<?>) - Constructor for class org.springframework.graphql.server.webmvc.AbstractGraphQlHttpHandler
 
AbstractGraphQlResponse - Class in org.springframework.graphql.support
Base class for GraphQlResponse that pre-implements the ability to access a ResponseField.
AbstractGraphQlResponse() - Constructor for class org.springframework.graphql.support.AbstractGraphQlResponse
 
AbstractGraphQlSourceBuilder<B extends GraphQlSource.Builder<B>> - Class in org.springframework.graphql.execution
Implementation of GraphQlSource.Builder that leaves it to subclasses to initialize GraphQLSchema.
AbstractGraphQlSourceBuilder() - Constructor for class org.springframework.graphql.execution.AbstractGraphQlSourceBuilder
 
AbstractSortStrategy - Class in org.springframework.graphql.data.query
Convenient base class for a SortStrategy.
AbstractSortStrategy() - Constructor for class org.springframework.graphql.data.query.AbstractSortStrategy
 
addCustomArgumentResolver(HandlerMethodArgumentResolver) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer
Add a HandlerMethodArgumentResolver for custom controller method arguments.
addDataLoaderRegistrar(DataLoaderRegistrar) - Method in class org.springframework.graphql.execution.DefaultExecutionGraphQlService
Add a registrar to get access to and configure the DataLoaderRegistry for each request.
addFormatterRegistrar(FormatterRegistrar) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
Add a FormatterRegistrar to customize the ConversionService that assists in binding GraphQL arguments onto @Argument annotated method parameters.
addMapping(Class<?>, String) - Method in class org.springframework.graphql.execution.ClassNameTypeResolver
Add a mapping from a Java Class to a GraphQL Object type name.
addResolver(HandlerMethodArgumentResolver) - Method in class org.springframework.graphql.data.method.HandlerMethodArgumentResolverComposite
afterConnectionClosed(WebSocketSession, CloseStatus) - Method in class org.springframework.graphql.server.webmvc.GraphQlWebSocketHandler
 
afterConnectionEstablished(WebSocketSession) - Method in class org.springframework.graphql.server.webmvc.GraphQlWebSocketHandler
 
afterPropertiesSet() - Method in class org.springframework.graphql.data.federation.FederationSchemaFactory
 
afterPropertiesSet() - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer
 
afterPropertiesSet() - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
 
andThen(GraphQlClientInterceptor) - Method in interface org.springframework.graphql.client.GraphQlClientInterceptor
Return a new interceptor that invokes the current interceptor first and then the one that is passed in.
andThen(SyncGraphQlClientInterceptor) - Method in interface org.springframework.graphql.client.SyncGraphQlClientInterceptor
Return a new interceptor that invokes the current interceptor first and then the one that is passed in.
andThen(RSocketGraphQlInterceptor) - Method in interface org.springframework.graphql.server.RSocketGraphQlInterceptor
Return a new RSocketGraphQlInterceptor that invokes the current interceptor first and then the one that is passed in.
andThen(WebGraphQlInterceptor) - Method in interface org.springframework.graphql.server.WebGraphQlInterceptor
Return a new WebGraphQlInterceptor that invokes the current interceptor first and then the one that is passed in.
AnnotatedControllerConfigurer - Class in org.springframework.graphql.data.method.annotation.support
RuntimeWiringConfigurer that finds @SchemaMapping and @BatchMapping methods in @Controller classes, and registers them as DataFetchers.
AnnotatedControllerConfigurer() - Constructor for class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer
 
AnnotatedControllerDetectionSupport<M> - Class in org.springframework.graphql.data.method.annotation.support
Convenient base for classes that find annotated controller method with argument values resolved from a DataFetchingEnvironment.
AnnotatedControllerDetectionSupport() - Constructor for class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
 
APPLICATION_GRAPHQL_RESPONSE - Static variable in class org.springframework.graphql.MediaTypes
Standard media type for GraphQL responses over the HTTP protocol.
apply(RSocketGraphQlInterceptor.Chain) - Method in interface org.springframework.graphql.server.RSocketGraphQlInterceptor
Apply this interceptor to the given Chain resulting in an intercepted chain.
apply(WebGraphQlInterceptor.Chain) - Method in interface org.springframework.graphql.server.WebGraphQlInterceptor
Apply this interceptor to the given Chain resulting in an intercepted chain.
applyGraphQlConfigurers(GraphQL.Builder) - Method in class org.springframework.graphql.execution.AbstractGraphQlSourceBuilder
Protected method to apply the configured graphQlConfigurer's.
Argument - Annotation Interface in org.springframework.graphql.data.method.annotation
Annotation to bind a named GraphQL argument onto a method parameter.
ArgumentMethodArgumentResolver - Class in org.springframework.graphql.data.method.annotation.support
Resolver for a method parameter that is annotated with @Argument.
ArgumentMethodArgumentResolver(GraphQlArgumentBinder) - Constructor for class org.springframework.graphql.data.method.annotation.support.ArgumentMethodArgumentResolver
 
Arguments - Annotation Interface in org.springframework.graphql.data.method.annotation
Analogous to Argument but binding with the full arguments map.
ArgumentsMethodArgumentResolver - Class in org.springframework.graphql.data.method.annotation.support
Resolver for a method parameter that is annotated with @Arguments, similar to what ArgumentMethodArgumentResolver does but using the full full GraphQL arguments map as the source for binding to the target Object rather than a specific argument value within it.
ArgumentsMethodArgumentResolver(GraphQlArgumentBinder) - Constructor for class org.springframework.graphql.data.method.annotation.support.ArgumentsMethodArgumentResolver
 
ArgumentValue<T> - Class in org.springframework.graphql.data
Simple container for the value from binding a GraphQL argument to a higher level Object, along with a flag to indicate whether the input argument was omitted altogether, as opposed to provided but set to the "null" literal.
ArgumentValueValueExtractor - Class in org.springframework.graphql.data.method.annotation.support
ValueExtractor that enables @Valid with ArgumentValue, and helps to extract the value from it.
ArgumentValueValueExtractor() - Constructor for class org.springframework.graphql.data.method.annotation.support.ArgumentValueValueExtractor
 
asOptional() - Method in class org.springframework.graphql.data.ArgumentValue
Return the contained value as a nullable Optional.
assertTargetBean(Method, Object, Object[]) - Method in class org.springframework.graphql.data.method.HandlerMethod
Assert that the target bean class is an instance of the class where the given method is declared.
attribute(String, Object) - Method in class org.springframework.graphql.client.DgsGraphQlClient.RequestSpec
Set a client request attribute.
attribute(String, Object) - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Set a client request attribute.
attributes(Consumer<Map<String, Object>>) - Method in class org.springframework.graphql.client.DgsGraphQlClient.RequestSpec
Manipulate the client request attributes.
attributes(Consumer<Map<String, Object>>) - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Manipulate the client request attributes.
authenticate(Authentication) - Method in class org.springframework.graphql.server.support.AbstractAuthenticationWebSocketInterceptor
Subclasses implement this method to return an authenticated SecurityContext or an error.
authenticate(Authentication) - Method in class org.springframework.graphql.server.webflux.AuthenticationWebSocketInterceptor
 
authenticate(Authentication) - Method in class org.springframework.graphql.server.webmvc.AuthenticationWebSocketInterceptor
 
AuthenticationExtractor - Interface in org.springframework.graphql.server.support
Strategy to extract an Authentication from the payload of a "connection_init" GraphQL over WebSocket message.
AuthenticationPrincipalArgumentResolver - Class in org.springframework.graphql.data.method.annotation.support
Resolver to obtain Authentication.getPrincipal() from Spring Security context via SecurityContext.getAuthentication() for parameters annotated with AuthenticationPrincipal.
AuthenticationPrincipalArgumentResolver(BeanResolver) - Constructor for class org.springframework.graphql.data.method.annotation.support.AuthenticationPrincipalArgumentResolver
Creates a new instance.
AuthenticationWebSocketInterceptor - Class in org.springframework.graphql.server.webflux
Extension of AbstractAuthenticationWebSocketInterceptor for use with the WebFlux GraphQL transport.
AuthenticationWebSocketInterceptor - Class in org.springframework.graphql.server.webmvc
Extension of AbstractAuthenticationWebSocketInterceptor for use with the WebMVC GraphQL transport.
AuthenticationWebSocketInterceptor(AuthenticationExtractor, AuthenticationManager) - Constructor for class org.springframework.graphql.server.webmvc.AuthenticationWebSocketInterceptor
 
AuthenticationWebSocketInterceptor(AuthenticationExtractor, ReactiveAuthenticationManager) - Constructor for class org.springframework.graphql.server.webflux.AuthenticationWebSocketInterceptor
 
AUTHORIZATION_KEY - Static variable in class org.springframework.graphql.server.support.BearerTokenAuthenticationExtractor
Default key to access Authorization value in connection_init payload.
autoRegistrationConfigurer(List<QuerydslPredicateExecutor<?>>, List<ReactiveQuerydslPredicateExecutor<?>>) - Static method in class org.springframework.graphql.data.query.QuerydslDataFetcher
autoRegistrationConfigurer(List<QuerydslPredicateExecutor<?>>, List<ReactiveQuerydslPredicateExecutor<?>>, CursorStrategy<ScrollPosition>, ScrollSubrange) - Static method in class org.springframework.graphql.data.query.QuerydslDataFetcher
Return a RuntimeWiringConfigurer that installs a WiringFactory to find queries with a return type whose name matches to the domain type name of the given repositories and registers DataFetchers for them.
autoRegistrationConfigurer(List<QueryByExampleExecutor<?>>, List<ReactiveQueryByExampleExecutor<?>>) - Static method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher
autoRegistrationConfigurer(List<QueryByExampleExecutor<?>>, List<ReactiveQueryByExampleExecutor<?>>, CursorStrategy<ScrollPosition>, ScrollSubrange) - Static method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher
Return a RuntimeWiringConfigurer that installs a WiringFactory to find queries with a return type whose name matches to the domain type name of the given repositories and registers DataFetchers for them.

B

BAD_REQUEST - Enum constant in enum class org.springframework.graphql.execution.ErrorType
DataFetcher cannot or will not fetch the data value due to something that is perceived to be a client error.
base64() - Static method in interface org.springframework.graphql.data.pagination.CursorEncoder
Return a CursorEncoder for Base64 encoding and decoding.
BatchLoaderHandlerMethod - Class in org.springframework.graphql.data.method.annotation.support
An extension of HandlerMethod for annotated handler methods adapted to BatchLoaderWithContext or MappedBatchLoaderWithContext with the list of keys and BatchLoaderEnvironment as their input.
BatchLoaderHandlerMethod(HandlerMethod, Executor) - Constructor for class org.springframework.graphql.data.method.annotation.support.BatchLoaderHandlerMethod
Deprecated, for removal: This API element is subject to removal in a future version.
in favor of alternative constructor
BatchLoaderHandlerMethod(HandlerMethod, Executor, boolean) - Constructor for class org.springframework.graphql.data.method.annotation.support.BatchLoaderHandlerMethod
Create an instance.
BatchLoaderRegistry - Interface in org.springframework.graphql.execution
Registry for functions to batch load data values, given a set of keys.
BatchLoaderRegistry.RegistrationSpec<K,V> - Interface in org.springframework.graphql.execution
Spec to complete the registration of a batch loading function.
BatchMapping - Annotation Interface in org.springframework.graphql.data.method.annotation
Annotation for a handler method that batch loads field values, given a list of source/parent values.
BearerTokenAuthenticationExtractor - Class in org.springframework.graphql.server.support
BearerTokenAuthenticationExtractor() - Constructor for class org.springframework.graphql.server.support.BearerTokenAuthenticationExtractor
Constructor that defaults to BearerTokenAuthenticationExtractor.AUTHORIZATION_KEY for the payload key.
BearerTokenAuthenticationExtractor(String) - Constructor for class org.springframework.graphql.server.support.BearerTokenAuthenticationExtractor
Constructor with the key for the authorization value.
beginExecution(InstrumentationExecutionParameters, InstrumentationState) - Method in class org.springframework.graphql.observation.GraphQlObservationInstrumentation
 
bind(DataFetchingEnvironment, String, ResolvableType) - Method in class org.springframework.graphql.data.GraphQlArgumentBinder
Create and populate an Object of the given target type, from a single GraphQL argument, or from the full GraphQL arguments map.
bind(Object, boolean, ResolvableType) - Method in class org.springframework.graphql.data.GraphQlArgumentBinder
Variant of GraphQlArgumentBinder.bind(DataFetchingEnvironment, String, ResolvableType) with a pre-extracted raw value to bind from.
bindCancelFrom(Flux<T>, GraphQLContext) - Static method in class org.springframework.graphql.execution.ContextPropagationHelper
Bind the source Flux to the publisher from the given GraphQLContext.
bindCancelFrom(Mono<T>, GraphQLContext) - Static method in class org.springframework.graphql.execution.ContextPropagationHelper
Bind the source Mono to the publisher from the given GraphQLContext.
blockingTimeout(Duration) - Method in class org.springframework.graphql.client.AbstractGraphQlClientBuilder
 
blockingTimeout(Duration) - Method in class org.springframework.graphql.client.AbstractGraphQlClientSyncBuilder
 
blockingTimeout(Duration) - Method in interface org.springframework.graphql.client.GraphQlClient.BaseBuilder
Configure a timeout to use for blocking execution.
build() - Method in interface org.springframework.graphql.client.GraphQlClient.BaseBuilder
Build the GraphQlClient instance.
build() - Method in interface org.springframework.graphql.client.HttpGraphQlClient.Builder
Build the HttpGraphQlClient instance.
build() - Method in interface org.springframework.graphql.client.HttpSyncGraphQlClient.Builder
Build the HttpSyncGraphQlClient instance.
build() - Method in interface org.springframework.graphql.client.RSocketGraphQlClient.Builder
Build the RSocketGraphQlClient instance.
build() - Method in interface org.springframework.graphql.client.WebGraphQlClient.Builder
Build a WebGraphQlClient instance.
build() - Method in interface org.springframework.graphql.client.WebSocketGraphQlClient.Builder
Build the WebSocketGraphQlClient.
build() - Method in class org.springframework.graphql.execution.AbstractGraphQlSourceBuilder
 
build() - Method in interface org.springframework.graphql.execution.GraphQlSource.Builder
Build the GraphQlSource instance.
build() - Method in interface org.springframework.graphql.server.WebGraphQlHandler.Builder
Build the WebGraphQlHandler instance.
build() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse.Builder
Build the response with the transformed ExecutionResult.
build(RSocketGraphQlResponse, ExecutionResult) - Method in class org.springframework.graphql.server.RSocketGraphQlResponse.Builder
 
build(WebGraphQlResponse, ExecutionResult) - Method in class org.springframework.graphql.server.WebGraphQlResponse.Builder
 
build(R, ExecutionResult) - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse.Builder
Subclasses to create the specific response instance.
builder() - Static method in interface org.springframework.graphql.client.HttpGraphQlClient
Return a builder to initialize an HttpGraphQlClient with.
builder() - Static method in interface org.springframework.graphql.client.HttpSyncGraphQlClient
Return a builder to initialize an HttpSyncGraphQlClient with.
builder() - Static method in interface org.springframework.graphql.client.RSocketGraphQlClient
Start with a new RSocketRequester.Builder customized for GraphQL, setting the dataMimeType to "application/graphql+json" and adding JSON codecs.
builder(GraphQLSchema) - Static method in interface org.springframework.graphql.execution.GraphQlSource
Return a GraphQlSource builder that uses an externally prepared GraphQLSchema.
builder(String, WebSocketClient) - Static method in interface org.springframework.graphql.client.WebSocketGraphQlClient
Return a builder for a WebSocketGraphQlClient.
builder(URI, WebSocketClient) - Static method in interface org.springframework.graphql.client.WebSocketGraphQlClient
Return a builder for a WebSocketGraphQlClient.
builder(QuerydslPredicateExecutor<T>) - Static method in class org.springframework.graphql.data.query.QuerydslDataFetcher
Create a new QuerydslDataFetcher.Builder accepting QuerydslPredicateExecutor to build a DataFetcher.
builder(ReactiveQuerydslPredicateExecutor<T>) - Static method in class org.springframework.graphql.data.query.QuerydslDataFetcher
Create a new QuerydslDataFetcher.ReactiveBuilder accepting ReactiveQuerydslPredicateExecutor to build a reactive DataFetcher.
builder(QueryByExampleExecutor<T>) - Static method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher
Create a new QueryByExampleDataFetcher.Builder accepting QueryByExampleExecutor to build a DataFetcher.
builder(ReactiveQueryByExampleExecutor<T>) - Static method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher
Create a new QueryByExampleDataFetcher.ReactiveBuilder accepting ReactiveQueryByExampleExecutor to build a DataFetcher.
builder(GraphQlTransport) - Static method in interface org.springframework.graphql.client.GraphQlClient
Create a builder with the given custom GraphQlTransport.
builder(ExecutionGraphQlService) - Static method in interface org.springframework.graphql.server.WebGraphQlHandler
Provides access to a builder to create a WebGraphQlHandler instance.
builder(RSocketRequester.Builder) - Static method in interface org.springframework.graphql.client.RSocketGraphQlClient
Start with a given RSocketGraphQlClient.builder().
builder(RestClient) - Static method in interface org.springframework.graphql.client.HttpSyncGraphQlClient
Variant of HttpSyncGraphQlClient.builder() with a pre-configured RestClient to mutate and customize further through the returned builder.
builder(RestClient.Builder) - Static method in interface org.springframework.graphql.client.HttpSyncGraphQlClient
Variant of HttpSyncGraphQlClient.builder() with a pre-configured RestClient to mutate and customize further through the returned builder.
builder(WebClient) - Static method in interface org.springframework.graphql.client.HttpGraphQlClient
Variant of HttpGraphQlClient.builder() with a pre-configured WebClient to mutate and customize further through the returned builder.
builder(WebClient.Builder) - Static method in interface org.springframework.graphql.client.HttpGraphQlClient
Variant of HttpGraphQlClient.builder() with a pre-configured WebClient to mutate and customize further through the returned builder.
Builder(R) - Constructor for class org.springframework.graphql.support.DefaultExecutionGraphQlResponse.Builder
 
buildExample(DataFetchingEnvironment) - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher
Prepare an Example from GraphQL request arguments.
buildGraphQlClient(GraphQlTransport) - Method in class org.springframework.graphql.client.AbstractGraphQlClientBuilder
Build the default transport-agnostic client that subclasses can then wrap with AbstractDelegatingGraphQlClient.
buildGraphQlClient(SyncGraphQlTransport) - Method in class org.springframework.graphql.client.AbstractGraphQlClientSyncBuilder
Build the default transport-agnostic client that subclasses can then wrap with AbstractDelegatingGraphQlClient.
buildPredicate(DataFetchingEnvironment) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher
Prepare a Predicate from GraphQL request arguments, also applying any QuerydslBinderCustomizer that may have been configured.
buildPropertyPaths(DataFetchingFieldSelectionSet, Class<?>) - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher
 
buildPropertyPaths(DataFetchingFieldSelectionSet, Class<?>) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher
 

C

CachingDocumentSource - Class in org.springframework.graphql.support
Base class for DocumentSource implementations providing support for caching loaded documents.
CachingDocumentSource(DocumentSource) - Constructor for class org.springframework.graphql.support.CachingDocumentSource
Constructor with the DocumentSource to actually load documents.
captureFrom(GraphQLContext) - Static method in class org.springframework.graphql.execution.ContextPropagationHelper
Shortcut to obtain the ContextSnapshotFactory instance, and to capture from the given GraphQLContext.
captureFrom(ContextView) - Static method in class org.springframework.graphql.execution.ContextPropagationHelper
Shortcut to obtain the ContextSnapshotFactory instance, and to capture from the given ContextView.
classMapping(String, Class<?>...) - Method in interface org.springframework.graphql.execution.SchemaMappingInspector.Initializer
Provide an explicit mapping between a GraphQL type name and the Java class(es) that represent it at runtime to help inspect union member and interface implementation types when those associations cannot be discovered otherwise.
classNameFunction(Function<GraphQLObjectType, String>) - Method in interface org.springframework.graphql.execution.SchemaMappingInspector.Initializer
Help to derive the simple class name for the Java representation of a GraphQL union member or interface implementing type.
ClassNameTypeResolver - Class in org.springframework.graphql.execution
TypeResolver that tries to find a GraphQL Object type based on the class name of a value returned from a DataFetcher.
ClassNameTypeResolver() - Constructor for class org.springframework.graphql.execution.ClassNameTypeResolver
 
classResolver(SchemaMappingInspector.ClassResolver) - Method in interface org.springframework.graphql.execution.SchemaMappingInspector.Initializer
Alternative to SchemaMappingInspector.Initializer.classMapping(String, Class[]) with a custom SchemaMappingInspector.ClassResolver to find the Java class(es) for a GraphQL union member or interface implementation type.
clearCache() - Method in class org.springframework.graphql.support.CachingDocumentSource
Remove all entries from the document cache.
ClientGraphQlRequest - Interface in org.springframework.graphql.client
GraphQlRequest for client side use.
ClientGraphQlResponse - Interface in org.springframework.graphql.client
GraphQlResponse for client use, with further options to handle the response.
ClientResponseField - Interface in org.springframework.graphql.client
Extends ResponseField to add options for decoding the field value.
clientTransport(ClientTransport) - Method in interface org.springframework.graphql.client.RSocketGraphQlClient.Builder
Use a given ClientTransport to communicate with the remote server.
clientTransports(Publisher<List<LoadbalanceTarget>>, LoadbalanceStrategy) - Method in interface org.springframework.graphql.client.RSocketGraphQlClient.Builder
Use a Publisher of LoadbalanceTargets, each of which contains a ClientTransport.
codecConfigurer(Consumer<CodecConfigurer>) - Method in interface org.springframework.graphql.client.WebGraphQlClient.Builder
Configure JSON encoders and decoders for use in the GraphQlResponse to convert response data to higher level objects.
coercing(Class<?>, Coercing<?, ?>) - Method in class org.springframework.graphql.client.DgsGraphQlClient.RequestSpec
Configure Coercing for serialization of scalar types.
coercing(Map<Class<?>, Coercing<?, ?>>) - Method in class org.springframework.graphql.client.DgsGraphQlClient.RequestSpec
Configure Coercing for serialization of scalar types.
complete(String) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Create a "complete" server message.
COMPLETE - Enum constant in enum class org.springframework.graphql.server.support.GraphQlWebSocketMessageType
Indicates that the requested operation execution has completed.
configure(GraphQLCodeRegistry.Builder) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer
configure(RuntimeWiring.Builder) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer
 
configure(RuntimeWiring.Builder) - Method in interface org.springframework.graphql.execution.RuntimeWiringConfigurer
Apply changes to the RuntimeWiring.Builder such as registering DataFetchers, custom scalar types, and more.
configure(RuntimeWiring.Builder, List<WiringFactory>) - Method in interface org.springframework.graphql.execution.RuntimeWiringConfigurer
Variant of RuntimeWiringConfigurer.configure(RuntimeWiring.Builder) that also collects WiringFactory instances that are then combined as one via CombinedWiringFactory.
configure(TypeDefinitionRegistry) - Method in class org.springframework.graphql.execution.ConnectionTypeDefinitionConfigurer
 
configure(TypeDefinitionRegistry) - Method in interface org.springframework.graphql.execution.TypeDefinitionConfigurer
Customize the given TypeDefinitionRegistry.
configureExecutionInput(BiFunction<ExecutionInput, ExecutionInput.Builder, ExecutionInput>) - Method in interface org.springframework.graphql.ExecutionGraphQlRequest
Provide a BiFunction to help initialize the ExecutionInput passed to GraphQL.
configureExecutionInput(BiFunction<ExecutionInput, ExecutionInput.Builder, ExecutionInput>) - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlRequest
 
configureGraphQl(Consumer<GraphQL.Builder>) - Method in class org.springframework.graphql.execution.AbstractGraphQlSourceBuilder
 
configureGraphQl(Consumer<GraphQL.Builder>) - Method in interface org.springframework.graphql.execution.GraphQlSource.Builder
Configure consumers to be given access to the GraphQL.Builder used to build GraphQL.
configureRuntimeWiring(RuntimeWiringConfigurer) - Method in interface org.springframework.graphql.execution.GraphQlSource.SchemaResourceBuilder
Configure the underlying RuntimeWiring.Builder to register data fetchers, custom scalar types, type resolvers, and more.
configureTypeDefinitions(TypeDefinitionConfigurer) - Method in interface org.springframework.graphql.execution.GraphQlSource.SchemaResourceBuilder
Customize the TypeDefinitionRegistry created from parsed schema files, adding or changing schema type definitions before the GraphQLSchema is created and validated.
CONNECTION_ACK - Enum constant in enum class org.springframework.graphql.server.support.GraphQlWebSocketMessageType
Expected response to the GraphQlWebSocketMessageType.CONNECTION_INIT message from the client acknowledging a successful connection with the server.
CONNECTION_INIT - Enum constant in enum class org.springframework.graphql.server.support.GraphQlWebSocketMessageType
Indicates that the client wants to establish a connection within the existing socket.
connectionAck(Object) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Create a "connection_ack" server message.
ConnectionAdapter - Interface in org.springframework.graphql.data.pagination
Contract to adapt a container object for a window of elements from a larger result set to Connection.
ConnectionAdapterSupport<P> - Class in org.springframework.graphql.data.pagination
Convenient base class for implementations of ConnectionAdapter.
ConnectionAdapterSupport(CursorStrategy<P>) - Constructor for class org.springframework.graphql.data.pagination.ConnectionAdapterSupport
Constructor with a CursorStrategy to use.
ConnectionFieldTypeVisitor - Class in org.springframework.graphql.data.pagination
GraphQLTypeVisitor that looks for Connection fields in the schema, and decorates their registered DataFetcher in order to adapt return values to Connection.
connectionInit(Object) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Create a "connection_init" client message.
connectionInitPayload() - Method in interface org.springframework.graphql.client.WebSocketGraphQlClientInterceptor
Provide a Mono that returns the payload for the "connection_init" message.
ConnectionTypeDefinitionConfigurer - Class in org.springframework.graphql.execution
TypeDefinitionConfigurer that generates "Connection" types by looking for fields whose type definition name ends in "Connection", considered by the GraphQL Cursor Connections Specification to be a Connection Type, and adding the required type definitions if they don't already exist.
ConnectionTypeDefinitionConfigurer() - Constructor for class org.springframework.graphql.execution.ConnectionTypeDefinitionConfigurer
 
ContextPropagationHelper - Class in org.springframework.graphql.execution
Helper for propagating context values from and to Reactor and GraphQL contexts.
ContextPropagationHelper() - Constructor for class org.springframework.graphql.execution.ContextPropagationHelper
 
contextSnapshotFactory() - Method in interface org.springframework.graphql.server.WebGraphQlHandler
Return the configured ContextSnapshotFactory instance to use.
contextSnapshotFactory(ContextSnapshotFactory) - Method in interface org.springframework.graphql.server.WebGraphQlHandler.Builder
Configure the ContextSnapshotFactory instance to use for context propagation of ThreadLocal, and Reactor context values from the transport layer to the GraphQL execution layer.
ContextSnapshotFactoryHelper - Class in org.springframework.graphql.execution
Deprecated, for removal: This API element is subject to removal in a future version.
since 1.3.5 in favor of ContextPropagationHelper.
ContextSnapshotFactoryHelper() - Constructor for class org.springframework.graphql.execution.ContextSnapshotFactoryHelper
Deprecated.
 
ContextValue - Annotation Interface in org.springframework.graphql.data.method.annotation
Annotation to bind a method parameter to an attribute from the main GraphQLContext.
ContextValueMethodArgumentResolver - Class in org.springframework.graphql.data.method.annotation.support
Resolver for a @ContextValue annotated method parameter.
ContextValueMethodArgumentResolver() - Constructor for class org.springframework.graphql.data.method.annotation.support.ContextValueMethodArgumentResolver
 
ContinuationHandlerMethodArgumentResolver - Class in org.springframework.graphql.data.method.annotation.support
No-op resolver for method arguments of type Continuation.
ContinuationHandlerMethodArgumentResolver() - Constructor for class org.springframework.graphql.data.method.annotation.support.ContinuationHandlerMethodArgumentResolver
 
count() - Method in class org.springframework.graphql.data.pagination.Subrange
The number of elements in the subrange based on the "first" and "last" arguments from the GraphQL Cursor connection spec.
create(GraphQL, GraphQLSchema) - Method in interface org.springframework.graphql.execution.GraphQlSource.Factory
Create a GraphQlSource with the given inputs.
create(GraphQLSchema) - Static method in interface org.springframework.graphql.execution.TypeVisitorHelper
Create an instance with the given GraphQLSchema.
create(URI, WebSocketClient) - Static method in interface org.springframework.graphql.client.WebSocketGraphQlClient
create(List<ConnectionAdapter>) - Static method in class org.springframework.graphql.data.pagination.ConnectionFieldTypeVisitor
Create a ConnectionTypeVisitor instance that delegates to the given adapters to adapt return values to Connection.
create(ScrollPosition, Integer, boolean) - Static method in class org.springframework.graphql.data.query.ScrollSubrange
Create a ScrollSubrange from the given inputs.
create(GraphQlClient) - Static method in class org.springframework.graphql.client.DgsGraphQlClient
Create instance that wraps the given GraphQlClient.
create(RestClient) - Static method in interface org.springframework.graphql.client.HttpSyncGraphQlClient
Create an HttpSyncGraphQlClient that uses the given RestClient.
create(WebClient) - Static method in interface org.springframework.graphql.client.HttpGraphQlClient
Create an HttpGraphQlClient that uses the given WebClient.
createCancelPublisher(GraphQLContext) - Static method in class org.springframework.graphql.execution.ContextPropagationHelper
Create a publisher and store it into the given GraphQLContext.
createExceptionHandler(List<DataFetcherExceptionResolver>) - Static method in interface org.springframework.graphql.execution.DataFetcherExceptionResolver
Factory method to create a DataFetcherExceptionHandler from a list of DataFetcherExceptionResolver's.
createGraphQLSchema(TypeDefinitionRegistry, RuntimeWiring) - Method in class org.springframework.graphql.data.federation.FederationSchemaFactory
Create GraphQLSchema via SchemaTransformer, setting up the "_entities" DataFetcher and TypeResolver for federated types.
createHandlerMethod(Method, Object, Class<?>) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
 
createProjection(Class<?>, Object) - Method in class org.springframework.graphql.data.method.annotation.support.ProjectedPayloadMethodArgumentResolver
Protected method to create the projection.
createResponse(Map<String, Object>) - Static method in interface org.springframework.graphql.client.GraphQlTransport
Factory method to create GraphQlResponse from a GraphQL response map for use in transport implementations.
createSchemaTransformer(TypeDefinitionRegistry, RuntimeWiring) - Method in class org.springframework.graphql.data.federation.FederationSchemaFactory
Alternative to FederationSchemaFactory.createGraphQLSchema(TypeDefinitionRegistry, RuntimeWiring) that allows calling additional methods on SchemaTransformer.
createStateAsync(InstrumentationCreateStateParameters) - Method in class org.springframework.graphql.observation.GraphQlObservationInstrumentation
 
createSubrange(ScrollPosition, Integer, boolean) - Method in class org.springframework.graphql.data.method.annotation.support.ScrollSubrangeMethodArgumentResolver
 
createSubrange(P, Integer, boolean) - Method in class org.springframework.graphql.data.method.annotation.support.SubrangeMethodArgumentResolver
Allows subclasses to create an extension of Subrange.
createWithResolvedBean() - Method in class org.springframework.graphql.data.method.HandlerMethod
If the provided instance contains a bean name rather than an object instance, the bean name is resolved before a HandlerMethod is created and returned.
cursorAt(Object, int) - Method in interface org.springframework.graphql.data.pagination.ConnectionAdapter
Return a cursor for the item at the given index.
cursorAt(Object, int) - Method in class org.springframework.graphql.data.query.SliceConnectionAdapter
 
cursorAt(Object, int) - Method in class org.springframework.graphql.data.query.WindowConnectionAdapter
 
CursorEncoder - Interface in org.springframework.graphql.data.pagination
Strategy to encode and decode a String cursor to make it opaque for clients.
cursorStrategy(CursorStrategy<ScrollPosition>) - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.Builder
Configure strategy for decoding a cursor from a paginated request.
cursorStrategy(CursorStrategy<ScrollPosition>) - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.ReactiveBuilder
Configure strategy for decoding a cursor from a paginated request.
cursorStrategy(CursorStrategy<ScrollPosition>) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.Builder
Configure strategy for decoding a cursor from a paginated request.
cursorStrategy(CursorStrategy<ScrollPosition>) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.ReactiveBuilder
Configure strategy for decoding a cursor from a paginated request.
CursorStrategy<P> - Interface in org.springframework.graphql.data.pagination
Strategy to convert an Object that represents the position of an item within a paginated result set to and from a String cursor.
customize(QueryByExampleDataFetcher.Builder<T, ?>) - Method in interface org.springframework.graphql.data.query.QueryByExampleDataFetcher.QueryByExampleBuilderCustomizer
Callback to customize a QueryByExampleDataFetcher.Builder instance.
customize(QueryByExampleDataFetcher.ReactiveBuilder<T, ?>) - Method in interface org.springframework.graphql.data.query.QueryByExampleDataFetcher.ReactiveQueryByExampleBuilderCustomizer
Callback to customize a QueryByExampleDataFetcher.ReactiveBuilder instance.
customize(QuerydslDataFetcher.Builder<T, ?>) - Method in interface org.springframework.graphql.data.query.QuerydslDataFetcher.QuerydslBuilderCustomizer
Callback to customize a QuerydslDataFetcher.Builder instance.
customize(QuerydslDataFetcher.ReactiveBuilder<T, ?>) - Method in interface org.springframework.graphql.data.query.QuerydslDataFetcher.ReactiveQuerydslBuilderCustomizer
Callback to customize a QuerydslDataFetcher.ReactiveBuilder instance.
customizer(QuerydslBinderCustomizer<? extends EntityPath<T>>) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.Builder
Apply a QuerydslBinderCustomizer.
customizer(QuerydslBinderCustomizer<? extends EntityPath<T>>) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.ReactiveBuilder
Apply a QuerydslBinderCustomizer.

D

data(Object) - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse.Builder
Set the data of the GraphQL execution result.
DATA_FETCHER - Enum constant in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation
Observation created for non-trivial data fetching operations.
DATA_LOADER - Enum constant in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation
Observation created for DataLoader operations.
dataFetcher(FieldCoordinates) - Method in interface org.springframework.graphql.execution.SchemaReport
Return the DataFetcher for the given field coordinates, if registered.
DataFetcherExceptionResolver - Interface in org.springframework.graphql.execution
Contract to resolve exceptions from DataFetchers.
DataFetcherExceptionResolverAdapter - Class in org.springframework.graphql.execution
DataFetcherExceptionResolverAdapter() - Constructor for class org.springframework.graphql.execution.DataFetcherExceptionResolverAdapter
Protected constructor since this class is meant to be extended to provide the actual exception resolution logic.
DataFetcherHandlerMethod - Class in org.springframework.graphql.data.method.annotation.support
Invocable handler to use as a DataFetcher.
DataFetcherHandlerMethod(HandlerMethod, HandlerMethodArgumentResolverComposite, BiConsumer<Object, Object[]>, Executor, boolean) - Constructor for class org.springframework.graphql.data.method.annotation.support.DataFetcherHandlerMethod
Deprecated, for removal: This API element is subject to removal in a future version.
in favor of alternative constructor
DataFetcherHandlerMethod(HandlerMethod, HandlerMethodArgumentResolverComposite, BiConsumer<Object, Object[]>, Executor, boolean, boolean) - Constructor for class org.springframework.graphql.data.method.annotation.support.DataFetcherHandlerMethod
Constructor with a parent handler method.
DataFetcherHandlerMethodSupport - Class in org.springframework.graphql.data.method.annotation.support
Extension of InvocableHandlerMethodSupport for handler methods that resolve argument values from a DataFetchingEnvironment.
DataFetcherHandlerMethodSupport(HandlerMethod, HandlerMethodArgumentResolverComposite, Executor, boolean) - Constructor for class org.springframework.graphql.data.method.annotation.support.DataFetcherHandlerMethodSupport
 
DataFetcherMappingInfo - Class in org.springframework.graphql.data.method.annotation.support
Mapping information for a controller method to be registered as a DataFetcher.
DataFetcherMappingInfo(String, String, boolean, int, HandlerMethod) - Constructor for class org.springframework.graphql.data.method.annotation.support.DataFetcherMappingInfo
 
DataFetcherMappingInfo(String, DataFetcherMappingInfo) - Constructor for class org.springframework.graphql.data.method.annotation.support.DataFetcherMappingInfo
 
DataFetcherObservationContext - Class in org.springframework.graphql.observation
Context that holds information for metadata collection during observations for data fetching operations.
DataFetcherObservationConvention - Interface in org.springframework.graphql.observation
Interface for an ObservationConvention for data fetching observations.
DataFetchingEnvironmentMethodArgumentResolver - Class in org.springframework.graphql.data.method.annotation.support
Resolver for DataFetchingEnvironment and related values that can be accessed through the DataFetchingEnvironment.
DataFetchingEnvironmentMethodArgumentResolver() - Constructor for class org.springframework.graphql.data.method.annotation.support.DataFetchingEnvironmentMethodArgumentResolver
 
DataLoaderMethodArgumentResolver - Class in org.springframework.graphql.data.method.annotation.support
Resolver for a DataLoader obtained via DataFetchingEnvironment.getDataLoader(String).
DataLoaderMethodArgumentResolver() - Constructor for class org.springframework.graphql.data.method.annotation.support.DataLoaderMethodArgumentResolver
 
DataLoaderObservationContext - Class in org.springframework.graphql.observation
Context that holds information for metadata collection during observations for data loader operations.
DataLoaderObservationConvention - Interface in org.springframework.graphql.observation
Interface for an ObservationConvention for data loading observations.
DataLoaderRegistrar - Interface in org.springframework.graphql.execution
Contract for access to the DataLoaderRegistry for each request for the purpose of registering DataLoader instances.
dataMimeType(MimeType) - Method in interface org.springframework.graphql.client.RSocketGraphQlClient.Builder
Customize the format of data payloads for the connection.
decode(String) - Method in interface org.springframework.graphql.data.pagination.CursorEncoder
Decode the given cursor from external input.
DefaultBatchLoaderRegistry - Class in org.springframework.graphql.execution
Default implementation of BatchLoaderRegistry that stores batch loader registrations.
DefaultBatchLoaderRegistry() - Constructor for class org.springframework.graphql.execution.DefaultBatchLoaderRegistry
Default constructor.
DefaultBatchLoaderRegistry(Supplier<DataLoaderOptions>) - Constructor for class org.springframework.graphql.execution.DefaultBatchLoaderRegistry
Constructor with a default DataLoaderOptions supplier to use as a starting point for batch loader registrations.
DefaultDataFetcherObservationConvention - Class in org.springframework.graphql.observation
Default implementation for a DataFetcherObservationConvention extracting information from a DataFetcherObservationContext.
DefaultDataFetcherObservationConvention() - Constructor for class org.springframework.graphql.observation.DefaultDataFetcherObservationConvention
 
DefaultDataFetcherObservationConvention(String) - Constructor for class org.springframework.graphql.observation.DefaultDataFetcherObservationConvention
 
DefaultDataLoaderObservationConvention - Class in org.springframework.graphql.observation
Default implementation for a DataLoaderObservationConvention extracting information from a DataLoaderObservationContext.
DefaultDataLoaderObservationConvention() - Constructor for class org.springframework.graphql.observation.DefaultDataLoaderObservationConvention
 
DefaultExecutionGraphQlRequest - Class in org.springframework.graphql.support
GraphQlRequest for server side handling, adding the transport (e.g.
DefaultExecutionGraphQlRequest(String, String, Map<String, Object>, Map<String, Object>, String, Locale) - Constructor for class org.springframework.graphql.support.DefaultExecutionGraphQlRequest
Create an instance.
DefaultExecutionGraphQlResponse - Class in org.springframework.graphql.support
GraphQlResponse for server use that wraps the ExecutionResult returned from GraphQL and also exposes the actual ExecutionInput instance passed into it.
DefaultExecutionGraphQlResponse(ExecutionInput, ExecutionResult) - Constructor for class org.springframework.graphql.support.DefaultExecutionGraphQlResponse
Constructor to create initial instance.
DefaultExecutionGraphQlResponse(ExecutionGraphQlResponse) - Constructor for class org.springframework.graphql.support.DefaultExecutionGraphQlResponse
Constructor to re-wrap from transport specific subclass.
DefaultExecutionGraphQlResponse.Builder<B extends DefaultExecutionGraphQlResponse.Builder<B,R>,R extends ExecutionGraphQlResponse> - Class in org.springframework.graphql.support
Builder to transform the response's ExecutionResult.
DefaultExecutionGraphQlService - Class in org.springframework.graphql.execution
ExecutionGraphQlService that uses a GraphQlSource to obtain a GraphQL instance and perform query execution.
DefaultExecutionGraphQlService(GraphQlSource) - Constructor for class org.springframework.graphql.execution.DefaultExecutionGraphQlService
 
DefaultExecutionRequestObservationConvention - Class in org.springframework.graphql.observation
Default implementation for a ExecutionRequestObservationConvention extracting information from a ExecutionRequestObservationContext.
DefaultExecutionRequestObservationConvention() - Constructor for class org.springframework.graphql.observation.DefaultExecutionRequestObservationConvention
 
DefaultExecutionRequestObservationConvention(String) - Constructor for class org.springframework.graphql.observation.DefaultExecutionRequestObservationConvention
 
DefaultGraphQlRequest - Class in org.springframework.graphql.support
Default implementation of GraphQlRequest.
DefaultGraphQlRequest(String) - Constructor for class org.springframework.graphql.support.DefaultGraphQlRequest
Create a request.
DefaultGraphQlRequest(String, String, Map<String, Object>, Map<String, Object>) - Constructor for class org.springframework.graphql.support.DefaultGraphQlRequest
Create a request with a complete set of inputs.
DefaultJackson2Codecs() - Constructor for class org.springframework.graphql.client.AbstractGraphQlClientBuilder.DefaultJackson2Codecs
 
defaultScrollSubrange(int, Function<Boolean, ScrollPosition>) - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.Builder
Configure a default scroll count to use, and function to return a default ScrollPosition for forward vs backward pagination.
defaultScrollSubrange(int, Function<Boolean, ScrollPosition>) - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.ReactiveBuilder
Configure a default scroll count to use, and function to return a default ScrollPosition for forward vs backward pagination.
defaultScrollSubrange(int, Function<Boolean, ScrollPosition>) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.Builder
Configure a default scroll count to use, and function to return a default ScrollPosition for forward vs backward pagination.
defaultScrollSubrange(int, Function<Boolean, ScrollPosition>) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.ReactiveBuilder
Configure a default scroll count to use, and function to return a default ScrollPosition for forward vs backward pagination.
defaultScrollSubrange(ScrollSubrange) - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.Builder
Deprecated, for removal: This API element is subject to removal in a future version.
defaultScrollSubrange(ScrollSubrange) - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.ReactiveBuilder
Deprecated, for removal: This API element is subject to removal in a future version.
defaultScrollSubrange(ScrollSubrange) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.Builder
Deprecated, for removal: This API element is subject to removal in a future version.
defaultScrollSubrange(ScrollSubrange) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.ReactiveBuilder
Deprecated, for removal: This API element is subject to removal in a future version.
defaultTypeResolver(TypeResolver) - Method in interface org.springframework.graphql.execution.GraphQlSource.SchemaResourceBuilder
Configure the default TypeResolver to use for GraphQL interface and union types that don't have such a registration after applying RuntimeWiringConfigurers.
detectHandlerMethods() - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
Scan beans in the ApplicationContext, detect and prepare a map of handler methods.
DgsGraphQlClient - Class in org.springframework.graphql.client
Simple wrapper around a GraphQlClient that prepares the request from classes generated with the DGS Code Generation library.
DgsGraphQlClient.RequestSpec - Class in org.springframework.graphql.client
Declare options to gather input for a GraphQL request and execute it.
doBind(DataFetchingEnvironment, String, ResolvableType) - Method in class org.springframework.graphql.data.method.annotation.support.ArgumentMethodArgumentResolver
Perform the binding with the configured binder.
document(String) - Method in class org.springframework.graphql.client.AbstractDelegatingGraphQlClient
 
document(String) - Method in interface org.springframework.graphql.client.GraphQlClient
Start defining a GraphQL request with the given document, which is the textual representation of an operation (or operations) to perform, including selection sets and fragments.
documentName(String) - Method in class org.springframework.graphql.client.AbstractDelegatingGraphQlClient
 
documentName(String) - Method in interface org.springframework.graphql.client.GraphQlClient
Variant of GraphQlClient.document(String) that uses the given key to resolve the GraphQL document from a file with the help of the configured DocumentSource.
documentSource(DocumentSource) - Method in class org.springframework.graphql.client.AbstractGraphQlClientBuilder
 
documentSource(DocumentSource) - Method in class org.springframework.graphql.client.AbstractGraphQlClientSyncBuilder
 
documentSource(DocumentSource) - Method in interface org.springframework.graphql.client.GraphQlClient.BaseBuilder
Configure a DocumentSource strategy to resolve a document by name.
DocumentSource - Interface in org.springframework.graphql.support
Strategy to locate a GraphQL document by a name.
doesNotRequirePayload() - Method in enum class org.springframework.graphql.server.support.GraphQlWebSocketMessageType
Return if the message type has a payload, and it is required.
doInvoke(GraphQLContext, Object...) - Method in class org.springframework.graphql.data.method.InvocableHandlerMethodSupport
Invoke the handler method with the given argument values.

E

encode(String) - Method in interface org.springframework.graphql.data.pagination.CursorEncoder
Encode the given cursor value for external use.
encode(Map<String, Object>) - Method in class org.springframework.graphql.server.webflux.AbstractGraphQlHttpHandler
Encode the result map.
encodeResponseIfNecessary(WebGraphQlResponse) - Method in class org.springframework.graphql.server.webflux.AbstractGraphQlHttpHandler
Encode the GraphQL response if custom codecs were provided, or return the result map.
EncodingCursorStrategy<T> - Class in org.springframework.graphql.data.pagination
Decorator for a CursorStrategy that applies a CursorEncoder to the cursor String to make it opaque for external use.
EntityMapping - Annotation Interface in org.springframework.graphql.data.federation
Annotation for mapping a handler method to a federated schema type.
EntityMappingInfo(String, HandlerMethod) - Constructor for record class org.springframework.graphql.data.federation.FederationSchemaFactory.EntityMappingInfo
Creates an instance of a EntityMappingInfo record class.
equals(Object) - Method in class org.springframework.graphql.data.ArgumentValue
 
equals(Object) - Method in record class org.springframework.graphql.data.federation.FederationSchemaFactory.EntityMappingInfo
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.springframework.graphql.data.method.annotation.support.DataFetcherMappingInfo
 
equals(Object) - Method in class org.springframework.graphql.data.method.HandlerMethod
 
equals(Object) - Method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
 
equals(Object) - Method in class org.springframework.graphql.support.DefaultGraphQlRequest
 
error(String, List<GraphQLError>) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Create an "error" server message.
ERROR - Enum constant in enum class org.springframework.graphql.server.support.GraphQlWebSocketMessageType
Operation execution error(s) in response to the GraphQlWebSocketMessageType.SUBSCRIBE message.
ERROR_TYPE - Enum constant in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.DataFetcherLowCardinalityKeyNames
Class name of the data fetching error.
ERROR_TYPE - Enum constant in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.DataLoaderLowCardinalityKeyNames
Class name of the data fetching error.
errors(List<GraphQLError>) - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse.Builder
Set the errors of the GraphQL execution result.
errorType(DataFetcherObservationContext) - Method in class org.springframework.graphql.observation.DefaultDataFetcherObservationConvention
 
errorType(DataLoaderObservationContext) - Method in class org.springframework.graphql.observation.DefaultDataLoaderObservationConvention
 
ErrorType - Enum Class in org.springframework.graphql.execution
Common categories to use to classify for exceptions raised by DataFetcher's that can enable a client to make automated decisions.
exceptionResolvers(List<DataFetcherExceptionResolver>) - Method in class org.springframework.graphql.execution.AbstractGraphQlSourceBuilder
 
exceptionResolvers(List<DataFetcherExceptionResolver>) - Method in interface org.springframework.graphql.execution.GraphQlSource.Builder
Add DataFetcherExceptionResolver's that are invoked when a DataFetcher raises an exception.
execute() - Method in class org.springframework.graphql.client.DgsGraphQlClient.RequestSpec
Create GraphQLQueryRequest, serialize it to a String document to send, and delegate to the wrapped GraphQlClient.
execute() - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Execute request with a single response, e.g.
execute(ExecutionGraphQlRequest) - Method in class org.springframework.graphql.execution.DefaultExecutionGraphQlService
 
execute(ExecutionGraphQlRequest) - Method in interface org.springframework.graphql.ExecutionGraphQlService
Execute the request and return the response.
execute(GraphQlRequest) - Method in interface org.springframework.graphql.client.GraphQlTransport
Execute a request with a single response such as a "query" or "mutation".
execute(GraphQlRequest) - Method in interface org.springframework.graphql.client.SyncGraphQlTransport
Execute a request with a single response such as a "query" or "mutation".
executeSubscription() - Method in class org.springframework.graphql.client.DgsGraphQlClient.RequestSpec
Create GraphQLQueryRequest, serialize it to a String document to send, and delegate to the wrapped GraphQlClient.
executeSubscription() - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Execute a "subscription" request and return a stream of responses.
executeSubscription(GraphQlRequest) - Method in interface org.springframework.graphql.client.GraphQlTransport
Execute a "subscription" request with a stream of responses.
executeSync() - Method in class org.springframework.graphql.client.DgsGraphQlClient.RequestSpec
Create GraphQLQueryRequest, serialize it to a String document to send, and delegate to the wrapped GraphQlClient.
executeSync() - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Execute request with a single response, e.g.
EXECUTION_ID - Enum constant in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.ExecutionRequestHighCardinalityKeyNames
ExecutionId of the GraphQL request.
EXECUTION_REQUEST - Enum constant in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation
Observation created for GraphQL execution requests.
ExecutionGraphQlRequest - Interface in org.springframework.graphql
Implementation of GraphQlRequest for request handling through GraphQL Java with support for customizing the ExecutionInput passed into GraphQL.
ExecutionGraphQlResponse - Interface in org.springframework.graphql
Implementation of GraphQlResponse that wraps the ExecutionResult returned from GraphQL to expose it as GraphQlResponse, also providing access to the ExecutionInput used for the request.
ExecutionGraphQlService - Interface in org.springframework.graphql
Strategy to execute a GraphQL request by invoking GraphQL Java.
executionId(ExecutionId) - Method in interface org.springframework.graphql.ExecutionGraphQlRequest
Configure the ExecutionId to set on ExecutionInput.getExecutionId(), overriding the transport assigned id.
executionId(ExecutionId) - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlRequest
 
executionId(ExecutionRequestObservationContext) - Method in class org.springframework.graphql.observation.DefaultExecutionRequestObservationConvention
 
ExecutionRequestObservationContext - Class in org.springframework.graphql.observation
Context that holds information for metadata collection during observations for GraphQL requests.
ExecutionRequestObservationContext(ExecutionInput) - Constructor for class org.springframework.graphql.observation.ExecutionRequestObservationContext
 
ExecutionRequestObservationConvention - Interface in org.springframework.graphql.observation
Interface for an ObservationConvention for GraphQL requests.
extension(String, Object) - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Add a value for a protocol extension.
extensions(Map<Object, Object>) - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse.Builder
Set the extensions of the GraphQL execution result.
extensions(Map<String, Object>) - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Add all given protocol extensions.
EXTENSIONS_KEY - Static variable in class org.springframework.graphql.support.DefaultGraphQlRequest
 
extract(DataFetchingEnvironment) - Method in class org.springframework.graphql.data.query.AbstractSortStrategy
 
extract(DataFetchingEnvironment) - Method in interface org.springframework.graphql.data.query.SortStrategy
Return a Sort instance by extracting the sort information from GraphQL arguments, or Sort.unsorted() otherwise.
extractValues(ArgumentValue<?>, ValueExtractor.ValueReceiver) - Method in class org.springframework.graphql.data.method.annotation.support.ArgumentValueValueExtractor
 

F

FederationSchemaFactory - Class in org.springframework.graphql.data.federation
Detects @EntityMapping handler methods on controllers declared in Spring configuration, and provides factory methods to create GraphQLSchema or SchemaTransformer.
FederationSchemaFactory() - Constructor for class org.springframework.graphql.data.federation.FederationSchemaFactory
 
FederationSchemaFactory.EntityMappingInfo - Record Class in org.springframework.graphql.data.federation
 
field() - Element in annotation interface org.springframework.graphql.data.method.annotation.BatchMapping
Customize the name of the GraphQL field to bind to.
field() - Element in annotation interface org.springframework.graphql.data.method.annotation.SchemaMapping
Customize the name of the GraphQL field to bind to.
field(String) - Method in interface org.springframework.graphql.client.ClientGraphQlResponse
Navigate to the given path under the "data" key of the response map where the path is a dot-separated string with optional array indexes.
field(String) - Method in interface org.springframework.graphql.GraphQlResponse
Navigate to the given path under the "data" key of the response map where the path is a dot-separated string with optional array indexes.
field(String) - Method in class org.springframework.graphql.support.AbstractGraphQlResponse
 
FIELD_NAME - Enum constant in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.DataFetcherLowCardinalityKeyNames
Name of the field being fetched.
FIELD_PATH - Enum constant in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.DataFetcherHighCardinalityKeyNames
Path to the field being fetched.
FieldAccessException - Exception in org.springframework.graphql.client
An exception raised when an attempt is made to decode data from a response that is not valid or where field value is null, or there field errors.
FieldAccessException(ClientGraphQlRequest, ClientGraphQlResponse, ClientResponseField) - Constructor for exception org.springframework.graphql.client.FieldAccessException
Constructor with the request and response, and the accessed field.
fieldCoordinates() - Method in interface org.springframework.graphql.execution.SchemaReport.SkippedType
Return the coordinates of the field where the type was encountered.
fieldName(DataFetcherObservationContext) - Method in class org.springframework.graphql.observation.DefaultDataFetcherObservationConvention
 
fieldPath(DataFetcherObservationContext) - Method in class org.springframework.graphql.observation.DefaultDataFetcherObservationConvention
 
FILE_EXTENSIONS - Static variable in class org.springframework.graphql.support.ResourceDocumentSource
The default file extensions, ".graphql" and ".gql".
findProvidedArgument(MethodParameter, Object...) - Static method in class org.springframework.graphql.data.method.HandlerMethod
 
FORBIDDEN - Enum constant in enum class org.springframework.graphql.execution.ErrorType
DataFetcher refuses to authorize the fetching of the data value.
formatArgumentError(MethodParameter, String) - Static method in class org.springframework.graphql.data.method.HandlerMethod
 
formatInvokeError(String, Object[]) - Method in class org.springframework.graphql.data.method.HandlerMethod
 
formatRegistrations(RuntimeWiring.Builder) - Static method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer
 
forName(String) - Method in interface org.springframework.graphql.execution.BatchLoaderRegistry
Begin the registration of a new batch load function by specifying the name for the DataLoader.
forName(String) - Method in class org.springframework.graphql.execution.DefaultBatchLoaderRegistry
 
forSingleError(BiFunction<Throwable, DataFetchingEnvironment, GraphQLError>) - Static method in interface org.springframework.graphql.execution.DataFetcherExceptionResolver
Factory method to create a DataFetcherExceptionResolver to resolve an exception to a single GraphQL error.
forSingleError(Function<Throwable, GraphQLError>) - Static method in interface org.springframework.graphql.execution.SubscriptionExceptionResolver
Factory method to create a SubscriptionExceptionResolver to resolve an exception to a single GraphQL error.
forTypePair(Class<K>, Class<V>) - Method in interface org.springframework.graphql.execution.BatchLoaderRegistry
Begin the registration of a new batch load function by specifying the types of the keys and values that will be used as input and output.
forTypePair(Class<K>, Class<V>) - Method in class org.springframework.graphql.execution.DefaultBatchLoaderRegistry
 
forward() - Method in class org.springframework.graphql.data.pagination.Subrange
Whether the subrange is forward or backward from ths position, depending on whether the argument sent "first" or "last".
from(List<ConnectionAdapter>) - Static method in interface org.springframework.graphql.data.pagination.ConnectionAdapter
Create a composite ConnectionAdapter that checks which adapter supports a given Object container type and delegates to it.
fromCursor(String) - Method in interface org.springframework.graphql.data.pagination.CursorStrategy
Parse the given String cursor into a position Object.
fromCursor(String) - Method in class org.springframework.graphql.data.pagination.EncodingCursorStrategy
 
fromCursor(String) - Method in class org.springframework.graphql.data.query.JsonKeysetCursorStrategy
 
fromCursor(String) - Method in class org.springframework.graphql.data.query.ScrollPositionCursorStrategy
 
fromValue(String) - Static method in enum class org.springframework.graphql.server.support.GraphQlWebSocketMessageType
 

G

getApplicationContext() - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
 
getArgumentBinder() - Method in class org.springframework.graphql.data.method.annotation.support.ArgumentMethodArgumentResolver
Return the configured GraphQlArgumentBinder.
getArgumentResolver(MethodParameter) - Method in class org.springframework.graphql.data.method.HandlerMethodArgumentResolverComposite
Find a registered HandlerMethodArgumentResolver that supports the given method parameter.
getArgumentResolvers() - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
Return the configured argument resolvers.
getArguments() - Method in interface org.springframework.graphql.execution.SelfDescribingDataFetcher
Return a map with arguments that this DataFetcher looks up along with the Java types they are mapped to.
getAttributes() - Method in interface org.springframework.graphql.client.ClientGraphQlRequest
Return the client request attributes.
getAttributes() - Method in class org.springframework.graphql.server.WebGraphQlRequest
Return the request or WebSocket session attributes.
getAttributes() - Method in interface org.springframework.graphql.server.WebSocketSessionInfo
Return the map with attributes associated with the WebSocket session.
getAuthentication(Map<String, Object>) - Method in interface org.springframework.graphql.server.support.AuthenticationExtractor
Return the authentication contained in the given payload, or an empty Mono.
getAuthentication(Map<String, Object>) - Method in class org.springframework.graphql.server.support.BearerTokenAuthenticationExtractor
 
getBean() - Method in class org.springframework.graphql.data.method.HandlerMethod
Return the bean for this handler method.
getBeanType() - Method in class org.springframework.graphql.data.method.HandlerMethod
This method returns the type of the handler for this handler method.
getBridgedMethod() - Method in class org.springframework.graphql.data.method.HandlerMethod
If the bean method is a bridge method, this method returns the bridged (user-defined) method.
getBuilderInitializer() - Method in class org.springframework.graphql.client.AbstractGraphQlClientBuilder
Return a Consumer to initialize new builders from "this" builder.
getBuilderInitializer() - Method in class org.springframework.graphql.client.AbstractGraphQlClientSyncBuilder
Return a Consumer to initialize new builders from "this" builder.
getCloseStatus() - Method in exception org.springframework.graphql.client.WebSocketDisconnectedException
Return the CloseStatus used to close the WebSocket session.
getContainingClass() - Method in class org.springframework.graphql.data.method.HandlerMethod.HandlerMethodParameter
 
getContent(Object) - Method in interface org.springframework.graphql.data.pagination.ConnectionAdapter
Return the contained items as a List.
getContent(Object) - Method in class org.springframework.graphql.data.query.SliceConnectionAdapter
 
getContent(Object) - Method in class org.springframework.graphql.data.query.WindowConnectionAdapter
 
getContextToWrite(SecurityContext) - Method in class org.springframework.graphql.server.support.AbstractAuthenticationWebSocketInterceptor
Subclasses implement this to decide how to insert the SecurityContext into the Reactor context of the WebSocketGraphQlInterceptor chain.
getContextToWrite(SecurityContext) - Method in class org.springframework.graphql.server.webflux.AuthenticationWebSocketInterceptor
 
getContextToWrite(SecurityContext) - Method in class org.springframework.graphql.server.webmvc.AuthenticationWebSocketInterceptor
 
getContextualName(DataFetcherObservationContext) - Method in class org.springframework.graphql.observation.DefaultDataFetcherObservationConvention
 
getContextualName(DataLoaderObservationContext) - Method in class org.springframework.graphql.observation.DefaultDataLoaderObservationConvention
 
getContextualName(ExecutionRequestObservationContext) - Method in class org.springframework.graphql.observation.DefaultExecutionRequestObservationConvention
 
getConversionService() - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
 
getCookies() - Method in class org.springframework.graphql.server.WebGraphQlRequest
Return the cookies of the request of WebSocket handshake.
getCoordinates() - Method in class org.springframework.graphql.data.method.annotation.support.DataFetcherMappingInfo
The field to bind the controller method to.
getCursorStrategy() - Method in class org.springframework.graphql.data.pagination.ConnectionAdapterSupport
Return the configured CursorStrategy.
getData() - Method in interface org.springframework.graphql.GraphQlResponse
Return the data part of the response, or null when the response is not valid.
getData() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse
 
getDataLoader() - Method in class org.springframework.graphql.observation.DataLoaderObservationContext
Return the DataLoader being used for the operation.
getDelegate() - Method in class org.springframework.graphql.data.pagination.EncodingCursorStrategy
Return the decorated CursorStrategy.
getDescription() - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher
Provides shared implementation of SelfDescribingDataFetcher.getDescription() for all subclasses.
getDescription() - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher
Provides shared implementation of SelfDescribingDataFetcher.getDescription() for all subclasses.
getDescription() - Method in interface org.springframework.graphql.execution.SelfDescribingDataFetcher
Provide a description of the DataFetcher for display or logging purposes.
getDirection(DataFetchingEnvironment) - Method in class org.springframework.graphql.data.query.AbstractSortStrategy
Return the sort direction to use, or null.
getDocument() - Method in interface org.springframework.graphql.GraphQlRequest
Return the GraphQL document which is the textual representation of an operation (or operations) to perform, including any selection sets and fragments.
getDocument() - Method in class org.springframework.graphql.server.support.SerializableGraphQlRequest
 
getDocument() - Method in class org.springframework.graphql.support.DefaultGraphQlRequest
 
getDocument(String) - Method in class org.springframework.graphql.support.CachingDocumentSource
 
getDocument(String) - Method in interface org.springframework.graphql.support.DocumentSource
Return the document that matches the given name.
getDocument(String) - Method in class org.springframework.graphql.support.ResourceDocumentSource
 
getEncoder() - Method in class org.springframework.graphql.data.pagination.EncodingCursorStrategy
Return the configured CursorEncoder.
getEnvironment() - Method in class org.springframework.graphql.observation.DataFetcherObservationContext
Return the data fetching environment provided as an input.
getEnvironment() - Method in class org.springframework.graphql.observation.DataLoaderObservationContext
Return the environment given to the batch loading function.
getErrors() - Method in exception org.springframework.graphql.client.SubscriptionErrorException
Return the errors contained in the GraphQL over WebSocket "errors" message.
getErrors() - Method in exception org.springframework.graphql.execution.SubscriptionPublisherException
Return the GraphQL errors the exception was resolved to by the configured SubscriptionExceptionResolver's.
getErrors() - Method in interface org.springframework.graphql.GraphQlResponse
Return errors included in the response.
getErrors() - Method in interface org.springframework.graphql.ResponseField
Return all errors that have a path, and it is at above, or below the field path.
getErrors() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse
 
getErrorType() - Method in exception org.springframework.graphql.data.federation.RepresentationException
The classification for the error, ErrorType.BAD_REQUEST if the "__typename" argument was missing, or ErrorType.INTERNAL_ERROR otherwise.
getErrorType() - Method in interface org.springframework.graphql.ResponseError
Return a classification for the error that is specific to GraphQL Java.
getExceptionResolver() - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
Return a DataFetcherExceptionResolver that resolves exceptions with @GraphQlExceptionHandler methods in @ControllerAdvice classes declared in Spring configuration.
getExecutionId() - Method in interface org.springframework.graphql.ExecutionGraphQlRequest
Return the configured executionId.
getExecutionId() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlRequest
 
getExecutionInput() - Method in interface org.springframework.graphql.ExecutionGraphQlResponse
Return the ExecutionInput that was prepared through the ExecutionGraphQlRequest and passed to GraphQL.
getExecutionInput() - Method in class org.springframework.graphql.observation.ExecutionRequestObservationContext
Return the input for the request execution.
getExecutionInput() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse
 
getExecutionResult() - Method in interface org.springframework.graphql.ExecutionGraphQlResponse
Return the ExecutionResult that was returned from the invocation to GraphQL.
getExecutionResult() - Method in class org.springframework.graphql.observation.ExecutionRequestObservationContext
Return the result for the request execution.
getExecutionResult() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse
 
getExecutor() - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
getExtensions() - Method in interface org.springframework.graphql.GraphQlRequest
Return implementor specific, protocol extensions, if any.
getExtensions() - Method in interface org.springframework.graphql.GraphQlResponse
Return implementor specific, protocol extensions, if any.
getExtensions() - Method in interface org.springframework.graphql.ResponseError
Return a map with GraphQL Java and other implementation specific protocol error detail extensions such as ResponseError.getErrorType(), possibly empty.
getExtensions() - Method in class org.springframework.graphql.server.support.SerializableGraphQlRequest
 
getExtensions() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse
 
getExtensions() - Method in class org.springframework.graphql.support.DefaultGraphQlRequest
 
getExtensions() - Method in class org.springframework.graphql.support.ResourceDocumentSource
Return a read-only list with the file extensions to try when checking for documents by name.
getField() - Method in exception org.springframework.graphql.client.FieldAccessException
Return the field that needed to be accessed.
getFieldName() - Method in class org.springframework.graphql.data.method.annotation.support.DataFetcherMappingInfo
Shortcut for the fieldName from the coordinates.
getGraphQlClient() - Method in class org.springframework.graphql.client.DgsGraphQlClient
Return the wrapped GraphQlClient to delegate to.
getHandlerMethod() - Method in exception org.springframework.graphql.data.federation.RepresentationException
Return the mapped controller method, or null if it could not be mapped.
getHandlerMethod() - Method in class org.springframework.graphql.data.method.annotation.support.DataFetcherMappingInfo
The controller method to use for data fetching.
getHandlerMethod(M) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
 
getHandlerMethod(FederationSchemaFactory.EntityMappingInfo) - Method in class org.springframework.graphql.data.federation.FederationSchemaFactory
 
getHandlerMethod(DataFetcherMappingInfo) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer
 
getHeaders() - Method in class org.springframework.graphql.server.WebGraphQlRequest
Return the HTTP headers of the request or WebSocket handshake.
getHeaders() - Method in interface org.springframework.graphql.server.WebSocketSessionInfo
Return the HTTP headers from the handshake request.
getHighCardinalityKeyValues(DataFetcherObservationContext) - Method in class org.springframework.graphql.observation.DefaultDataFetcherObservationConvention
 
getHighCardinalityKeyValues(DataLoaderObservationContext) - Method in class org.springframework.graphql.observation.DefaultDataLoaderObservationConvention
 
getHighCardinalityKeyValues(ExecutionRequestObservationContext) - Method in class org.springframework.graphql.observation.DefaultExecutionRequestObservationConvention
 
getId() - Method in interface org.springframework.graphql.ExecutionGraphQlRequest
Return the transport assigned id for the request that in turn sets executionId.
getId() - Method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Return the request id that is applicable to messages associated with a request, or null for connection level messages.
getId() - Method in interface org.springframework.graphql.server.WebSocketSessionInfo
Return the id for the WebSocketSession.
getId() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlRequest
 
getInstance(GraphQLContext) - Static method in class org.springframework.graphql.execution.ContextPropagationHelper
Access the ContextSnapshotFactory from the given GraphQLContext or return a shared, static instance.
getInstance(ContextView) - Static method in class org.springframework.graphql.execution.ContextPropagationHelper
Access the ContextSnapshotFactory from the given ContextView or return a shared, static instance.
getInterceptors() - Method in class org.springframework.graphql.client.AbstractGraphQlClientBuilder
Return the configured interceptors.
getJsonDecoder() - Method in class org.springframework.graphql.client.AbstractGraphQlClientBuilder
Access to the configured JSON encoder.
getJsonEncoder() - Method in class org.springframework.graphql.client.AbstractGraphQlClientBuilder
Access to the configured JSON encoder.
getKeys() - Method in class org.springframework.graphql.observation.DataLoaderObservationContext
Return the keys for loading by the DataLoader.
getLocale() - Method in interface org.springframework.graphql.ExecutionGraphQlRequest
Return the transport assigned locale value, if any.
getLocale() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlRequest
 
getLocations() - Method in interface org.springframework.graphql.ResponseError
Return a list of locations in the GraphQL document, if the error can be associated to a particular point in the document.
getLocations() - Method in class org.springframework.graphql.support.ResourceDocumentSource
Return a read-only list with the configured locations where to check for documents.
getLowCardinalityKeyValues(DataFetcherObservationContext) - Method in class org.springframework.graphql.observation.DefaultDataFetcherObservationConvention
 
getLowCardinalityKeyValues(DataLoaderObservationContext) - Method in class org.springframework.graphql.observation.DefaultDataLoaderObservationConvention
 
getLowCardinalityKeyValues(ExecutionRequestObservationContext) - Method in class org.springframework.graphql.observation.DefaultExecutionRequestObservationConvention
 
getMappingInfo(Method, Object, Class<?>) - Method in class org.springframework.graphql.data.federation.FederationSchemaFactory
 
getMappingInfo(Method, Object, Class<?>) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer
 
getMappingInfo(Method, Object, Class<?>) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
 
getMappings() - Method in class org.springframework.graphql.execution.ClassNameTypeResolver
Return the map with configured explicit mappings.
getMaxBatchSize() - Method in class org.springframework.graphql.data.method.annotation.support.DataFetcherMappingInfo
A batch size limit to apply for a batch mapping method, or -1 if a limit does not apply.
getMessage() - Method in interface org.springframework.graphql.ResponseError
Return the message with a description of the error intended for the developer as a guide to understand and correct the error.
getMethod() - Method in class org.springframework.graphql.data.method.HandlerMethod
Return the method for this handler method.
getMethodAnnotation(Class<A>) - Method in class org.springframework.graphql.data.method.HandlerMethod
Return a single annotation on the underlying method traversing its super methods if no annotation can be found on the given method itself.
getMethodAnnotation(Class<T>) - Method in class org.springframework.graphql.data.method.HandlerMethod.HandlerMethodParameter
 
getMethodArgumentValues(DataFetchingEnvironment, Object...) - Method in class org.springframework.graphql.data.method.annotation.support.DataFetcherHandlerMethodSupport
Get the method argument values for the current request, checking the provided argument values and falling back to the configured argument resolvers.
getMethodParameters() - Method in class org.springframework.graphql.data.method.HandlerMethod
Return the method parameters for this handler method.
getName() - Method in class org.springframework.graphql.observation.DefaultDataFetcherObservationConvention
 
getName() - Method in class org.springframework.graphql.observation.DefaultDataLoaderObservationConvention
 
getName() - Method in class org.springframework.graphql.observation.DefaultExecutionRequestObservationConvention
 
getOperationName() - Method in interface org.springframework.graphql.GraphQlRequest
Return the name of the operation in the document to execute, if the document contains multiple operations.
getOperationName() - Method in class org.springframework.graphql.server.support.SerializableGraphQlRequest
 
getOperationName() - Method in class org.springframework.graphql.support.DefaultGraphQlRequest
 
getOrCreateReport() - Method in class org.springframework.graphql.execution.SchemaMappingInspector
Perform an inspection and create a SchemaReport.
getParameterAnnotations() - Method in class org.springframework.graphql.data.method.HandlerMethod.HandlerMethodParameter
 
getParsedPath() - Method in interface org.springframework.graphql.ResponseError
Return the path to a response field which experienced the error, if the error can be associated to a particular field in the result, or otherwise an empty list.
getParsedPath() - Method in interface org.springframework.graphql.ResponseField
Return a parsed representation of the field path, in the format described for error paths in Section 7.1.2, "Response Format" of the GraphQL spec.
getPath() - Method in interface org.springframework.graphql.ResponseError
Return a String representation of the parsed path, or an empty String if the error is not associated with a field.
getPath() - Method in interface org.springframework.graphql.ResponseField
Return a String representation of the field path as described in ClientGraphQlResponse.field(String).
getPayload() - Method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Return the payload.
getPrincipal() - Method in interface org.springframework.graphql.server.WebSocketSessionInfo
Return the principal associated with the handshake request, if any.
getProjectionFactory() - Method in class org.springframework.graphql.data.method.annotation.support.ProjectedPayloadMethodArgumentResolver
Return underlying projection factory used by the resolver.
getProperties(DataFetchingEnvironment) - Method in class org.springframework.graphql.data.query.AbstractSortStrategy
Return the sort properties to use, or an empty list if there are none.
getQuery() - Method in class org.springframework.graphql.server.support.SerializableGraphQlRequest
 
getRemoteAddress() - Method in class org.springframework.graphql.server.WebGraphQlRequest
Return the remote address of the client, if available.
getRemoteAddress() - Method in interface org.springframework.graphql.server.WebSocketSessionInfo
For a server session this is the remote address where the handshake request came from.
getRepresentation() - Method in exception org.springframework.graphql.data.federation.RepresentationException
Return the entity "representation" input map.
getRequest() - Method in exception org.springframework.graphql.client.GraphQlClientException
Return the request for which the error occurred.
getResolvers() - Method in class org.springframework.graphql.data.method.annotation.support.DataFetcherHandlerMethodSupport
Return the configured argument resolvers.
getResolvers() - Method in class org.springframework.graphql.data.method.HandlerMethodArgumentResolverComposite
Return a read-only list with the contained resolvers, or an empty list.
getResponse() - Method in exception org.springframework.graphql.client.FieldAccessException
Return the [@code GraphQlResponse} for which the error occurred.
getResponseHeaders() - Method in class org.springframework.graphql.server.WebGraphQlResponse
Return the headers to be added to the HTTP response.
getResult() - Method in class org.springframework.graphql.observation.DataLoaderObservationContext
Return the list of values resolved by the DataLoader, or an empty list if none were resolved.
getReturnType() - Method in class org.springframework.graphql.data.method.HandlerMethod
Return the HandlerMethod return type.
getReturnType() - Method in interface org.springframework.graphql.execution.SelfDescribingDataFetcher
The return type of this DataFetcher.
getReturnValueType(Object) - Method in class org.springframework.graphql.data.method.HandlerMethod
Return the actual return value type.
getSessionInfo() - Method in class org.springframework.graphql.server.WebSocketGraphQlRequest
Return information about the underlying WebSocket session.
getShortLogMessage() - Method in class org.springframework.graphql.data.method.HandlerMethod
Return a short representation of this handler method for log message purposes.
getSubProtocols() - Method in class org.springframework.graphql.server.webflux.GraphQlWebSocketHandler
 
getSubProtocols() - Method in class org.springframework.graphql.server.webmvc.GraphQlWebSocketHandler
 
getType() - Method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Return the message type value as it should appear on the wire.
getType(TypeResolutionEnvironment) - Method in class org.springframework.graphql.execution.ClassNameTypeResolver
 
getTypeName() - Method in class org.springframework.graphql.data.method.annotation.support.DataFetcherMappingInfo
Shortcut for the typeName from the coordinates.
getUri() - Method in class org.springframework.graphql.server.WebGraphQlRequest
Return the URL for the HTTP request or WebSocket handshake.
getUri() - Method in interface org.springframework.graphql.server.WebSocketSessionInfo
Return the URL for the WebSocket endpoint.
getValue() - Method in class org.springframework.graphql.execution.SecurityContextThreadLocalAccessor
 
getValue() - Method in class org.springframework.graphql.observation.DataFetcherObservationContext
Return the value returned by the DataFetcher, if any.
getValue() - Method in interface org.springframework.graphql.ResponseField
Return the raw field value, e.g.
getVariables() - Method in interface org.springframework.graphql.GraphQlRequest
Return values for variable defined by the operation.
getVariables() - Method in class org.springframework.graphql.server.support.SerializableGraphQlRequest
 
getVariables() - Method in class org.springframework.graphql.support.DefaultGraphQlRequest
 
getWebSocketInterceptor() - Method in interface org.springframework.graphql.server.WebGraphQlHandler
Return the single interceptor of type WebSocketGraphQlInterceptor among all the configured interceptors.
getWriteFunction(Map<String, Object>, MediaType) - Method in class org.springframework.graphql.server.webmvc.AbstractGraphQlHttpHandler
Exposes a ServerResponse.HeadersBuilder.WriteFunction that writes with the HttpMessageConverter provided to the constructor.
GraphiQlHandler - Class in org.springframework.graphql.server.webflux
Spring WebFlux handler to serve a GraphiQl UI page.
GraphiQlHandler - Class in org.springframework.graphql.server.webmvc
Spring MVC handler to serve a GraphiQl UI page.
GraphiQlHandler(String, String) - Constructor for class org.springframework.graphql.server.webflux.GraphiQlHandler
Constructor that serves the default graphiql/index.html included in the spring-graphql module.
GraphiQlHandler(String, String) - Constructor for class org.springframework.graphql.server.webmvc.GraphiQlHandler
Constructor that serves the default graphiql/index.html included in the spring-graphql module.
GraphiQlHandler(String, String, Resource) - Constructor for class org.springframework.graphql.server.webflux.GraphiQlHandler
Constructor with the HTML page to serve.
GraphiQlHandler(String, String, Resource) - Constructor for class org.springframework.graphql.server.webmvc.GraphiQlHandler
Constructor with the HTML page to serve.
graphQl() - Method in interface org.springframework.graphql.execution.GraphQlSource
Return the GraphQL to use.
GraphQlArgumentBinder - Class in org.springframework.graphql.data
Binder that instantiates and populates a target Object to reflect the complete structure of the GraphQL arguments input map.
GraphQlArgumentBinder() - Constructor for class org.springframework.graphql.data.GraphQlArgumentBinder
 
GraphQlArgumentBinder(ConversionService) - Constructor for class org.springframework.graphql.data.GraphQlArgumentBinder
 
GraphQlArgumentBinder(ConversionService, boolean) - Constructor for class org.springframework.graphql.data.GraphQlArgumentBinder
 
GraphQlClient - Interface in org.springframework.graphql.client
Define a workflow to execute GraphQL requests that is independent of the underlying transport.
GraphQlClient.BaseBuilder<B extends GraphQlClient.BaseBuilder<B>> - Interface in org.springframework.graphql.client
Base builder for creating and initializing a GraphQlClient.
GraphQlClient.Builder<B extends GraphQlClient.Builder<B>> - Interface in org.springframework.graphql.client
Builder to create a GraphQlClient with a non-blocking execution chain and transport.
GraphQlClient.RequestSpec - Interface in org.springframework.graphql.client
Declare options to gather input for a GraphQL request and execute it.
GraphQlClient.RetrieveSpec - Interface in org.springframework.graphql.client
Declares options to decode a field in a single response.
GraphQlClient.RetrieveSubscriptionSpec - Interface in org.springframework.graphql.client
Declares options to decode a field in each response of a subscription.
GraphQlClient.RetrieveSyncSpec - Interface in org.springframework.graphql.client
Declares options to decode a field in a single response.
GraphQlClient.SyncBuilder<B extends GraphQlClient.SyncBuilder<B>> - Interface in org.springframework.graphql.client
Builder to create a GraphQlClient instance with a synchronous execution chain and transport.
GraphQlClientException - Exception in org.springframework.graphql.client
Base class for exceptions from GraphQlClient.
GraphQlClientException(String, Throwable, GraphQlRequest) - Constructor for exception org.springframework.graphql.client.GraphQlClientException
Constructor with a message, optional cause, and the request details.
GraphQlClientInterceptor - Interface in org.springframework.graphql.client
Interceptor for GraphQlClient requests for use in a non-blocking execution chain with a non-blocking GraphQlTransport..
GraphQlClientInterceptor.Chain - Interface in org.springframework.graphql.client
Contract to delegate to the rest of a non-blocking execution chain.
GraphQlClientInterceptor.SubscriptionChain - Interface in org.springframework.graphql.client
Contract for delegation of subscription requests to the rest of the chain.
GraphQlContextAccessor - Class in org.springframework.graphql.execution
ContextAccessor that enables support for reading and writing values to and from a GraphQLContext.
GraphQlContextAccessor() - Constructor for class org.springframework.graphql.execution.GraphQlContextAccessor
 
GraphQlExceptionHandler - Annotation Interface in org.springframework.graphql.data.method.annotation
Declares a method as a handler of exceptions raised while fetching data for a field.
graphQlHttp(String) - Static method in class org.springframework.graphql.server.webflux.GraphQlRequestPredicates
Create a predicate that matches GraphQL HTTP requests for the configured path.
graphQlHttp(String) - Static method in class org.springframework.graphql.server.webmvc.GraphQlRequestPredicates
Create a predicate that matches GraphQL HTTP requests for the configured path.
GraphQlHttpHandler - Class in org.springframework.graphql.server.webflux
WebFlux.fn Handler for GraphQL over HTTP requests.
GraphQlHttpHandler - Class in org.springframework.graphql.server.webmvc
GraphQL handler to expose as a WebMvc functional endpoint via RouterFunctions.
GraphQlHttpHandler(WebGraphQlHandler) - Constructor for class org.springframework.graphql.server.webflux.GraphQlHttpHandler
Create a new instance.
GraphQlHttpHandler(WebGraphQlHandler) - Constructor for class org.springframework.graphql.server.webmvc.GraphQlHttpHandler
Create a new instance.
GraphQlHttpHandler(WebGraphQlHandler, CodecConfigurer) - Constructor for class org.springframework.graphql.server.webflux.GraphQlHttpHandler
Create a new instance.
GraphQlHttpHandler(WebGraphQlHandler, HttpMessageConverter<?>) - Constructor for class org.springframework.graphql.server.webmvc.GraphQlHttpHandler
Create a new instance with a custom message converter for GraphQL payloads.
GraphQlObservationDocumentation - Enum Class in org.springframework.graphql.observation
Documented KeyValues for GraphQL server observations.
GraphQlObservationDocumentation.DataFetcherHighCardinalityKeyNames - Enum Class in org.springframework.graphql.observation
 
GraphQlObservationDocumentation.DataFetcherLowCardinalityKeyNames - Enum Class in org.springframework.graphql.observation
 
GraphQlObservationDocumentation.DataLoaderHighCardinalityKeyNames - Enum Class in org.springframework.graphql.observation
 
GraphQlObservationDocumentation.DataLoaderLowCardinalityKeyNames - Enum Class in org.springframework.graphql.observation
 
GraphQlObservationDocumentation.ExecutionRequestHighCardinalityKeyNames - Enum Class in org.springframework.graphql.observation
 
GraphQlObservationDocumentation.ExecutionRequestLowCardinalityKeyNames - Enum Class in org.springframework.graphql.observation
 
GraphQlObservationInstrumentation - Class in org.springframework.graphql.observation
Instrumentation that creates observations for GraphQL requests and data fetcher operations.
GraphQlObservationInstrumentation(ObservationRegistry) - Constructor for class org.springframework.graphql.observation.GraphQlObservationInstrumentation
Create an GraphQlObservationInstrumentation that records observations against the given ObservationRegistry.
GraphQlObservationInstrumentation(ObservationRegistry, ExecutionRequestObservationConvention, DataFetcherObservationConvention) - Constructor for class org.springframework.graphql.observation.GraphQlObservationInstrumentation
Deprecated, for removal: This API element is subject to removal in a future version.
GraphQlObservationInstrumentation(ObservationRegistry, ExecutionRequestObservationConvention, DataFetcherObservationConvention, DataLoaderObservationConvention) - Constructor for class org.springframework.graphql.observation.GraphQlObservationInstrumentation
Create an GraphQlObservationInstrumentation that records observations against the given ObservationRegistry with a custom convention.
GraphQlRepository - Annotation Interface in org.springframework.graphql.data
Specialization of the Repository stereotype that marks a repository as intended for use in a GraphQL application for data fetching.
GraphQlRequest - Interface in org.springframework.graphql
Represents a GraphQL request with the inputs to pass to a GraphQL service including a document, operationName, and variables.
GraphQlRequestPredicates - Class in org.springframework.graphql.server.webflux
RequestPredicate implementations tailored for GraphQL reactive endpoints.
GraphQlRequestPredicates - Class in org.springframework.graphql.server.webmvc
RequestPredicate implementations tailored for GraphQL endpoints.
GraphQlResponse - Interface in org.springframework.graphql
Represents a GraphQL response with the result of executing a request operation.
GraphQlRSocketHandler - Class in org.springframework.graphql.server
Handler for GraphQL over RSocket requests.
GraphQlRSocketHandler(ExecutionGraphQlService, List<RSocketGraphQlInterceptor>, Encoder<?>) - Constructor for class org.springframework.graphql.server.GraphQlRSocketHandler
Create a new instance that handles requests through a chain of interceptors followed by the given ExecutionGraphQlService.
GraphQlSource - Interface in org.springframework.graphql.execution
Strategy to resolve a GraphQL and a GraphQLSchema.
GraphQlSource.Builder<B extends GraphQlSource.Builder<B>> - Interface in org.springframework.graphql.execution
Common configuration options for all GraphQlSource builders, independent of how GraphQLSchema is created.
GraphQlSource.Factory - Interface in org.springframework.graphql.execution
Strategy to create the GraphQlSource instance in GraphQlSource.Builder.build().
GraphQlSource.SchemaResourceBuilder - Interface in org.springframework.graphql.execution
GraphQlSource builder that relies on parsing schema definition files and uses a RuntimeWiring to create the underlying GraphQLSchema.
graphQlSourceFactory(GraphQlSource.Factory) - Method in class org.springframework.graphql.execution.AbstractGraphQlSourceBuilder
 
graphQlSourceFactory(GraphQlSource.Factory) - Method in interface org.springframework.graphql.execution.GraphQlSource.Builder
Configure a factory to use to create the GraphQlSource instance to return from the GraphQlSource.Builder.build() method.
graphQlSse(String) - Static method in class org.springframework.graphql.server.webflux.GraphQlRequestPredicates
Create a predicate that matches GraphQL SSE over HTTP requests for the configured path.
graphQlSse(String) - Static method in class org.springframework.graphql.server.webmvc.GraphQlRequestPredicates
Create a predicate that matches GraphQL SSE over HTTP requests for the configured path.
GraphQlSseHandler - Class in org.springframework.graphql.server.webflux
GraphQL handler that supports the GraphQL Server-Sent Events Protocol and to be exposed as a WebFlux.fn endpoint via RouterFunctions.
GraphQlSseHandler - Class in org.springframework.graphql.server.webmvc
GraphQL handler that supports the GraphQL Server-Sent Events Protocol and to be exposed as a WebMvc functional endpoint via RouterFunctions.
GraphQlSseHandler(WebGraphQlHandler) - Constructor for class org.springframework.graphql.server.webflux.GraphQlSseHandler
Basic constructor with the handler to delegate to, and no timeout by default, which results in never timing out.
GraphQlSseHandler(WebGraphQlHandler) - Constructor for class org.springframework.graphql.server.webmvc.GraphQlSseHandler
Constructor with the handler to delegate to, and no timeout, i.e.
GraphQlSseHandler(WebGraphQlHandler, Duration) - Constructor for class org.springframework.graphql.server.webflux.GraphQlSseHandler
Constructor with a timeout on how long to wait for the application to return the ServerResponse that will start the stream.
GraphQlSseHandler(WebGraphQlHandler, Duration) - Constructor for class org.springframework.graphql.server.webmvc.GraphQlSseHandler
Variant constructor with a timeout to use for SSE subscriptions.
GraphQlSseHandler(WebGraphQlHandler, Duration, Duration) - Constructor for class org.springframework.graphql.server.webflux.GraphQlSseHandler
Constructor with a keep-alive duration that determines how frequently to heartbeats during periods of inactivity.
GraphQlSseHandler(WebGraphQlHandler, Duration, Duration) - Constructor for class org.springframework.graphql.server.webmvc.GraphQlSseHandler
Variant constructor with a timeout to use for SSE subscriptions.
GraphQlTransport - Interface in org.springframework.graphql.client
Contract for executing GraphQL requests over some transport.
GraphQlTransportException - Exception in org.springframework.graphql.client
Exception raised by a GraphQlTransport or used to wrap an exception from a GraphQlTransport implementation.
GraphQlTransportException(String, Throwable, GraphQlRequest) - Constructor for exception org.springframework.graphql.client.GraphQlTransportException
Constructor with a given message.
GraphQlTransportException(Throwable, GraphQlRequest) - Constructor for exception org.springframework.graphql.client.GraphQlTransportException
Constructor with a default message.
GraphQlWebSocketHandler - Class in org.springframework.graphql.server.webflux
WebSocketHandler for GraphQL based on GraphQL Over WebSocket Protocol and for use in a Spring WebFlux application.
GraphQlWebSocketHandler - Class in org.springframework.graphql.server.webmvc
WebSocketHandler for GraphQL based on GraphQL Over WebSocket Protocol and for use on a Servlet container with spring-websocket.
GraphQlWebSocketHandler(WebGraphQlHandler, CodecConfigurer, Duration) - Constructor for class org.springframework.graphql.server.webflux.GraphQlWebSocketHandler
Create a new instance.
GraphQlWebSocketHandler(WebGraphQlHandler, CodecConfigurer, Duration, Duration) - Constructor for class org.springframework.graphql.server.webflux.GraphQlWebSocketHandler
Create a new instance.
GraphQlWebSocketHandler(WebGraphQlHandler, HttpMessageConverter<?>, Duration) - Constructor for class org.springframework.graphql.server.webmvc.GraphQlWebSocketHandler
Create a new instance.
GraphQlWebSocketHandler(WebGraphQlHandler, HttpMessageConverter<?>, Duration, Duration) - Constructor for class org.springframework.graphql.server.webmvc.GraphQlWebSocketHandler
Create a new instance.
GraphQlWebSocketMessage - Class in org.springframework.graphql.server.support
Represents a GraphQL over WebSocket protocol message.
GraphQlWebSocketMessageType - Enum Class in org.springframework.graphql.server.support
Enum for a message type as defined in the GraphQL over WebSocket spec proposal.

H

handle(Map<String, Object>) - Method in class org.springframework.graphql.server.GraphQlRSocketHandler
Handle a Request-Response interaction.
handle(WebSocketSession) - Method in class org.springframework.graphql.server.webflux.GraphQlWebSocketHandler
 
handleCancelledSubscription(WebSocketSessionInfo, String) - Method in interface org.springframework.graphql.server.WebSocketGraphQlInterceptor
Handle the "complete" message that a client sends to stop a subscription stream.
handleConnectionAck(Map<String, Object>) - Method in interface org.springframework.graphql.client.WebSocketGraphQlClientInterceptor
Handler the "connection_ack" message received from the server at the start of the WebSocket connection.
handleConnectionClosed(WebSocketSessionInfo, int, Map<String, Object>) - Method in interface org.springframework.graphql.server.WebSocketGraphQlInterceptor
Invoked when the WebSocket session is closed, from either side.
handleConnectionInitialization(WebSocketSessionInfo, Map<String, Object>) - Method in class org.springframework.graphql.server.support.AbstractAuthenticationWebSocketInterceptor
 
handleConnectionInitialization(WebSocketSessionInfo, Map<String, Object>) - Method in interface org.springframework.graphql.server.WebSocketGraphQlInterceptor
Handle the "connection_init" message at the start of a GraphQL over WebSocket session and return an optional payload for the "connection_ack" message to send back.
HandlerDataFetcherExceptionResolver - Interface in org.springframework.graphql.data.method.annotation.support
Extension of DataFetcherExceptionResolver with overloaded method to apply at the point of DataFetcher invocation to allow local exception handling.
handleRequest(WebGraphQlRequest) - Method in interface org.springframework.graphql.server.WebGraphQlHandler
Execute the given request and return the response.
handleRequest(ServerRequest) - Method in class org.springframework.graphql.server.webflux.AbstractGraphQlHttpHandler
Handle GraphQL over HTTP request.
handleRequest(ServerRequest) - Method in class org.springframework.graphql.server.webflux.GraphiQlHandler
Render the GraphiQL page as "text/html", or if the "path" query parameter is missing, add it and redirect back to the same URL.
handleRequest(ServerRequest) - Method in class org.springframework.graphql.server.webflux.SchemaHandler
 
handleRequest(ServerRequest) - Method in class org.springframework.graphql.server.webmvc.AbstractGraphQlHttpHandler
Handle GraphQL over HTTP requests.
handleRequest(ServerRequest) - Method in class org.springframework.graphql.server.webmvc.GraphiQlHandler
Render the GraphiQL page as "text/html", or if the "path" query parameter is missing, add it and redirect back to the same URL.
handleRequest(ServerRequest) - Method in class org.springframework.graphql.server.webmvc.SchemaHandler
 
handlerMethod() - Method in record class org.springframework.graphql.data.federation.FederationSchemaFactory.EntityMappingInfo
Returns the value of the handlerMethod record component.
HandlerMethod - Class in org.springframework.graphql.data.method
Encapsulates information about a handler method consisting of a method and a bean.
HandlerMethod(Object, Method) - Constructor for class org.springframework.graphql.data.method.HandlerMethod
Constructor with a handler instance and a method.
HandlerMethod(String, BeanFactory, Method) - Constructor for class org.springframework.graphql.data.method.HandlerMethod
Constructor with a bean name for the handler along with a BeanFactory to allow resolving the handler instance later.
HandlerMethod(HandlerMethod) - Constructor for class org.springframework.graphql.data.method.HandlerMethod
Copy constructor for use from subclasses that accept more arguments.
HandlerMethod.HandlerMethodParameter - Class in org.springframework.graphql.data.method
A MethodParameter with HandlerMethod-specific behavior.
HandlerMethodArgumentResolver - Interface in org.springframework.graphql.data.method
Strategy interface for resolving method parameters into argument values in the context of a given DataFetchingEnvironment.
HandlerMethodArgumentResolverComposite - Class in org.springframework.graphql.data.method
Container for a list of resolvers that looks for one that supports a given method parameter type, and delegates to it.
HandlerMethodArgumentResolverComposite() - Constructor for class org.springframework.graphql.data.method.HandlerMethodArgumentResolverComposite
 
HandlerMethodParameter(int) - Constructor for class org.springframework.graphql.data.method.HandlerMethod.HandlerMethodParameter
 
HandlerMethodParameter(HandlerMethod.HandlerMethodParameter) - Constructor for class org.springframework.graphql.data.method.HandlerMethod.HandlerMethodParameter
 
handleSubscription(Map<String, Object>) - Method in class org.springframework.graphql.server.GraphQlRSocketHandler
Handle a Request-Stream interaction.
handleTextMessage(WebSocketSession, TextMessage) - Method in class org.springframework.graphql.server.webmvc.GraphQlWebSocketHandler
 
hashCode() - Method in class org.springframework.graphql.data.ArgumentValue
 
hashCode() - Method in record class org.springframework.graphql.data.federation.FederationSchemaFactory.EntityMappingInfo
Returns a hash code value for this object.
hashCode() - Method in class org.springframework.graphql.data.method.annotation.support.DataFetcherMappingInfo
 
hashCode() - Method in class org.springframework.graphql.data.method.HandlerMethod
 
hashCode() - Method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
 
hashCode() - Method in class org.springframework.graphql.support.DefaultGraphQlRequest
 
hasMethodAnnotation(Class<A>) - Method in class org.springframework.graphql.data.method.HandlerMethod
Return whether the parameter is declared with the given annotation type.
hasMethodAnnotation(Class<T>) - Method in class org.springframework.graphql.data.method.HandlerMethod.HandlerMethodParameter
 
hasNext(Object) - Method in interface org.springframework.graphql.data.pagination.ConnectionAdapter
Whether there are more pages after this one.
hasNext(Object) - Method in class org.springframework.graphql.data.query.SliceConnectionAdapter
 
hasNext(Object) - Method in class org.springframework.graphql.data.query.WindowConnectionAdapter
 
hasPrevious(Object) - Method in interface org.springframework.graphql.data.pagination.ConnectionAdapter
Whether there are more pages before this one.
hasPrevious(Object) - Method in class org.springframework.graphql.data.query.SliceConnectionAdapter
 
hasPrevious(Object) - Method in class org.springframework.graphql.data.query.WindowConnectionAdapter
 
hasRegistrations() - Method in interface org.springframework.graphql.execution.DataLoaderRegistrar
Whether the registrar has any DataLoader registrations to make.
hasRegistrations() - Method in class org.springframework.graphql.execution.DefaultBatchLoaderRegistry
 
header(String, String...) - Method in interface org.springframework.graphql.client.HttpSyncGraphQlClient.Builder
Add the given header to HTTP requests.
header(String, String...) - Method in interface org.springframework.graphql.client.WebGraphQlClient.Builder
Add the given header to HTTP requests or to the WebSocket handshake request.
headers(Consumer<HttpHeaders>) - Method in interface org.springframework.graphql.client.HttpSyncGraphQlClient.Builder
Variant of HttpSyncGraphQlClient.Builder.header(String, String...) that provides access to the underlying headers to inspect or modify directly.
headers(Consumer<HttpHeaders>) - Method in interface org.springframework.graphql.client.WebGraphQlClient.Builder
Variant of WebGraphQlClient.Builder.header(String, String...) that provides access to the underlying headers to inspect or modify directly.
HttpGraphQlClient - Interface in org.springframework.graphql.client
GraphQL over HTTP client that uses WebClient.
HttpGraphQlClient.Builder<B extends HttpGraphQlClient.Builder<B>> - Interface in org.springframework.graphql.client
Builder for the GraphQL over HTTP client.
HttpSyncGraphQlClient - Interface in org.springframework.graphql.client
GraphQL over HTTP client with that uses RestClient in a blocking execution chain.
HttpSyncGraphQlClient.Builder<B extends HttpSyncGraphQlClient.Builder<B>> - Interface in org.springframework.graphql.client
Builder for the GraphQL over HTTP client with a blocking execution chain.

I

ifPresent(Consumer<? super T>) - Method in class org.springframework.graphql.data.ArgumentValue
If a value is present, performs the given action with the value, otherwise does nothing.
initArgumentResolvers() - Method in class org.springframework.graphql.data.federation.FederationSchemaFactory
 
initArgumentResolvers() - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer
 
initArgumentResolvers() - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
 
initGraphQlSchema() - Method in class org.springframework.graphql.execution.AbstractGraphQlSourceBuilder
Subclasses must implement this method to provide the GraphQLSchema instance.
initializer() - Static method in class org.springframework.graphql.execution.SchemaMappingInspector
Return an initializer to configure the SchemaMappingInspector and perform the inspection.
initWebSocketHttpRequestHandler(HandshakeHandler) - Method in class org.springframework.graphql.server.webmvc.GraphQlWebSocketHandler
Initialize a WebSocketHttpRequestHandler that wraps this instance and also inserts a HandshakeInterceptor for context propagation.
inspect(GraphQLSchema, RuntimeWiring) - Static method in class org.springframework.graphql.execution.SchemaMappingInspector
Check the schema against DataFetcher registrations, and produce a report.
inspect(GraphQLSchema, Map<String, Map<String, DataFetcher>>) - Method in interface org.springframework.graphql.execution.SchemaMappingInspector.Initializer
Perform the inspection and return a report.
inspect(GraphQLSchema, Map<String, Map<String, DataFetcher>>) - Static method in class org.springframework.graphql.execution.SchemaMappingInspector
Variant of SchemaMappingInspector.inspect(GraphQLSchema, RuntimeWiring) with a map of DataFetcher registrations.
inspectSchemaMappings(Consumer<SchemaMappingInspector.Initializer>, Consumer<SchemaReport>) - Method in interface org.springframework.graphql.execution.GraphQlSource.SchemaResourceBuilder
inspectSchemaMappings(Consumer<SchemaReport>) - Method in interface org.springframework.graphql.execution.GraphQlSource.SchemaResourceBuilder
Enable inspection of schema mappings to find unmapped fields and unmapped DataFetcher registrations.
instrumentation(List<Instrumentation>) - Method in class org.springframework.graphql.execution.AbstractGraphQlSourceBuilder
 
instrumentation(List<Instrumentation>) - Method in interface org.springframework.graphql.execution.GraphQlSource.Builder
Provide Instrumentation components to instrument the execution of GraphQL queries.
instrumentDataFetcher(DataFetcher<?>, InstrumentationFieldFetchParameters, InstrumentationState) - Method in class org.springframework.graphql.observation.GraphQlObservationInstrumentation
 
instrumentExecutionInput(ExecutionInput, InstrumentationExecutionParameters, InstrumentationState) - Method in class org.springframework.graphql.observation.GraphQlObservationInstrumentation
 
intercept(ClientGraphQlRequest, GraphQlClientInterceptor.Chain) - Method in interface org.springframework.graphql.client.GraphQlClientInterceptor
Intercept a single response request (query and mutation operations) and delegate to the rest of the chain including other interceptors followed by the GraphQlTransport.
intercept(ClientGraphQlRequest, SyncGraphQlClientInterceptor.Chain) - Method in interface org.springframework.graphql.client.SyncGraphQlClientInterceptor
Intercept a single response request (query and mutation operations), and delegate to the rest of the chain including other interceptors followed by the SyncGraphQlTransport.
intercept(RSocketGraphQlRequest, RSocketGraphQlInterceptor.Chain) - Method in interface org.springframework.graphql.server.RSocketGraphQlInterceptor
Intercept a request and delegate to the rest of the chain including other interceptors and a ExecutionGraphQlService.
intercept(WebGraphQlRequest, WebGraphQlInterceptor.Chain) - Method in class org.springframework.graphql.server.support.AbstractAuthenticationWebSocketInterceptor
 
intercept(WebGraphQlRequest, WebGraphQlInterceptor.Chain) - Method in class org.springframework.graphql.server.TimeoutWebGraphQlInterceptor
 
intercept(WebGraphQlRequest, WebGraphQlInterceptor.Chain) - Method in interface org.springframework.graphql.server.WebGraphQlInterceptor
Intercept a request and delegate to the rest of the chain including other interceptors and a ExecutionGraphQlService.
intercept(WebGraphQlRequest, WebGraphQlInterceptor.Chain) - Method in interface org.springframework.graphql.server.WebSocketGraphQlInterceptor
 
interceptor(GraphQlClientInterceptor...) - Method in class org.springframework.graphql.client.AbstractGraphQlClientBuilder
 
interceptor(GraphQlClientInterceptor...) - Method in interface org.springframework.graphql.client.GraphQlClient.Builder
Configure interceptors to be invoked before delegating to the GraphQlTransport to perform the request.
interceptor(SyncGraphQlClientInterceptor...) - Method in class org.springframework.graphql.client.AbstractGraphQlClientSyncBuilder
 
interceptor(SyncGraphQlClientInterceptor...) - Method in interface org.springframework.graphql.client.GraphQlClient.SyncBuilder
Configure interceptors to be invoked before delegating to the SyncGraphQlTransport to perform the request.
interceptor(WebGraphQlInterceptor...) - Method in interface org.springframework.graphql.server.WebGraphQlHandler.Builder
Configure interceptors to be invoked before the target GraphQlService.
interceptors(Consumer<List<GraphQlClientInterceptor>>) - Method in class org.springframework.graphql.client.AbstractGraphQlClientBuilder
 
interceptors(Consumer<List<GraphQlClientInterceptor>>) - Method in interface org.springframework.graphql.client.GraphQlClient.Builder
Customize the list of interceptors.
interceptors(Consumer<List<SyncGraphQlClientInterceptor>>) - Method in class org.springframework.graphql.client.AbstractGraphQlClientSyncBuilder
 
interceptors(Consumer<List<SyncGraphQlClientInterceptor>>) - Method in interface org.springframework.graphql.client.GraphQlClient.SyncBuilder
Customize the list of interceptors.
interceptors(List<WebGraphQlInterceptor>) - Method in interface org.springframework.graphql.server.WebGraphQlHandler.Builder
interceptSubscription(ClientGraphQlRequest, GraphQlClientInterceptor.SubscriptionChain) - Method in interface org.springframework.graphql.client.GraphQlClientInterceptor
Intercept a subscription request and delegate to the rest of the chain including other interceptors followed by the GraphQlTransport.
INTERNAL_ERROR - Enum constant in enum class org.springframework.graphql.execution.ErrorType
DataFetcher encountered an unexpected condition that prevented it from fetching the data value.
InvocableHandlerMethodSupport - Class in org.springframework.graphql.data.method
Extension of HandlerMethod that adds support for invoking the underlying handler methods.
InvocableHandlerMethodSupport(HandlerMethod, Executor) - Constructor for class org.springframework.graphql.data.method.InvocableHandlerMethodSupport
Deprecated, for removal: This API element is subject to removal in a future version.
in favor of alternative constructor
InvocableHandlerMethodSupport(HandlerMethod, Executor, boolean) - Constructor for class org.springframework.graphql.data.method.InvocableHandlerMethodSupport
Create an instance.
invoke(DataFetchingEnvironment) - Method in class org.springframework.graphql.data.method.annotation.support.DataFetcherHandlerMethod
Invoke the method after resolving its argument values in the context of the given DataFetchingEnvironment.
invoke(DataFetchingEnvironment, Object...) - Method in class org.springframework.graphql.data.method.annotation.support.DataFetcherHandlerMethod
Variant of DataFetcherHandlerMethod.invoke(DataFetchingEnvironment) that also accepts "given" arguments, which are matched by type.
invokeForIterable(Collection<?>, BatchLoaderEnvironment) - Method in class org.springframework.graphql.data.method.annotation.support.BatchLoaderHandlerMethod
Invoke the underlying batch loader method with a collection of input keys to return a collection of matching values.
invokeForMap(Collection<K>, BatchLoaderEnvironment) - Method in class org.springframework.graphql.data.method.annotation.support.BatchLoaderHandlerMethod
Invoke the underlying batch loader method with a collection of keys to return a Map of key-value pairs.
isBatchHandlerMethod() - Method in record class org.springframework.graphql.data.federation.FederationSchemaFactory.EntityMappingInfo
 
isBatchMapping() - Method in class org.springframework.graphql.data.method.annotation.support.DataFetcherMappingInfo
Whether it is an BatchMapping method or not in which case it is an SchemaMapping method.
isCacheEnabled() - Method in class org.springframework.graphql.support.CachingDocumentSource
Whether caching is enabled.
isCancelled(GraphQLContext) - Static method in class org.springframework.graphql.execution.ContextPropagationHelper
Return true if the current request has been cancelled, false otherwise.
isEmpty() - Method in class org.springframework.graphql.data.ArgumentValue
Return true if the input value was present in the input but the value was null, and false otherwise.
isFallBackOnDirectFieldAccess() - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
 
isHttpOkOnValidationErrors() - Method in class org.springframework.graphql.server.webflux.GraphQlHttpHandler
Return whether this HTTP handler should use HTTP 200 OK responses if an error occurs before the GraphQL request execution phase starts; for example, if JSON parsing, GraphQL document parsing, or GraphQL document validation fail.
isHttpOkOnValidationErrors() - Method in class org.springframework.graphql.server.webmvc.GraphQlHttpHandler
Return whether this HTTP handler should use HTTP 200 OK responses if an error occurs before the GraphQL request execution phase starts; for example, if JSON parsing, GraphQL document parsing, or GraphQL document validation fail.
isOmitted() - Method in class org.springframework.graphql.data.ArgumentValue
Return true if the input value was omitted altogether from the input, and false if it was provided, but possibly set to the "null" literal.
isPresent() - Method in class org.springframework.graphql.data.ArgumentValue
Return true if a non-null value is present, and false otherwise.
isSubscriptionType(GraphQLNamedType) - Method in interface org.springframework.graphql.execution.TypeVisitorHelper
Whether the given type is the subscription type.
isThreadLocalContextAware() - Method in class org.springframework.graphql.execution.DataFetcherExceptionResolverAdapter
Whether ThreadLocal context needs to be restored for this resolver.
isThreadLocalContextAware() - Method in class org.springframework.graphql.execution.SubscriptionExceptionResolverAdapter
Whether ThreadLocal context needs to be restored for this resolver.
isValid() - Method in interface org.springframework.graphql.GraphQlResponse
Whether the response is valid.
isValid() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse
 
isVoid() - Method in class org.springframework.graphql.data.method.HandlerMethod
Return true if the method return type is void, false otherwise.

J

jackson2Present - Static variable in class org.springframework.graphql.client.AbstractGraphQlClientBuilder
 
jackson2Present - Static variable in class org.springframework.graphql.client.AbstractGraphQlClientSyncBuilder
 
JsonKeysetCursorStrategy - Class in org.springframework.graphql.data.query
Strategy to convert a keyset to and from a JSON String for use with ScrollPositionCursorStrategy.
JsonKeysetCursorStrategy() - Constructor for class org.springframework.graphql.data.query.JsonKeysetCursorStrategy
Shortcut constructor that uses ServerCodecConfigurer.
JsonKeysetCursorStrategy(CodecConfigurer) - Constructor for class org.springframework.graphql.data.query.JsonKeysetCursorStrategy
Constructor with a CodecConfigurer in which to find the JSON encoder and decoder to use.

K

keepAlive(Duration) - Method in interface org.springframework.graphql.client.WebSocketGraphQlClient.Builder
Configure how frequently to send ping messages.
key() - Method in class org.springframework.graphql.execution.SecurityContextThreadLocalAccessor
 

L

LOADER_NAME - Enum constant in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.DataLoaderLowCardinalityKeyNames
DataLoader.getName() of the data loader.
LOADER_SIZE - Enum constant in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.DataLoaderHighCardinalityKeyNames
Size of the list of elements returned by the data loading operation.
loaderSize(DataLoaderObservationContext) - Method in class org.springframework.graphql.observation.DefaultDataLoaderObservationConvention
 
loaderType(DataLoaderObservationContext) - Method in class org.springframework.graphql.observation.DefaultDataLoaderObservationConvention
 
LocalContextValue - Annotation Interface in org.springframework.graphql.data.method.annotation
Annotation to bind a method parameter to an attribute from the local GraphQLContext.
LocalContextValueMethodArgumentResolver - Class in org.springframework.graphql.data.method.annotation.support
Resolver for a @LocalContextValue annotated method parameter.
LocalContextValueMethodArgumentResolver() - Constructor for class org.springframework.graphql.data.method.annotation.support.LocalContextValueMethodArgumentResolver
 
logger - Variable in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
 
logger - Static variable in class org.springframework.graphql.data.method.HandlerMethod
 
logger - Variable in class org.springframework.graphql.execution.DataFetcherExceptionResolverAdapter
 
logger - Variable in class org.springframework.graphql.execution.SubscriptionExceptionResolverAdapter
 
logger - Variable in class org.springframework.graphql.server.webflux.AbstractGraphQlHttpHandler
 
logger - Variable in class org.springframework.graphql.server.webmvc.AbstractGraphQlHttpHandler
 

M

many() - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.Builder
Build a DataFetcher to fetch many object instances.
many() - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.ReactiveBuilder
Build a DataFetcher to fetch many object instances.
many() - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.Builder
Build a DataFetcher to fetch many object instances.
many() - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.ReactiveBuilder
Build a DataFetcher to fetch many object instances.
maxBatchSize() - Element in annotation interface org.springframework.graphql.data.method.annotation.BatchMapping
Set the maximum number of keys to include a single batch, before splitting into multiple batches of keys to load.
MediaTypes - Class in org.springframework.graphql
Constants for well-known GraphQL media types.
MediaTypes() - Constructor for class org.springframework.graphql.MediaTypes
 
messageConverters(Consumer<List<HttpMessageConverter<?>>>) - Method in interface org.springframework.graphql.client.HttpSyncGraphQlClient.Builder
Configure message converters for JSON for use in the GraphQlResponse to convert response data to higher level objects.
MissingSchemaException - Exception in org.springframework.graphql.execution
Indicates that no GraphQL schema definition was configured on the GraphQlSource.Builder.
MissingSchemaException() - Constructor for exception org.springframework.graphql.execution.MissingSchemaException
 
mutate() - Method in interface org.springframework.graphql.client.GraphQlClient
Return a builder initialized from the configuration of "this" client to use to build a new, independently configured client instance.
mutate() - Method in interface org.springframework.graphql.client.HttpGraphQlClient
 
mutate() - Method in interface org.springframework.graphql.client.HttpSyncGraphQlClient
 
mutate() - Method in interface org.springframework.graphql.client.RSocketGraphQlClient
 
mutate() - Method in interface org.springframework.graphql.client.WebGraphQlClient
 
mutate() - Method in interface org.springframework.graphql.client.WebSocketGraphQlClient
 
MutationMapping - Annotation Interface in org.springframework.graphql.data.method.annotation
@MutationMapping is a composed annotation that acts as a shortcut for @SchemaMapping with typeName="Mutation".

N

name() - Element in annotation interface org.springframework.graphql.data.federation.EntityMapping
Customize the name of the entity to map to.
name() - Element in annotation interface org.springframework.graphql.data.method.annotation.Argument
The name of the input argument to bind to.
name() - Element in annotation interface org.springframework.graphql.data.method.annotation.ContextValue
The name of the value to bind to.
name() - Element in annotation interface org.springframework.graphql.data.method.annotation.LocalContextValue
The name of the value to bind to.
name() - Element in annotation interface org.springframework.graphql.data.method.annotation.MutationMapping
name() - Element in annotation interface org.springframework.graphql.data.method.annotation.QueryMapping
name() - Element in annotation interface org.springframework.graphql.data.method.annotation.SubscriptionMapping
next(String, Map<String, Object>) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Create a "next" server message.
next(ClientGraphQlRequest) - Method in interface org.springframework.graphql.client.GraphQlClientInterceptor.Chain
Delegate to the rest of the chain to perform the request.
next(ClientGraphQlRequest) - Method in interface org.springframework.graphql.client.GraphQlClientInterceptor.SubscriptionChain
Delegate to the rest of the chain to perform the request.
next(ClientGraphQlRequest) - Method in interface org.springframework.graphql.client.SyncGraphQlClientInterceptor.Chain
Delegate to the rest of the chain to perform the request.
next(RSocketGraphQlRequest) - Method in interface org.springframework.graphql.server.RSocketGraphQlInterceptor.Chain
Delegate to the rest of the chain to execute the request.
next(WebGraphQlRequest) - Method in interface org.springframework.graphql.server.WebGraphQlInterceptor.Chain
Delegate to the rest of the chain to execute the request.
NEXT - Enum constant in enum class org.springframework.graphql.server.support.GraphQlWebSocketMessageType
Operation execution result(s) from the source stream created by the binding GraphQlWebSocketMessageType.SUBSCRIBE message.
noOpEncoder() - Static method in interface org.springframework.graphql.data.pagination.CursorEncoder
Return a CursorEncoder that does not encode nor decode.
NOT_FOUND - Enum constant in enum class org.springframework.graphql.execution.ErrorType
DataFetcher did not find a data value or is not willing to disclose that one exists.
NOT_SPECIFIED - Enum constant in enum class org.springframework.graphql.server.support.GraphQlWebSocketMessageType
Indicates the GraphQL message did not have a message type.

O

obtainApplicationContext() - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
 
ofNullable(T) - Static method in class org.springframework.graphql.data.ArgumentValue
Static factory method for an argument value that was provided, even if it was set to "null.
omitted() - Static method in class org.springframework.graphql.data.ArgumentValue
Static factory method for an argument value that was omitted.
operation(ExecutionRequestObservationContext) - Method in class org.springframework.graphql.observation.DefaultExecutionRequestObservationConvention
 
OPERATION - Enum constant in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.ExecutionRequestLowCardinalityKeyNames
GraphQL Operation name.
OPERATION_NAME_KEY - Static variable in class org.springframework.graphql.support.DefaultGraphQlRequest
 
operationName(String) - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Set the name of the operation in the document to execute, if the document contains multiple operations.
org.springframework.graphql - package org.springframework.graphql
Top level abstractions for processing GraphQL requests.
org.springframework.graphql.client - package org.springframework.graphql.client
This package contains a GraphQlClient along with HTTP and WebSocket extensions.
org.springframework.graphql.data - package org.springframework.graphql.data
Support for various ways to implement DataFetchers.
org.springframework.graphql.data.federation - package org.springframework.graphql.data.federation
Integration for Apollo federation that provides a FederationSchemaFactory to set up the schema with, and supports the fetching of federated types via @EntityMapping controller methods.
org.springframework.graphql.data.method - package org.springframework.graphql.data.method
Support for DataFetcher's based on handler methods typically annotated with SchemaMapping annotations.
org.springframework.graphql.data.method.annotation - package org.springframework.graphql.data.method.annotation
Annotations for binding data fetching methods to GraphQL schema queries, mutations, subscriptions, and fields.
org.springframework.graphql.data.method.annotation.support - package org.springframework.graphql.data.method.annotation.support
Resolvers for method parameters of annotated handler methods.
org.springframework.graphql.data.pagination - package org.springframework.graphql.data.pagination
Core contracts and generic infrastructure classes for pagination.
org.springframework.graphql.data.query - package org.springframework.graphql.data.query
DataFetcher implementations built on Spring Data extensions such as Query by Example and Querydsl.
org.springframework.graphql.execution - package org.springframework.graphql.execution
Support for GraphQL request execution, including abstractions to configure and invoke GraphQL.
org.springframework.graphql.observation - package org.springframework.graphql.observation
Support for GraphQL observability.
org.springframework.graphql.server - package org.springframework.graphql.server
Server transports handling GraphQL requests over the HTTP, WebSocket, and RSocket.
org.springframework.graphql.server.support - package org.springframework.graphql.server.support
Support classes for Web transports.
org.springframework.graphql.server.webflux - package org.springframework.graphql.server.webflux
HTTP and WebSocket handlers for use in a Spring WebFlux application.
org.springframework.graphql.server.webmvc - package org.springframework.graphql.server.webmvc
HTTP and WebSocket handlers for use in a Spring WebMvc application.
org.springframework.graphql.support - package org.springframework.graphql.support
Support classes for Spring GraphQL.
outcome(DataFetcherObservationContext) - Method in class org.springframework.graphql.observation.DefaultDataFetcherObservationConvention
 
outcome(DataLoaderObservationContext) - Method in class org.springframework.graphql.observation.DefaultDataLoaderObservationConvention
 
outcome(ExecutionRequestObservationContext) - Method in class org.springframework.graphql.observation.DefaultExecutionRequestObservationConvention
 
OUTCOME - Enum constant in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.DataFetcherLowCardinalityKeyNames
Outcome of the GraphQL data fetching operation.
OUTCOME - Enum constant in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.DataLoaderLowCardinalityKeyNames
Outcome of the GraphQL data fetching operation.
OUTCOME - Enum constant in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.ExecutionRequestLowCardinalityKeyNames
Outcome of the GraphQL request.

P

ping(Object) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Create a "ping" client or server message.
PING - Enum constant in enum class org.springframework.graphql.server.support.GraphQlWebSocketMessageType
Useful for detecting failed connections, displaying latency metrics or other types of network probing.
pong(Object) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Create a "pong" client or server message.
PONG - Enum constant in enum class org.springframework.graphql.server.support.GraphQlWebSocketMessageType
The response to the GraphQlWebSocketMessageType.PING message.
position() - Method in class org.springframework.graphql.data.pagination.Subrange
The position of the result element the subrange is relative to.
prepareResponse(ServerRequest, WebGraphQlResponse) - Method in class org.springframework.graphql.server.webflux.AbstractGraphQlHttpHandler
Prepare the ServerResponse for the given GraphQL response.
prepareResponse(ServerRequest, WebGraphQlResponse) - Method in class org.springframework.graphql.server.webflux.GraphQlHttpHandler
 
prepareResponse(ServerRequest, WebGraphQlResponse) - Method in class org.springframework.graphql.server.webflux.GraphQlSseHandler
 
prepareResponse(ServerRequest, Mono<WebGraphQlResponse>) - Method in class org.springframework.graphql.server.webmvc.AbstractGraphQlHttpHandler
Prepare the ServerResponse for the given GraphQL response.
prepareResponse(ServerRequest, Mono<WebGraphQlResponse>) - Method in class org.springframework.graphql.server.webmvc.GraphQlHttpHandler
 
prepareResponse(ServerRequest, Mono<WebGraphQlResponse>) - Method in class org.springframework.graphql.server.webmvc.GraphQlSseHandler
 
PrincipalMethodArgumentResolver - Class in org.springframework.graphql.data.method.annotation.support
Resolver to obtain Principal from Spring Security context via SecurityContext.getAuthentication().
PrincipalMethodArgumentResolver() - Constructor for class org.springframework.graphql.data.method.annotation.support.PrincipalMethodArgumentResolver
 
projectAs(Class<P>) - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.Builder
Project results returned from the QueryByExampleExecutor into the target projectionType.
projectAs(Class<P>) - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.ReactiveBuilder
Project results returned from the ReactiveQueryByExampleExecutor into the target projectionType.
projectAs(Class<P>) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.Builder
Project results returned from the QuerydslPredicateExecutor into the target projectionType.
projectAs(Class<P>) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.ReactiveBuilder
Project results returned from the ReactiveQuerydslPredicateExecutor into the target projectionType.
ProjectedPayloadMethodArgumentResolver - Class in org.springframework.graphql.data.method.annotation.support
Resolver for a method parameter that is an interface annotated with @ProjectedPayload.
ProjectedPayloadMethodArgumentResolver(ApplicationContext) - Constructor for class org.springframework.graphql.data.method.annotation.support.ProjectedPayloadMethodArgumentResolver
Create a new ProjectedPayloadMethodArgumentResolver using the given context.
projection(BaseProjectionNode) - Method in class org.springframework.graphql.client.DgsGraphQlClient.RequestSpec
Provide a BaseProjectionNode that defines the response selection set.

Q

QUERY_KEY - Static variable in class org.springframework.graphql.support.DefaultGraphQlRequest
 
QueryByExampleDataFetcher<T> - Class in org.springframework.graphql.data.query
Main class to create a DataFetcher from a Query By Example repository.
QueryByExampleDataFetcher.Builder<T,R> - Class in org.springframework.graphql.data.query
Builder for a Query by Example-based DataFetcher.
QueryByExampleDataFetcher.QueryByExampleBuilderCustomizer<T> - Interface in org.springframework.graphql.data.query
Callback interface that can be used to customize QueryByExampleDataFetcher QueryByExampleDataFetcher.Builder to change its configuration.
QueryByExampleDataFetcher.ReactiveBuilder<T,R> - Class in org.springframework.graphql.data.query
Builder for a reactive Query by Example-based DataFetcher.
QueryByExampleDataFetcher.ReactiveQueryByExampleBuilderCustomizer<T> - Interface in org.springframework.graphql.data.query
Callback interface that can be used to customize QueryByExampleDataFetcher QueryByExampleDataFetcher.ReactiveBuilder to change its configuration.
QuerydslDataFetcher<T> - Class in org.springframework.graphql.data.query
Main class to create a DataFetcher from a Querydsl repository.
QuerydslDataFetcher.Builder<T,R> - Class in org.springframework.graphql.data.query
Builder for a Querydsl-based DataFetcher.
QuerydslDataFetcher.QuerydslBuilderCustomizer<T> - Interface in org.springframework.graphql.data.query
Callback interface that can be used to customize QuerydslDataFetcher QuerydslDataFetcher.Builder to change its configuration.
QuerydslDataFetcher.ReactiveBuilder<T,R> - Class in org.springframework.graphql.data.query
Builder for a reactive Querydsl-based DataFetcher.
QuerydslDataFetcher.ReactiveQuerydslBuilderCustomizer<T> - Interface in org.springframework.graphql.data.query
Callback interface that can be used to customize QuerydslDataFetcher QuerydslDataFetcher.ReactiveBuilder to change its configuration.
QueryMapping - Annotation Interface in org.springframework.graphql.data.method.annotation
@QueryMapping is a composed annotation that acts as a shortcut for @SchemaMapping with typeName="Query".

R

ReactiveAdapterRegistryHelper - Class in org.springframework.graphql.execution
Helper to adapt a result Object to Mono or Flux through ReactiveAdapterRegistry.
ReactiveAdapterRegistryHelper() - Constructor for class org.springframework.graphql.execution.ReactiveAdapterRegistryHelper
 
ReactiveSecurityDataFetcherExceptionResolver - Class in org.springframework.graphql.execution
Reactive DataFetcherExceptionResolver for Spring Security exceptions.
ReactiveSecurityDataFetcherExceptionResolver() - Constructor for class org.springframework.graphql.execution.ReactiveSecurityDataFetcherExceptionResolver
 
readableType() - Method in class org.springframework.graphql.execution.GraphQlContextAccessor
 
readValue(GraphQLContext, Object) - Method in class org.springframework.graphql.execution.GraphQlContextAccessor
 
readValues(GraphQLContext, Predicate<Object>, Map<Object, Object>) - Method in class org.springframework.graphql.execution.GraphQlContextAccessor
 
registerBatchLoader(BiFunction<List<K>, BatchLoaderEnvironment, Flux<V>>) - Method in interface org.springframework.graphql.execution.BatchLoaderRegistry.RegistrationSpec
Register the give batch loading function.
registerDataLoaders(DataLoaderRegistry, GraphQLContext) - Method in interface org.springframework.graphql.execution.DataLoaderRegistrar
Callback that provides access to the DataLoaderRegistry from the the ExecutionInput.
registerDataLoaders(DataLoaderRegistry, GraphQLContext) - Method in class org.springframework.graphql.execution.DefaultBatchLoaderRegistry
 
registerMappedBatchLoader(BiFunction<Set<K>, BatchLoaderEnvironment, Mono<Map<K, V>>>) - Method in interface org.springframework.graphql.execution.BatchLoaderRegistry.RegistrationSpec
A variant of BatchLoaderRegistry.RegistrationSpec.registerBatchLoader(BiFunction) that returns a Map of key-value pairs, which is useful is there aren't values for all keys.
RepresentationException - Exception in org.springframework.graphql.data.federation
Raised when a representation could not be resolved because: The "__typename" argument is missing.
RepresentationException(Map<String, Object>, String) - Constructor for exception org.springframework.graphql.data.federation.RepresentationException
 
RepresentationException(Map<String, Object>, HandlerMethod, String) - Constructor for exception org.springframework.graphql.data.federation.RepresentationException
 
RepresentationNotResolvedException - Exception in org.springframework.graphql.data.federation
Specialization of RepresentationException that indicates a resolver returned null or completed empty.
RepresentationNotResolvedException(Map<String, Object>, HandlerMethod) - Constructor for exception org.springframework.graphql.data.federation.RepresentationNotResolvedException
 
request(GraphQLQuery) - Method in class org.springframework.graphql.client.DgsGraphQlClient
Start defining a GraphQL request for the given GraphQLQuery.
required() - Element in annotation interface org.springframework.graphql.data.method.annotation.ContextValue
Whether the value is required.
required() - Element in annotation interface org.springframework.graphql.data.method.annotation.LocalContextValue
Whether the value is required.
requiresProjection(Class<?>) - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher
 
requiresProjection(Class<?>) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher
 
reset() - Method in class org.springframework.graphql.execution.SecurityContextThreadLocalAccessor
Deprecated, for removal: This API element is subject to removal in a future version.
resolveArgument(MethodParameter, DataFetchingEnvironment) - Method in class org.springframework.graphql.data.method.annotation.support.ArgumentMethodArgumentResolver
 
resolveArgument(MethodParameter, DataFetchingEnvironment) - Method in class org.springframework.graphql.data.method.annotation.support.ArgumentsMethodArgumentResolver
 
resolveArgument(MethodParameter, DataFetchingEnvironment) - Method in class org.springframework.graphql.data.method.annotation.support.AuthenticationPrincipalArgumentResolver
 
resolveArgument(MethodParameter, DataFetchingEnvironment) - Method in class org.springframework.graphql.data.method.annotation.support.ContextValueMethodArgumentResolver
 
resolveArgument(MethodParameter, DataFetchingEnvironment) - Method in class org.springframework.graphql.data.method.annotation.support.ContinuationHandlerMethodArgumentResolver
 
resolveArgument(MethodParameter, DataFetchingEnvironment) - Method in class org.springframework.graphql.data.method.annotation.support.DataFetchingEnvironmentMethodArgumentResolver
 
resolveArgument(MethodParameter, DataFetchingEnvironment) - Method in class org.springframework.graphql.data.method.annotation.support.DataLoaderMethodArgumentResolver
 
resolveArgument(MethodParameter, DataFetchingEnvironment) - Method in class org.springframework.graphql.data.method.annotation.support.LocalContextValueMethodArgumentResolver
 
resolveArgument(MethodParameter, DataFetchingEnvironment) - Method in class org.springframework.graphql.data.method.annotation.support.PrincipalMethodArgumentResolver
 
resolveArgument(MethodParameter, DataFetchingEnvironment) - Method in class org.springframework.graphql.data.method.annotation.support.ProjectedPayloadMethodArgumentResolver
 
resolveArgument(MethodParameter, DataFetchingEnvironment) - Method in class org.springframework.graphql.data.method.annotation.support.SortMethodArgumentResolver
 
resolveArgument(MethodParameter, DataFetchingEnvironment) - Method in class org.springframework.graphql.data.method.annotation.support.SourceMethodArgumentResolver
 
resolveArgument(MethodParameter, DataFetchingEnvironment) - Method in class org.springframework.graphql.data.method.annotation.support.SubrangeMethodArgumentResolver
 
resolveArgument(MethodParameter, DataFetchingEnvironment) - Method in interface org.springframework.graphql.data.method.HandlerMethodArgumentResolver
Resolve a method parameter to a value.
resolveArgument(MethodParameter, DataFetchingEnvironment) - Method in class org.springframework.graphql.data.method.HandlerMethodArgumentResolverComposite
Iterate over registered HandlerMethodArgumentResolvers and invoke the one that supports it.
resolveClass(GraphQLObjectType, GraphQLNamedOutputType) - Method in interface org.springframework.graphql.execution.SchemaMappingInspector.ClassResolver
Return Java class(es) for the given GraphQL object type.
resolvedType() - Method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Return the message type as an enum.
resolveException(Throwable) - Method in interface org.springframework.graphql.execution.SubscriptionExceptionResolver
Resolve the given exception to a list of GraphQLError's to be sent in an error message to the client.
resolveException(Throwable) - Method in class org.springframework.graphql.execution.SubscriptionExceptionResolverAdapter
 
resolveException(Throwable, DataFetchingEnvironment) - Method in interface org.springframework.graphql.data.method.annotation.support.HandlerDataFetcherExceptionResolver
 
resolveException(Throwable, DataFetchingEnvironment) - Method in interface org.springframework.graphql.execution.DataFetcherExceptionResolver
Resolve the given exception and return the error(s) to add to the response.
resolveException(Throwable, DataFetchingEnvironment) - Method in class org.springframework.graphql.execution.DataFetcherExceptionResolverAdapter
 
resolveException(Throwable, DataFetchingEnvironment) - Method in class org.springframework.graphql.execution.ReactiveSecurityDataFetcherExceptionResolver
 
resolveException(Throwable, DataFetchingEnvironment, Object) - Method in interface org.springframework.graphql.data.method.annotation.support.HandlerDataFetcherExceptionResolver
Resolve an exception raised by the given handler.
resolvers - Variable in class org.springframework.graphql.data.method.annotation.support.DataFetcherHandlerMethodSupport
 
resolveToMultipleErrors(Throwable) - Method in class org.springframework.graphql.execution.SubscriptionExceptionResolverAdapter
Override this method to resolve the Exception to multiple GraphQL errors.
resolveToMultipleErrors(Throwable, DataFetchingEnvironment) - Method in class org.springframework.graphql.execution.DataFetcherExceptionResolverAdapter
Override this method to resolve an Exception to multiple GraphQL errors.
resolveToSingleError(Throwable) - Method in class org.springframework.graphql.execution.SubscriptionExceptionResolverAdapter
Override this method to resolve the Exception to a single GraphQL error.
resolveToSingleError(Throwable, DataFetchingEnvironment) - Method in class org.springframework.graphql.execution.DataFetcherExceptionResolverAdapter
Override this method to resolve an Exception to a single GraphQL error.
resolveToSingleError(Throwable, DataFetchingEnvironment) - Method in class org.springframework.graphql.execution.SecurityDataFetcherExceptionResolver
 
ResourceDocumentSource - Class in org.springframework.graphql.support
DocumentSource that looks for a document Resource under a set of locations and trying a number of different file extension.
ResourceDocumentSource() - Constructor for class org.springframework.graphql.support.ResourceDocumentSource
Default constructor that sets the location to "classpath:graphql/" and the extensions to ".graphql" and ".gql".
ResourceDocumentSource(List<Resource>, List<String>) - Constructor for class org.springframework.graphql.support.ResourceDocumentSource
Constructor with given locations and extensions.
ResponseError - Interface in org.springframework.graphql
Represents a GraphQL response error.
ResponseField - Interface in org.springframework.graphql
Representation for a field in a GraphQL response, with options to examine the field value and errors.
restClient(Consumer<RestClient.Builder>) - Method in interface org.springframework.graphql.client.HttpSyncGraphQlClient.Builder
Customize the underlying RestClient.
restore() - Method in class org.springframework.graphql.execution.SecurityContextThreadLocalAccessor
 
restore(Object) - Method in class org.springframework.graphql.execution.SecurityContextThreadLocalAccessor
 
restoreInternal(Object) - Method in class org.springframework.graphql.execution.SecurityContextThreadLocalAccessor
 
retrieve() - Method in class org.springframework.graphql.client.DgsGraphQlClient.RequestSpec
Create GraphQLQueryRequest, serialize it to a String document to send, and delegate to the wrapped GraphQlClient.
retrieve(String) - Method in class org.springframework.graphql.client.DgsGraphQlClient.RequestSpec
Variant of DgsGraphQlClient.RequestSpec.retrieve() with explicit path relative to the "data" key.
retrieve(String) - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Shortcut for GraphQlClient.RequestSpec.execute() with a field path to decode from.
retrieveSubscription() - Method in class org.springframework.graphql.client.DgsGraphQlClient.RequestSpec
Create GraphQLQueryRequest, serialize it to a String document to send, and delegate to the wrapped GraphQlClient.
retrieveSubscription(String) - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Shortcut for GraphQlClient.RequestSpec.executeSubscription() with a field path to decode from for each result.
retrieveSync() - Method in class org.springframework.graphql.client.DgsGraphQlClient.RequestSpec
Create GraphQLQueryRequest, serialize it to a String document to send, and delegate to the wrapped GraphQlClient.
retrieveSync(String) - Method in class org.springframework.graphql.client.DgsGraphQlClient.RequestSpec
Variant of DgsGraphQlClient.RequestSpec.executeSync() with explicit path relative to the "data" key.
retrieveSync(String) - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Shortcut for GraphQlClient.RequestSpec.executeSync() with a field path to decode from.
route(String) - Method in interface org.springframework.graphql.client.RSocketGraphQlClient.Builder
Customize the route to specify in the metadata of each request so the server can route it to the handler for GraphQL requests.
RSocketGraphQlClient - Interface in org.springframework.graphql.client
GraphQL over RSocket client that uses RSocketRequester.
RSocketGraphQlClient.Builder<B extends RSocketGraphQlClient.Builder<B>> - Interface in org.springframework.graphql.client
Builder for the GraphQL over HTTP client.
RSocketGraphQlInterceptor - Interface in org.springframework.graphql.server
Interceptor for server handling of GraphQL over RSocket requests, allowing customization of the ExecutionInput and the ExecutionResult.
RSocketGraphQlInterceptor.Chain - Interface in org.springframework.graphql.server
Contract for delegation to the rest of the chain.
RSocketGraphQlRequest - Class in org.springframework.graphql.server
GraphQlRequest implementation for server handling over RSocket.
RSocketGraphQlRequest(Map<String, Object>, String, Locale) - Constructor for class org.springframework.graphql.server.RSocketGraphQlRequest
Create an instance.
RSocketGraphQlResponse - Class in org.springframework.graphql.server
GraphQlResponse implementation for server handling over RSocket.
RSocketGraphQlResponse(ExecutionGraphQlResponse) - Constructor for class org.springframework.graphql.server.RSocketGraphQlResponse
Create an instance that wraps the given ExecutionGraphQlResponse.
RSocketGraphQlResponse.Builder - Class in org.springframework.graphql.server
Builder to transform a RSocketGraphQlResponse.
rsocketRequester(Consumer<RSocketRequester.Builder>) - Method in interface org.springframework.graphql.client.RSocketGraphQlClient.Builder
Customize the underlying RSocketRequester to use.
RuntimeWiringConfigurer - Interface in org.springframework.graphql.execution
Callbacks that allow applying changes to the RuntimeWiring.Builder in GraphQlSource.Builder.

S

saveInstance(ContextSnapshotFactory, GraphQLContext) - Static method in class org.springframework.graphql.execution.ContextPropagationHelper
Save the ContextSnapshotFactory in the given Context.
saveInstance(ContextSnapshotFactory, Context) - Static method in class org.springframework.graphql.execution.ContextPropagationHelper
Save the ContextSnapshotFactory in the given Context.
scheduler(Scheduler) - Method in class org.springframework.graphql.client.AbstractGraphQlClientSyncBuilder
 
scheduler(Scheduler) - Method in interface org.springframework.graphql.client.GraphQlClient.SyncBuilder
The scheduler to use for non-blocking execution with GraphQlClient.RequestSpec.execute() and GraphQlClient.RequestSpec.retrieve(String).
schema() - Method in interface org.springframework.graphql.execution.GraphQlSource
Return the GraphQLSchema used by the current GraphQL.
schema() - Method in interface org.springframework.graphql.execution.SchemaReport
Return the inspected schema with type and field definitions.
schemaFactory(BiFunction<TypeDefinitionRegistry, RuntimeWiring, GraphQLSchema>) - Method in interface org.springframework.graphql.execution.GraphQlSource.SchemaResourceBuilder
Configure a function to create the GraphQLSchema from the given TypeDefinitionRegistry and RuntimeWiring.
SchemaHandler - Class in org.springframework.graphql.server.webflux
Spring WebFlux functional handler that renders the GraphQLSchema printed via SchemaPrinter.
SchemaHandler - Class in org.springframework.graphql.server.webmvc
Spring MVC functional handler that renders the GraphQLSchema printed via SchemaPrinter.
SchemaHandler(GraphQlSource) - Constructor for class org.springframework.graphql.server.webflux.SchemaHandler
 
SchemaHandler(GraphQlSource) - Constructor for class org.springframework.graphql.server.webmvc.SchemaHandler
 
SchemaMapping - Annotation Interface in org.springframework.graphql.data.method.annotation
Annotation to express the mapping of a handler method to a GraphQL type and field pair.
SchemaMappingInspector - Class in org.springframework.graphql.execution
Inspect schema mappings on startup to ensure the following: Schema fields have either a DataFetcher registration or a corresponding Class property.
SchemaMappingInspector.ClassResolver - Interface in org.springframework.graphql.execution
Strategy to resolve the Java class(es) for a GraphQLObjectType, effectively the reverse of TypeResolver, for schema inspection purposes.
SchemaMappingInspector.Initializer - Interface in org.springframework.graphql.execution
Helps to configure SchemaMappingInspector.
SchemaReport - Interface in org.springframework.graphql.execution
Report produced as a result of inspecting schema mappings.
SchemaReport.SkippedType - Interface in org.springframework.graphql.execution
Information about a schema type skipped during the inspection.
schemaResourceBuilder() - Static method in interface org.springframework.graphql.execution.GraphQlSource
Return a GraphQlSource builder that parses GraphQL Schema resources and uses RuntimeWiring to create the GraphQLSchema.
schemaResources(Resource...) - Method in interface org.springframework.graphql.execution.GraphQlSource.SchemaResourceBuilder
Add schema definition resources, typically ".graphqls" files, to be parsed and merged.
scrollable() - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.Builder
Build a DataFetcher that scrolls and returns Window.
scrollable() - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.ReactiveBuilder
Build a DataFetcher that scrolls and returns Window.
scrollable() - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.Builder
Build a DataFetcher that scrolls and returns Window.
scrollable() - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.ReactiveBuilder
Build a DataFetcher that scrolls and returns Window.
ScrollPositionCursorStrategy - Class in org.springframework.graphql.data.query
Strategy to convert a ScrollPosition to and from a String cursor.
ScrollPositionCursorStrategy() - Constructor for class org.springframework.graphql.data.query.ScrollPositionCursorStrategy
Shortcut constructor that uses JsonKeysetCursorStrategy.
ScrollPositionCursorStrategy(CursorStrategy<Map<String, Object>>) - Constructor for class org.springframework.graphql.data.query.ScrollPositionCursorStrategy
Constructor with a given strategy to convert a keyset to and from a cursor.
ScrollSubrange - Class in org.springframework.graphql.data.query
Subrange implementation for a ScrollPosition cursor.
ScrollSubrangeMethodArgumentResolver - Class in org.springframework.graphql.data.method.annotation.support
A SubrangeMethodArgumentResolver that supports ScrollSubrange and ScrollPosition as cursor.
ScrollSubrangeMethodArgumentResolver(CursorStrategy<ScrollPosition>) - Constructor for class org.springframework.graphql.data.method.annotation.support.ScrollSubrangeMethodArgumentResolver
 
SecurityContextThreadLocalAccessor - Class in org.springframework.graphql.execution
ThreadLocalAccessor to extract and restore security context through SecurityContextHolder.
SecurityContextThreadLocalAccessor() - Constructor for class org.springframework.graphql.execution.SecurityContextThreadLocalAccessor
 
SecurityDataFetcherExceptionResolver - Class in org.springframework.graphql.execution
DataFetcherExceptionResolver for Spring Security exceptions.
SecurityDataFetcherExceptionResolver() - Constructor for class org.springframework.graphql.execution.SecurityDataFetcherExceptionResolver
 
selectInstance(ContextSnapshotFactory) - Static method in class org.springframework.graphql.execution.ContextPropagationHelper
Select a ContextSnapshotFactory instance to use, either the one passed in if it is not null, or a shared, static instance.
selectResponseStatus(WebGraphQlResponse, MediaType) - Method in class org.springframework.graphql.server.webflux.GraphQlHttpHandler
 
selectResponseStatus(WebGraphQlResponse, MediaType) - Method in class org.springframework.graphql.server.webmvc.GraphQlHttpHandler
 
SelfDescribingDataFetcher<T> - Interface in org.springframework.graphql.execution
Specialized DataFetcher that exposes additional details such as return type information.
SerializableGraphQlRequest - Class in org.springframework.graphql.server.support
GraphQlRequest for deserialization from a request.
SerializableGraphQlRequest() - Constructor for class org.springframework.graphql.server.support.SerializableGraphQlRequest
 
setApplicationContext(ApplicationContext) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
 
setAuthenticationTrustResolver(AuthenticationTrustResolver) - Method in class org.springframework.graphql.execution.ReactiveSecurityDataFetcherExceptionResolver
Set the resolver to use to check if an authentication is anonymous that in turn determines whether AccessDeniedException is classified as "unauthorized" or "forbidden".
setAuthenticationTrustResolver(AuthenticationTrustResolver) - Method in class org.springframework.graphql.execution.SecurityDataFetcherExceptionResolver
Set the resolver to use to check if an authentication is anonymous that in turn determines whether AccessDeniedException is classified as "unauthorized" or "forbidden".
setBlockingMethodPredicate(Predicate<HandlerMethod>) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
Configure a predicate to decide which controller methods are blocking.
setCacheEnabled(boolean) - Method in class org.springframework.graphql.support.CachingDocumentSource
Enable or disable caching of resolved documents.
setClassNameExtractor(Function<Class<?>, String>) - Method in class org.springframework.graphql.execution.ClassNameTypeResolver
Customize how the name of a class, or a base class/interface, is determined.
setExecutionResult(ExecutionResult) - Method in class org.springframework.graphql.observation.ExecutionRequestObservationContext
Set the result for the request execution.
setExecutor(Executor) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
Configure an Executor to use for asynchronous handling of Callable return values from controller methods, as well as for blocking controller methods on Java 21+.
setExtensions(Map<String, Object>) - Method in class org.springframework.graphql.server.support.SerializableGraphQlRequest
 
setFallBackOnDirectFieldAccess(boolean) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
Whether binding GraphQL arguments onto @Argument should falls back to direct field access in case the target object does not use accessor methods.
setHttpOkOnValidationErrors(boolean) - Method in class org.springframework.graphql.server.webflux.GraphQlHttpHandler
Deprecated, for removal: This API element is subject to removal in a future version.
since 1.4, will be made false permanently in a future release
setHttpOkOnValidationErrors(boolean) - Method in class org.springframework.graphql.server.webmvc.GraphQlHttpHandler
Deprecated, for removal: This API element is subject to removal in a future version.
since 1.4, will be made false permanently in a future release
setId(String) - Method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
 
setJsonCodecs(Encoder<?>, Decoder<?>) - Method in class org.springframework.graphql.client.AbstractGraphQlClientBuilder
Transport-specific subclasses can provide their JSON Encoder and Decoder for use at the client level, for mapping response data to some target entity type.
setJsonConverter(HttpMessageConverter<Object>) - Method in class org.springframework.graphql.client.AbstractGraphQlClientSyncBuilder
Transport-specific subclasses can provide their JSON Encoder and Decoder for use at the client level, for mapping response data to some target entity type.
setJsonDecoder(Decoder<?>) - Method in class org.springframework.graphql.client.AbstractGraphQlClientBuilder
setJsonEncoder(Encoder<?>) - Method in class org.springframework.graphql.client.AbstractGraphQlClientBuilder
setOperationName(String) - Method in class org.springframework.graphql.server.support.SerializableGraphQlRequest
 
setPayload(Object) - Method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
 
setQuery(String) - Method in class org.springframework.graphql.server.support.SerializableGraphQlRequest
 
setResult(List<?>) - Method in class org.springframework.graphql.observation.DataLoaderObservationContext
Set the list of resolved values by the DataLoader.
setThreadLocalContextAware(boolean) - Method in class org.springframework.graphql.execution.DataFetcherExceptionResolverAdapter
Subclasses can set this to indicate that ThreadLocal context from the transport handler (e.g.
setThreadLocalContextAware(boolean) - Method in class org.springframework.graphql.execution.SubscriptionExceptionResolverAdapter
Subclasses can set this to indicate that ThreadLocal context from the transport handler (e.g.
setType(String) - Method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
 
setTypeDefinitionRegistry(TypeDefinitionRegistry) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer
 
setTypeDefinitionRegistry(TypeDefinitionRegistry) - Method in interface org.springframework.graphql.execution.RuntimeWiringConfigurer
Provides the configurer access to the TypeDefinitionRegistry.
setTypeResolver(TypeResolver) - Method in class org.springframework.graphql.data.federation.FederationSchemaFactory
Configure a resolver that helps to map Java to entity schema type names.
setValue() - Method in class org.springframework.graphql.execution.SecurityContextThreadLocalAccessor
 
setValue(Object) - Method in class org.springframework.graphql.execution.SecurityContextThreadLocalAccessor
 
setVariables(Map<String, Object>) - Method in class org.springframework.graphql.server.support.SerializableGraphQlRequest
 
shouldInvokeAsync(HandlerMethod) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
 
single() - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.Builder
Build a DataFetcher to fetch single object instances.
single() - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.ReactiveBuilder
Build a DataFetcher to fetch single object instances.
single() - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.Builder
Build a DataFetcher to fetch single object instances.
single() - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.ReactiveBuilder
Build a DataFetcher to fetch single object instances}.
skippedTypes() - Method in interface org.springframework.graphql.execution.SchemaReport
Return types skipped during the inspection, either because the schema type is not supported, e.g.
SliceConnectionAdapter - Class in org.springframework.graphql.data.query
Adapter for Slice to Connection.
SliceConnectionAdapter(CursorStrategy<ScrollPosition>) - Constructor for class org.springframework.graphql.data.query.SliceConnectionAdapter
Constructor with the CursorStrategy to use to encode the ScrollPosition of page items.
sortBy(Sort) - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.Builder
Apply a Sort order.
sortBy(Sort) - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.ReactiveBuilder
Apply a Sort order.
sortBy(Sort) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.Builder
Apply a Sort order.
sortBy(Sort) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.ReactiveBuilder
Apply a Sort order.
SortMethodArgumentResolver - Class in org.springframework.graphql.data.method.annotation.support
Resolver for method arguments of type Sort.
SortMethodArgumentResolver(SortStrategy) - Constructor for class org.springframework.graphql.data.method.annotation.support.SortMethodArgumentResolver
 
SortStrategy - Interface in org.springframework.graphql.data.query
Strategy to extract Sort details from GraphQL arguments.
SourceMethodArgumentResolver - Class in org.springframework.graphql.data.method.annotation.support
Resolver for the source/parent of a field, obtained via DataFetchingEnvironment.getSource().
SourceMethodArgumentResolver() - Constructor for class org.springframework.graphql.data.method.annotation.support.SourceMethodArgumentResolver
 
springSecurityPresent - Static variable in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport
 
start() - Method in interface org.springframework.graphql.client.RSocketGraphQlClient
Start the RSocket session.
start() - Method in interface org.springframework.graphql.client.WebSocketGraphQlClient
Start the GraphQL session by connecting the WebSocket, sending the "connection_init" and receiving the "connection_ack" message.
stop() - Method in interface org.springframework.graphql.client.RSocketGraphQlClient
Stop the RSocket session.
stop() - Method in interface org.springframework.graphql.client.WebSocketGraphQlClient
Stop the GraphQL session by closing the WebSocket with CloseStatus.NORMAL and terminating in-progress requests with an error signal.
Subrange<P> - Class in org.springframework.graphql.data.pagination
Container for parameters that limit result elements to a subrange including a relative position, number of elements, and direction.
Subrange(P, Integer, boolean) - Constructor for class org.springframework.graphql.data.pagination.Subrange
Constructor with the relative position, count, and direction.
SubrangeMethodArgumentResolver<P> - Class in org.springframework.graphql.data.method.annotation.support
Resolver for a method argument of type Subrange initialized from "first", "last", "before", and "after" GraphQL arguments.
SubrangeMethodArgumentResolver(CursorStrategy<P>) - Constructor for class org.springframework.graphql.data.method.annotation.support.SubrangeMethodArgumentResolver
 
subscribe(String, GraphQlRequest) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Create a "subscribe" client message.
SUBSCRIBE - Enum constant in enum class org.springframework.graphql.server.support.GraphQlWebSocketMessageType
Requests an operation specified in the message payload.
SubscriptionErrorException - Exception in org.springframework.graphql.client
WebSocket GraphQlTransportException raised when a subscription ends with an "error" message.
SubscriptionErrorException(GraphQlRequest, List<ResponseError>) - Constructor for exception org.springframework.graphql.client.SubscriptionErrorException
Constructor with the request details and the errors listed in the payload of the "errors" message.
SubscriptionExceptionResolver - Interface in org.springframework.graphql.execution
Contract for a component that is invoked when a GraphQL subscription Publisher ends with an error.
SubscriptionExceptionResolverAdapter - Class in org.springframework.graphql.execution
SubscriptionExceptionResolverAdapter() - Constructor for class org.springframework.graphql.execution.SubscriptionExceptionResolverAdapter
 
subscriptionExceptionResolvers(List<SubscriptionExceptionResolver>) - Method in class org.springframework.graphql.execution.AbstractGraphQlSourceBuilder
 
subscriptionExceptionResolvers(List<SubscriptionExceptionResolver>) - Method in interface org.springframework.graphql.execution.GraphQlSource.Builder
Add SubscriptionExceptionResolvers that are invoked when a GraphQL subscription Publisher ends with error, and given a chance to resolve the exception to one or more GraphQL errors to be sent to the client.
SubscriptionMapping - Annotation Interface in org.springframework.graphql.data.method.annotation
@SubscriptionMapping is a composed annotation that acts as a shortcut for @SchemaMapping with typeName="Subscription".
SubscriptionPublisherException - Exception in org.springframework.graphql.execution
An exception raised after a GraphQL subscription Publisher ends with an exception, and after that exception has been resolved to GraphQL errors.
SubscriptionPublisherException(List<GraphQLError>, Throwable) - Constructor for exception org.springframework.graphql.execution.SubscriptionPublisherException
Constructor with the resolved GraphQL errors and the original exception from the GraphQL subscription Publisher.
supports(Class<?>) - Method in interface org.springframework.graphql.data.pagination.ConnectionAdapter
Whether the adapter supports the given Object container type.
supports(Class<?>) - Method in interface org.springframework.graphql.data.pagination.CursorStrategy
Whether the strategy supports the given type of position Object.
supports(Class<?>) - Method in class org.springframework.graphql.data.pagination.EncodingCursorStrategy
 
supports(Class<?>) - Method in class org.springframework.graphql.data.query.JsonKeysetCursorStrategy
 
supports(Class<?>) - Method in class org.springframework.graphql.data.query.ScrollPositionCursorStrategy
 
supports(Class<?>) - Method in class org.springframework.graphql.data.query.SliceConnectionAdapter
 
supports(Class<?>) - Method in class org.springframework.graphql.data.query.WindowConnectionAdapter
 
supportsContext(Observation.Context) - Method in interface org.springframework.graphql.observation.DataFetcherObservationConvention
 
supportsContext(Observation.Context) - Method in interface org.springframework.graphql.observation.DataLoaderObservationConvention
 
supportsContext(Observation.Context) - Method in interface org.springframework.graphql.observation.ExecutionRequestObservationConvention
 
supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.ArgumentMethodArgumentResolver
 
supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.ArgumentsMethodArgumentResolver
 
supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.AuthenticationPrincipalArgumentResolver
 
supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.ContextValueMethodArgumentResolver
 
supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.ContinuationHandlerMethodArgumentResolver
 
supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.DataFetchingEnvironmentMethodArgumentResolver
 
supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.DataLoaderMethodArgumentResolver
 
supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.LocalContextValueMethodArgumentResolver
 
supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.PrincipalMethodArgumentResolver
Return "true" if the argument is Principal or a subtype.
supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.ProjectedPayloadMethodArgumentResolver
 
supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.ScrollSubrangeMethodArgumentResolver
 
supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.SortMethodArgumentResolver
 
supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.SourceMethodArgumentResolver
 
supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.SubrangeMethodArgumentResolver
 
supportsParameter(MethodParameter) - Method in interface org.springframework.graphql.data.method.HandlerMethodArgumentResolver
Whether this resolver supports the given MethodParameter.
supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.HandlerMethodArgumentResolverComposite
Whether the given method parameter is supported by any registered HandlerMethodArgumentResolver.
SyncGraphQlClientInterceptor - Interface in org.springframework.graphql.client
Interceptor of GraphQlClient requests for use in a blocking execution chain with a SyncGraphQlTransport.
SyncGraphQlClientInterceptor.Chain - Interface in org.springframework.graphql.client
Contract to delegate to the rest of a blocking execution chain.
SyncGraphQlTransport - Interface in org.springframework.graphql.client
Contract for blocking execution of GraphQL requests over some transport.

T

tcp(String, int) - Method in interface org.springframework.graphql.client.RSocketGraphQlClient.Builder
Select TCP as the underlying network protocol.
TimeoutWebGraphQlInterceptor - Class in org.springframework.graphql.server
Web interceptor that enforces a request timeout for GraphQL requests.
TimeoutWebGraphQlInterceptor(Duration) - Constructor for class org.springframework.graphql.server.TimeoutWebGraphQlInterceptor
Create a new interceptor for the given timeout duration.
TimeoutWebGraphQlInterceptor(Duration, HttpStatus) - Constructor for class org.springframework.graphql.server.TimeoutWebGraphQlInterceptor
Create a new interceptor for the given timeout duration and response status.
toArgsMono(Object[]) - Method in class org.springframework.graphql.data.method.InvocableHandlerMethodSupport
Use this method to resolve the arguments asynchronously.
toCursor(Map<String, Object>) - Method in class org.springframework.graphql.data.query.JsonKeysetCursorStrategy
 
toCursor(ScrollPosition) - Method in class org.springframework.graphql.data.query.ScrollPositionCursorStrategy
 
toCursor(P) - Method in interface org.springframework.graphql.data.pagination.CursorStrategy
Format the given position Object as a String cursor.
toCursor(T) - Method in class org.springframework.graphql.data.pagination.EncodingCursorStrategy
 
toEntity(Class<D>) - Method in interface org.springframework.graphql.client.ClientGraphQlResponse
Decode the full response map to the given target type.
toEntity(Class<D>) - Method in interface org.springframework.graphql.client.ClientResponseField
Decode the field to an entity of the given type.
toEntity(Class<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSpec
Decode the field to an entity of the given type.
toEntity(Class<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSubscriptionSpec
Decode the field to an entity of the given type.
toEntity(Class<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSyncSpec
Decode the field to an entity of the given type.
toEntity(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.client.ClientGraphQlResponse
toEntity(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.client.ClientResponseField
toEntity(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSpec
toEntity(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSubscriptionSpec
toEntity(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSyncSpec
toEntityList(Class<D>) - Method in interface org.springframework.graphql.client.ClientResponseField
Variant of ClientResponseField.toEntity(Class) to decode to a list of entities.
toEntityList(Class<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSpec
Variant of GraphQlClient.RetrieveSpec.toEntity(Class) to decode to a List of entities.
toEntityList(Class<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSubscriptionSpec
Variant of GraphQlClient.RetrieveSubscriptionSpec.toEntity(Class) to decode each response to a List of entities.
toEntityList(Class<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSyncSpec
Variant of GraphQlClient.RetrieveSyncSpec.toEntity(Class) to decode to a List of entities.
toEntityList(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.client.ClientResponseField
Variant of ClientResponseField.toEntity(Class) to decode to a list of entities.
toEntityList(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSpec
toEntityList(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSubscriptionSpec
Variant of GraphQlClient.RetrieveSubscriptionSpec.toEntity(Class) to decode each response to a List of entities.
toEntityList(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSyncSpec
toExecutionInput() - Method in interface org.springframework.graphql.ExecutionGraphQlRequest
Create the ExecutionInput to pass to GraphQL.
toExecutionInput() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlRequest
 
toFluxFromCollection(Object) - Static method in class org.springframework.graphql.execution.ReactiveAdapterRegistryHelper
Return a Flux for the given result Object that represents a logical collection of values.
toMap() - Method in exception org.springframework.graphql.execution.SubscriptionPublisherException
Return an ExecutionResult specification map with the GraphQL errors.
toMap() - Method in interface org.springframework.graphql.GraphQlRequest
Convert the request to a Map as defined in GraphQL over HTTP and GraphQL over WebSocket.
toMap() - Method in interface org.springframework.graphql.GraphQlResponse
Return a map representation of the response, formatted as required in the "Response" section of the GraphQL spec.
toMap() - Method in class org.springframework.graphql.server.support.SerializableGraphQlRequest
 
toMap() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse
 
toMap() - Method in class org.springframework.graphql.support.DefaultGraphQlRequest
 
toMono(Object) - Static method in class org.springframework.graphql.execution.ReactiveAdapterRegistryHelper
Return a Mono for the given Object by delegating to ReactiveAdapterRegistryHelper.toMonoIfReactive(java.lang.Object), and then applying Mono.justOrEmpty(java.util.Optional<? extends T>) if necessary.
toMonoIfReactive(Object) - Static method in class org.springframework.graphql.execution.ReactiveAdapterRegistryHelper
Return a Mono for the given result Object if it can be adapted to a Publisher via ReactiveAdapterRegistry.
toMonoOrFluxIfReactive(Object) - Static method in class org.springframework.graphql.execution.ReactiveAdapterRegistryHelper
Adapt the given result Object to Mono or Flux if it can be adapted to a single or multi-value Publisher respectively via ReactiveAdapterRegistry.
toString() - Method in record class org.springframework.graphql.data.federation.FederationSchemaFactory.EntityMappingInfo
Returns a string representation of this record class.
toString() - Method in class org.springframework.graphql.data.method.annotation.support.DataFetcherMappingInfo
 
toString() - Method in class org.springframework.graphql.data.method.HandlerMethod
 
toString() - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher
 
toString() - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher
 
toString() - Method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
 
toString() - Method in enum class org.springframework.graphql.server.support.GraphQlWebSocketMessageType
 
toString() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlRequest
 
toString() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse
 
toString() - Method in class org.springframework.graphql.support.DefaultGraphQlRequest
 
toSubscriptionFlux(Object) - Static method in class org.springframework.graphql.execution.ReactiveAdapterRegistryHelper
Return a Flux for the given result Object, adapting to a Publisher via ReactiveAdapterRegistry or wrapping it as Flux if necessary.
transform(Consumer<RSocketGraphQlResponse.Builder>) - Method in class org.springframework.graphql.server.RSocketGraphQlResponse
Transform the underlying ExecutionResult through a RSocketGraphQlResponse.Builder and return a new instance with the modified values.
transform(Consumer<WebGraphQlResponse.Builder>) - Method in class org.springframework.graphql.server.WebGraphQlResponse
Transform the underlying ExecutionResult through a WebGraphQlResponse.Builder and return a new instance with the modified values.
type() - Method in interface org.springframework.graphql.execution.SchemaReport.SkippedType
Return the type that was skipped.
TypeDefinitionConfigurer - Interface in org.springframework.graphql.execution
Callback that allows customizing the TypeDefinitionRegistry created from parsed schema files.
typeName() - Method in record class org.springframework.graphql.data.federation.FederationSchemaFactory.EntityMappingInfo
Returns the value of the typeName record component.
typeName() - Element in annotation interface org.springframework.graphql.data.GraphQlRepository
Use this to customize the name of the GraphQL type that matches to the repository domain type.
typeName() - Element in annotation interface org.springframework.graphql.data.method.annotation.BatchMapping
Customizes the name of the source/parent type for the GraphQL field.
typeName() - Element in annotation interface org.springframework.graphql.data.method.annotation.SchemaMapping
Customizes the name of the source/parent type for the GraphQL field.
TypeVisitorHelper - Interface in org.springframework.graphql.execution
Helps GraphQLTypeVisitors to recognize whether a type is the subscription type.
typeVisitors(List<GraphQLTypeVisitor>) - Method in class org.springframework.graphql.execution.AbstractGraphQlSourceBuilder
 
typeVisitors(List<GraphQLTypeVisitor>) - Method in interface org.springframework.graphql.execution.GraphQlSource.Builder
Add GraphQLTypeVisitors to visit all element of the created GraphQLSchema and make changes to the GraphQLCodeRegistry.
typeVisitorsToTransformSchema(List<GraphQLTypeVisitor>) - Method in class org.springframework.graphql.execution.AbstractGraphQlSourceBuilder
 
typeVisitorsToTransformSchema(List<GraphQLTypeVisitor>) - Method in interface org.springframework.graphql.execution.GraphQlSource.Builder
Alternative to GraphQlSource.Builder.typeVisitors(List) for visitors that also need to make schema changes.

U

UNAUTHORIZED - Enum constant in enum class org.springframework.graphql.execution.ErrorType
DataFetcher did not fetch the data value due to a lack of valid authentication credentials.
unmappedArguments() - Method in interface org.springframework.graphql.execution.SchemaReport
Return a map with DataFetchers and the names of arguments they depend on that don't exist.
unmappedFields() - Method in interface org.springframework.graphql.execution.SchemaReport
Return the coordinates of unmapped fields.
unmappedRegistrations() - Method in interface org.springframework.graphql.execution.SchemaReport
Return the coordinates for invalid DataFetcher registrations referring to fields that don't exist in the schema.
url(String) - Method in interface org.springframework.graphql.client.HttpSyncGraphQlClient.Builder
Set the GraphQL endpoint URL as a String.
url(String) - Method in interface org.springframework.graphql.client.WebGraphQlClient.Builder
Set the GraphQL endpoint URL as a String.
url(URI) - Method in interface org.springframework.graphql.client.HttpSyncGraphQlClient.Builder
Set the GraphQL endpoint URL.
url(URI) - Method in interface org.springframework.graphql.client.WebGraphQlClient.Builder
Set the GraphQL endpoint URL.
usesDataLoader() - Method in interface org.springframework.graphql.execution.SelfDescribingDataFetcher
Whether this DataFetcher uses a DataLoader to return data.

V

value() - Method in class org.springframework.graphql.data.ArgumentValue
Return the contained value, or null.
value() - Element in annotation interface org.springframework.graphql.data.federation.EntityMapping
Effectively an alias for EntityMapping.name().
value() - Element in annotation interface org.springframework.graphql.data.method.annotation.Argument
Alias for Argument.name().
value() - Element in annotation interface org.springframework.graphql.data.method.annotation.BatchMapping
Effectively an alias for BatchMapping.field().
value() - Element in annotation interface org.springframework.graphql.data.method.annotation.ContextValue
value() - Element in annotation interface org.springframework.graphql.data.method.annotation.GraphQlExceptionHandler
Exceptions handled by the annotated method.
value() - Element in annotation interface org.springframework.graphql.data.method.annotation.LocalContextValue
value() - Element in annotation interface org.springframework.graphql.data.method.annotation.MutationMapping
value() - Element in annotation interface org.springframework.graphql.data.method.annotation.QueryMapping
value() - Element in annotation interface org.springframework.graphql.data.method.annotation.SchemaMapping
Effectively an alias for SchemaMapping.field().
value() - Element in annotation interface org.springframework.graphql.data.method.annotation.SubscriptionMapping
value() - Method in enum class org.springframework.graphql.server.support.GraphQlWebSocketMessageType
The protocol value for the message type.
valueOf(String) - Static method in enum class org.springframework.graphql.execution.ErrorType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.DataFetcherHighCardinalityKeyNames
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.DataFetcherLowCardinalityKeyNames
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.DataLoaderHighCardinalityKeyNames
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.DataLoaderLowCardinalityKeyNames
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.ExecutionRequestHighCardinalityKeyNames
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.ExecutionRequestLowCardinalityKeyNames
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.graphql.server.support.GraphQlWebSocketMessageType
Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.springframework.graphql.execution.ErrorType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.DataFetcherHighCardinalityKeyNames
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.DataFetcherLowCardinalityKeyNames
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.DataLoaderHighCardinalityKeyNames
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.DataLoaderLowCardinalityKeyNames
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.ExecutionRequestHighCardinalityKeyNames
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation.ExecutionRequestLowCardinalityKeyNames
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.graphql.observation.GraphQlObservationDocumentation
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.graphql.server.support.GraphQlWebSocketMessageType
Returns an array containing the constants of this enum class, in the order they are declared.
variable(String, Object) - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Add a value for a variable defined by the operation.
variables(Map<String, Object>) - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Add all given values for variables defined by the operation.
VARIABLES_KEY - Static variable in class org.springframework.graphql.support.DefaultGraphQlRequest
 
visitGraphQLFieldDefinition(GraphQLFieldDefinition, TraverserContext<GraphQLSchemaElement>) - Method in class org.springframework.graphql.data.pagination.ConnectionFieldTypeVisitor
 

W

webClient(Consumer<WebClient.Builder>) - Method in interface org.springframework.graphql.client.HttpGraphQlClient.Builder
Customize the WebClient to use.
WebGraphQlClient - Interface in org.springframework.graphql.client
Base contract for the HTTP and WebSocket GraphQlClient extensions.
WebGraphQlClient.Builder<B extends WebGraphQlClient.Builder<B>> - Interface in org.springframework.graphql.client
Base builder for GraphQL clients over a Web transport.
WebGraphQlHandler - Interface in org.springframework.graphql.server
Contract for common handling of a GraphQL request over HTTP or WebSocket, for use with Spring MVC or Spring WebFlux.
WebGraphQlHandler.Builder - Interface in org.springframework.graphql.server
Builder for a WebGraphQlHandler that executes a WebGraphQlInterceptor chain followed by a ExecutionGraphQlService.
WebGraphQlInterceptor - Interface in org.springframework.graphql.server
Interceptor for server handling of GraphQL over HTTP or WebSocket requests, providing access to info about the underlying HTTP request or WebSocket handshake, and allowing customization of the ExecutionInput and the ExecutionResult.
WebGraphQlInterceptor.Chain - Interface in org.springframework.graphql.server
Contract for delegation to the rest of the chain.
WebGraphQlRequest - Class in org.springframework.graphql.server
GraphQlRequest implementation for server handling over HTTP or WebSocket.
WebGraphQlRequest(URI, HttpHeaders, MultiValueMap<String, HttpCookie>, InetSocketAddress, Map<String, Object>, Map<String, Object>, String, Locale) - Constructor for class org.springframework.graphql.server.WebGraphQlRequest
Constructor variant with a Map for the request body.
WebGraphQlRequest(URI, HttpHeaders, MultiValueMap<String, HttpCookie>, InetSocketAddress, Map<String, Object>, GraphQlRequest, String, Locale) - Constructor for class org.springframework.graphql.server.WebGraphQlRequest
Create an instance.
WebGraphQlRequest(URI, HttpHeaders, MultiValueMap<String, HttpCookie>, Map<String, Object>, Map<String, Object>, String, Locale) - Constructor for class org.springframework.graphql.server.WebGraphQlRequest
Deprecated, for removal: This API element is subject to removal in a future version.
WebGraphQlRequest(URI, HttpHeaders, MultiValueMap<String, HttpCookie>, Map<String, Object>, GraphQlRequest, String, Locale) - Constructor for class org.springframework.graphql.server.WebGraphQlRequest
Deprecated, for removal: This API element is subject to removal in a future version.
WebGraphQlResponse - Class in org.springframework.graphql.server
GraphQlResponse implementation for server handling over HTTP or over WebSocket.
WebGraphQlResponse(ExecutionGraphQlResponse) - Constructor for class org.springframework.graphql.server.WebGraphQlResponse
Create an instance that wraps the given ExecutionGraphQlResponse.
WebGraphQlResponse.Builder - Class in org.springframework.graphql.server
Builder to transform a WebGraphQlResponse.
webSocket(URI) - Method in interface org.springframework.graphql.client.RSocketGraphQlClient.Builder
Select WebSocket as the underlying network protocol.
WebSocketDisconnectedException - Exception in org.springframework.graphql.client
WebSocket related GraphQlTransportException raised when the connection is closed while a request or subscription is in progress.
WebSocketDisconnectedException(String, GraphQlRequest, CloseStatus) - Constructor for exception org.springframework.graphql.client.WebSocketDisconnectedException
Constructor with an explanation about the closure, along with the request details and the status used to close the WebSocket session.
WebSocketGraphQlClient - Interface in org.springframework.graphql.client
GraphQL over WebSocket client that uses WebSocketClient.
WebSocketGraphQlClient.Builder<B extends WebSocketGraphQlClient.Builder<B>> - Interface in org.springframework.graphql.client
Builder for a GraphQL over WebSocket client.
WebSocketGraphQlClientInterceptor - Interface in org.springframework.graphql.client
An extension of GraphQlClientInterceptor with additional methods to for WebSocket interception points.
WebSocketGraphQlInterceptor - Interface in org.springframework.graphql.server
An extension of WebGraphQlInterceptor with additional methods to handle the start and end of a WebSocket connection, as well as client-side cancellation of subscriptions.
WebSocketGraphQlRequest - Class in org.springframework.graphql.server
WebGraphQlRequest extension for server handling of GraphQL over WebSocket requests.
WebSocketGraphQlRequest(URI, HttpHeaders, MultiValueMap<String, HttpCookie>, InetSocketAddress, Map<String, Object>, Map<String, Object>, String, Locale, WebSocketSessionInfo) - Constructor for class org.springframework.graphql.server.WebSocketGraphQlRequest
Create an instance.
WebSocketGraphQlRequest(URI, HttpHeaders, MultiValueMap<String, HttpCookie>, Map<String, Object>, Map<String, Object>, String, Locale, WebSocketSessionInfo) - Constructor for class org.springframework.graphql.server.WebSocketGraphQlRequest
Deprecated, for removal: This API element is subject to removal in a future version.
WebSocketSessionInfo - Interface in org.springframework.graphql.server
Expose information about the underlying WebSocketSession including the session id, the attributes, and HTTP handshake request.
WindowConnectionAdapter - Class in org.springframework.graphql.data.query
Adapter for Window to Connection.
WindowConnectionAdapter(CursorStrategy<ScrollPosition>) - Constructor for class org.springframework.graphql.data.query.WindowConnectionAdapter
 
withEncoder(CursorStrategy<T>, CursorEncoder) - Static method in interface org.springframework.graphql.data.pagination.CursorStrategy
Decorate the given CursorStrategy with encoding and decoding that makes the String cursor opaque to clients.
withName(String) - Method in interface org.springframework.graphql.execution.BatchLoaderRegistry.RegistrationSpec
Customize the name under which the DataLoader is registered and can be accessed in the data layer.
withOptions(Consumer<DataLoaderOptions.Builder>) - Method in interface org.springframework.graphql.execution.BatchLoaderRegistry.RegistrationSpec
Customize the DataLoaderOptions to use to create the DataLoader via DataLoaderFactory.
withOptions(DataLoaderOptions) - Method in interface org.springframework.graphql.execution.BatchLoaderRegistry.RegistrationSpec
Set the DataLoaderOptions to use to create the DataLoader via DataLoaderFactory.
writeableType() - Method in class org.springframework.graphql.execution.GraphQlContextAccessor
 
writeValues(Map<Object, Object>, GraphQLContext) - Method in class org.springframework.graphql.execution.GraphQlContextAccessor
 
A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form