Skip navigation links
spring-graphql
A B C D E F G H I J L M N O P Q R S T U V W 

A

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
 
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
 
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.AnnotatedControllerConfigurer
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.method.annotation.support.AnnotatedControllerConfigurer
 
andThen(GraphQlClientInterceptor) - Method in interface org.springframework.graphql.client.GraphQlClientInterceptor
Return a new GraphQlClientInterceptor 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 detects @SchemaMapping annotated handler methods in @Controller classes and registers them as DataFetchers.
AnnotatedControllerConfigurer() - Constructor for class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer
 
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.
Argument - Annotation Type in org.springframework.graphql.data.method.annotation
Annotation to bind a named GraphQL argument onto a method parameter.
ArgumentMapMethodArgumentResolver - Class in org.springframework.graphql.data.method.annotation.support
Resolves a Map method parameter annotated with an @Argument by returning the GraphQL arguments map.
ArgumentMapMethodArgumentResolver() - Constructor for class org.springframework.graphql.data.method.annotation.support.ArgumentMapMethodArgumentResolver
 
ArgumentMethodArgumentResolver - Class in org.springframework.graphql.data.method.annotation.support
Resolver for @Argument annotated method parameters, obtained via DataFetchingEnvironment.getArgument(String) and converted to the declared type of the method parameter.
ArgumentMethodArgumentResolver(GraphQlArgumentBinder) - Constructor for class org.springframework.graphql.data.method.annotation.support.ArgumentMethodArgumentResolver
 
Arguments - Annotation Type 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
Analogous to ArgumentMethodArgumentResolver but resolving method parameters annotated with @Arguments and binding with the full arguments map.
ArgumentsMethodArgumentResolver(GraphQlArgumentBinder) - Constructor for class org.springframework.graphql.data.method.annotation.support.ArgumentsMethodArgumentResolver
 
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.
asWebSocketHttpRequestHandler(HandshakeHandler) - Method in class org.springframework.graphql.server.webmvc.GraphQlWebSocketHandler
Return a WebSocketHttpRequestHandler that uses this instance as its WebGraphQlHandler and adds a HandshakeInterceptor to propagate context.
attribute(String, Object) - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Set a client request attribute.
attributes(Consumer<Map<String, Object>>) - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Manipulate the client request attributes.
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.
autoRegistrationConfigurer(List<QueryByExampleExecutor<?>>, List<ReactiveQueryByExampleExecutor<?>>) - 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.
autoRegistrationConfigurer(List<QuerydslPredicateExecutor<?>>, List<ReactiveQuerydslPredicateExecutor<?>>) - 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.
autoRegistrationTypeVisitor(List<QueryByExampleExecutor<?>>, List<ReactiveQueryByExampleExecutor<?>>) - Static method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher
autoRegistrationTypeVisitor(List<QuerydslPredicateExecutor<?>>, List<ReactiveQuerydslPredicateExecutor<?>>) - Static method in class org.springframework.graphql.data.query.QuerydslDataFetcher

B

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
 
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 Type in org.springframework.graphql.data.method.annotation
Annotation for a handler method that batch loads field values, given a list of source/parent values.
bind(DataFetchingEnvironment, String, ResolvableType) - Method in class org.springframework.graphql.data.GraphQlArgumentBinder
Bind a single argument, or the full arguments map, onto an object of the given target type.
build() - Method in interface org.springframework.graphql.client.GraphQlClient.Builder
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.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 interface org.springframework.graphql.execution.GraphQlSource.Builder
Build the GraphQlSource instance.
build(RSocketGraphQlResponse, ExecutionResult) - Method in class org.springframework.graphql.server.RSocketGraphQlResponse.Builder
 
build() - Method in interface org.springframework.graphql.server.WebGraphQlHandler.Builder
Build the WebGraphQlHandler instance.
build(WebGraphQlResponse, ExecutionResult) - Method in class org.springframework.graphql.server.WebGraphQlResponse.Builder
 
build() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse.Builder
Build the response with the transformed ExecutionResult.
build(R, ExecutionResult) - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse.Builder
Subclasses to create the specific response instance.
builder(GraphQlTransport) - Static method in interface org.springframework.graphql.client.GraphQlClient
Create a builder with the given custom GraphQlTransport.
builder() - Static method in interface org.springframework.graphql.client.HttpGraphQlClient
Return a builder to initialize an HttpGraphQlClient with.
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() - 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(RSocketRequester.Builder) - Static method in interface org.springframework.graphql.client.RSocketGraphQlClient
Start with a given RSocketGraphQlClient.builder().
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(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(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(GraphQLSchema) - Static method in interface org.springframework.graphql.execution.GraphQlSource
Return a GraphQlSource builder that uses an externally prepared GraphQLSchema.
builder(ExecutionGraphQlService) - Static method in interface org.springframework.graphql.server.WebGraphQlHandler
Provides access to a builder to create a WebGraphQlHandler instance.
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.
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.
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
 
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.
clone() - Method in class org.springframework.graphql.data.method.HandlerMethod.HandlerMethodParameter
 
codecConfigurer(Consumer<CodecConfigurer>) - Method in interface org.springframework.graphql.client.WebGraphQlClient.Builder
Configure the underlying CodecConfigurer to use for all JSON encoding and decoding needs.
complete(String) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Create a "complete" server message.
composite(List<ThreadLocalAccessor>) - Static method in interface org.springframework.graphql.execution.ThreadLocalAccessor
Create a composite accessor that applies all of the given ThreadLocal accessors.
configure(RuntimeWiring.Builder) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer
 
configure(GraphQLCodeRegistry.Builder) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer
Alternative to AnnotatedControllerConfigurer.configure(RuntimeWiring.Builder) that registers data fetchers in a GraphQLCodeRegistry.Builder.
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.
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 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.
connectionAck(Object) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Create a "connection_ack" server message.
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.
ContextValue - Annotation Type 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
 
create(WebClient) - Static method in interface org.springframework.graphql.client.HttpGraphQlClient
Create an HttpGraphQlClient that uses the given WebClient.
create(URI, WebSocketClient) - Static method in interface org.springframework.graphql.client.WebSocketGraphQlClient
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.
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.
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.
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
An extension of HandlerMethod for annotated handler methods adapted to DataFetcher with DataFetchingEnvironment as their input.
DataFetcherHandlerMethod(HandlerMethod, HandlerMethodArgumentResolverComposite, HandlerMethodInputValidator, Executor, boolean) - Constructor for class org.springframework.graphql.data.method.annotation.support.DataFetcherHandlerMethod
Constructor with a parent handler method.
DataFetchingEnvironmentMethodArgumentResolver - Class in org.springframework.graphql.data.method.annotation.support
Resolver for DataFetchingEnvironment and related values that can be accessed through the DataFetchingEnvironment such as: GraphQLContext DataFetchingFieldSelectionSet Locale or Optional<Locale> as well as arguments of type
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
 
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.
DefaultBatchLoaderRegistry - Class in org.springframework.graphql.execution
A default implementation of BatchLoaderRegistry that accepts registrations, and also an implementation of DataLoaderRegistrar to apply those registrations to a DataLoaderRegistry.
DefaultBatchLoaderRegistry() - Constructor for class org.springframework.graphql.execution.DefaultBatchLoaderRegistry
 
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
 
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
 
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.
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 interface org.springframework.graphql.client.GraphQlClient.Builder
Configure a DocumentSource for use with GraphQlClient.documentName(String) for resolving a document by name.
DocumentSource - Interface in org.springframework.graphql.support
Strategy to locate a GraphQL document by a name.
doesNotRequirePayload() - Method in enum 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

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, GraphQLError) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Create an "error" server message.
errors(List<GraphQLError>) - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse.Builder
Set the errors of the GraphQL execution result.
ErrorType - Enum 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 interface org.springframework.graphql.execution.GraphQlSource.Builder
Add DataFetcherExceptionResolvers for resolving exceptions from DataFetchers.
execute() - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Execute request with a single response, e.g.
execute(GraphQlRequest) - Method in interface org.springframework.graphql.client.GraphQlTransport
Execute a request with a single response such as a "query" or "mutation".
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.
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.
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
 
extension(String, Object) - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Add a value for a protocol extension.
extensions(Map<String, Object>) - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Add all given protocol extensions.
extensions(Map<Object, Object>) - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse.Builder
Set the extensions of the GraphQL execution result.
extractThreadLocalValues(ThreadLocalAccessor, Context) - Static method in class org.springframework.graphql.execution.ReactorContextManager
Use the given accessor to extract ThreadLocal values and save them in a sub-map in the given Context, so those can be restored later around the execution of data fetchers and exception resolvers.
extractValues(Map<String, Object>) - Method in class org.springframework.graphql.execution.SecurityContextThreadLocalAccessor
 
extractValues(Map<String, Object>) - Method in interface org.springframework.graphql.execution.ThreadLocalAccessor
Extract ThreadLocal values and add them to the given Map, so they can be saved and subsequently restored around the invocation of data fetchers and exception resolvers.

F

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
 
FieldAccessException - Exception in org.springframework.graphql.client
An exception raised on an attempt to decode data from a failed response or a field is not present, or has no value, checked via ResponseField.hasValue().
FieldAccessException(ClientGraphQlRequest, ClientGraphQlResponse, ClientResponseField) - Constructor for exception org.springframework.graphql.client.FieldAccessException
Constructor with the request and response, and the accessed field.
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
 
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
 
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
 
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
 
from(BiFunction<Throwable, DataFetchingEnvironment, GraphQLError>) - Static method in class org.springframework.graphql.execution.DataFetcherExceptionResolverAdapter
Factory method to create a DataFetcherExceptionResolverAdapter that resolves exceptions with the given BiFunction.
fromValue(String) - Static method in enum org.springframework.graphql.server.support.GraphQlWebSocketMessageType
 

G

getArgumentResolver(MethodParameter) - Method in class org.springframework.graphql.data.method.HandlerMethodArgumentResolverComposite
Find a registered HandlerMethodArgumentResolver that supports the given method parameter.
getAttributes() - Method in interface org.springframework.graphql.client.ClientGraphQlRequest
Return the client request attributes.
getAttributes() - Method in interface org.springframework.graphql.server.WebSocketSessionInfo
Return the map with attributes associated with the WebSocket session.
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.
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
 
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
 
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(String) - Method in class org.springframework.graphql.support.CachingDocumentSource
 
getDocument() - Method in class org.springframework.graphql.support.DefaultGraphQlRequest
 
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
 
getError() - Method in interface org.springframework.graphql.ResponseField
Return the error that provides the reason for a failed field.
getErrors() - Method in exception org.springframework.graphql.client.SubscriptionErrorException
Return the errors contained in the GraphQL over WebSocket "errors" message.
getErrors() - Method in interface org.springframework.graphql.GraphQlResponse
Return errors included in the response.
getErrors() - Method in interface org.springframework.graphql.ResponseField
Return all field errors including errors above, at, and below this field.
getErrors() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse
 
getErrorType() - Method in interface org.springframework.graphql.ResponseError
Return a classification for the error that is specific to GraphQL Java.
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.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.support.DefaultExecutionGraphQlResponse
 
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.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.
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.
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
 
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.
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.
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
 
getMethodParameters() - Method in class org.springframework.graphql.data.method.HandlerMethod
Return the method parameters for this handler method.
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.support.DefaultGraphQlRequest
 
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.
getRemoteAddress() - Method in interface org.springframework.graphql.server.WebSocketSessionInfo
For a server session this is the remote address where the handshake request came from.
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.DataFetcherHandlerMethod
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 ouccrred.
getResponseHeaders() - Method in class org.springframework.graphql.server.WebGraphQlResponse
Return the headers to be added to the HTTP response.
getReturnType() - Method in class org.springframework.graphql.data.method.HandlerMethod
Return the HandlerMethod return type.
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
 
getThreadLocalAccessor() - Method in interface org.springframework.graphql.server.WebGraphQlHandler
Return the composite ThreadLocalAccessor that the handler is configured with.
getType(TypeResolutionEnvironment) - Method in class org.springframework.graphql.execution.ClassNameTypeResolver
 
getType() - Method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Return the message type value as it should appear on the wire.
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.
getValidator() - Method in class org.springframework.graphql.data.method.annotation.support.DataFetcherHandlerMethod
Return the configured input validator.
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.support.DefaultGraphQlRequest
 
getWebSocketInterceptor() - Method in interface org.springframework.graphql.server.WebGraphQlHandler
Return the single interceptor of type WebSocketGraphQlInterceptor among all the configured interceptors.
GraphiQlHandler - Class in org.springframework.graphql.server.webflux
Spring WebFlux 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, Resource) - Constructor for class org.springframework.graphql.server.webflux.GraphiQlHandler
Constructor with the HTML page to serve.
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.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.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
Bind a GraphQL argument, or the full arguments map, onto a target object.
GraphQlArgumentBinder() - Constructor for class org.springframework.graphql.data.GraphQlArgumentBinder
 
GraphQlArgumentBinder(ConversionService) - 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.Builder<B extends GraphQlClient.Builder<B>> - Interface in org.springframework.graphql.client
Defines a builder for creating GraphQlClient instances.
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 for a single response operation.
GraphQlClient.RetrieveSubscriptionSpec - Interface in org.springframework.graphql.client
Declares options to decode a field in each response of a subscription.
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.
GraphQlClientInterceptor.Chain - Interface in org.springframework.graphql.client
Contract for delegation of single response requests to the rest of the chain.
GraphQlClientInterceptor.SubscriptionChain - Interface in org.springframework.graphql.client
Contract for delegation of subscription requests to the rest of the chain.
GraphQlHttpHandler - Class in org.springframework.graphql.server.webflux
WebFlux.fn Handler for GraphQL over HTTP requests.
GraphQlHttpHandler(WebGraphQlHandler) - Constructor for class org.springframework.graphql.server.webflux.GraphQlHttpHandler
Create a new instance.
GraphQlHttpHandler - Class in org.springframework.graphql.server.webmvc
GraphQL handler to expose as a WebMvc.fn endpoint via RouterFunctions.
GraphQlHttpHandler(WebGraphQlHandler) - Constructor for class org.springframework.graphql.server.webmvc.GraphQlHttpHandler
Create a new instance.
GraphQlRepository - Annotation Type 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.
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.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.
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(Throwable, GraphQlRequest) - Constructor for exception org.springframework.graphql.client.GraphQlTransportException
Constructor with a default message.
GraphQlTransportException(String, Throwable, GraphQlRequest) - Constructor for exception org.springframework.graphql.client.GraphQlTransportException
Constructor with a given 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(WebGraphQlHandler, CodecConfigurer, Duration) - Constructor for class org.springframework.graphql.server.webflux.GraphQlWebSocketHandler
Create a new instance.
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, HttpMessageConverter<?>, 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 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 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.
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.GraphQlHttpHandler
Handle GraphQL requests over HTTP.
handleRequest(ServerRequest) - Method in class org.springframework.graphql.server.webflux.SchemaHandler
 
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.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.GraphQlHttpHandler
Handle GraphQL requests over HTTP.
handleRequest(ServerRequest) - Method in class org.springframework.graphql.server.webmvc.SchemaHandler
 
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
Resolves method parameters by delegating to a list of registered HandlerMethodArgumentResolver's.
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
 
handleTransportError(WebSocketSession, Throwable) - Method in class org.springframework.graphql.server.webmvc.GraphQlWebSocketHandler
 
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<T>) - Method in class org.springframework.graphql.data.method.HandlerMethod.HandlerMethodParameter
 
hasMethodAnnotation(Class<A>) - Method in class org.springframework.graphql.data.method.HandlerMethod
Return whether the parameter is declared with the given annotation type.
hasValue() - Method in interface org.springframework.graphql.ResponseField
Whether the field has a value.
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.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.

I

instrumentation(List<Instrumentation>) - Method in interface org.springframework.graphql.execution.GraphQlSource.Builder
Provide Instrumentation components to instrument the execution of GraphQL queries.
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(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 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(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(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.
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
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.
invokeCallable(Callable<T>, GraphQLContext) - Static method in class org.springframework.graphql.execution.ReactorContextManager
Restore ThreadLocal values, invoke the given Callable, and reset the ThreadLocal values.
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.
isCacheEnabled() - Method in class org.springframework.graphql.support.CachingDocumentSource
Whether caching is enabled.
isThreadLocalContextAware() - Method in class org.springframework.graphql.execution.DataFetcherExceptionResolverAdapter
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
 

L

LocalContextValue - Annotation Type 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 - Static variable in class org.springframework.graphql.data.method.HandlerMethod
 

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.
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.RSocketGraphQlClient
 
mutate() - Method in interface org.springframework.graphql.client.WebGraphQlClient
 
mutate() - Method in interface org.springframework.graphql.client.WebSocketGraphQlClient
 
MutationMapping - Annotation Type in org.springframework.graphql.data.method.annotation
@MutationMapping is a composed annotation that acts as a shortcut for @SchemaMapping with typeName="Mutation".

N

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(RSocketGraphQlRequest) - Method in interface org.springframework.graphql.server.RSocketGraphQlInterceptor.Chain
Delegate to the rest of the chain to execute the request.
next(String, Map<String, Object>) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Create a "next" server message.
next(WebGraphQlRequest) - Method in interface org.springframework.graphql.server.WebGraphQlInterceptor.Chain
Delegate to the rest of the chain to execute the request.

O

obtainApplicationContext() - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer
 
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.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.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.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.

P

ping(Object) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Create a "ping" client or server message.
pong(Object) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Create a "pong" client or server message.
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
 
project(Class<?>, Object) - Method in class org.springframework.graphql.data.method.annotation.support.ProjectedPayloadMethodArgumentResolver
 
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 to obtain an @ProjectedPayload, either based on the complete DataFetchingEnvironment.getArguments() map, or based on a specific argument within the map when the method parameter is annotated with @Argument.
ProjectedPayloadMethodArgumentResolver(ApplicationContext) - Constructor for class org.springframework.graphql.data.method.annotation.support.ProjectedPayloadMethodArgumentResolver
Create a new ProjectedPayloadMethodArgumentResolver using the given context.

Q

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.ReactiveBuilder<T,R> - Class in org.springframework.graphql.data.query
Builder for a reactive Query by Example-based DataFetcher.
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.ReactiveBuilder<T,R> - Class in org.springframework.graphql.data.query
Builder for a reactive Querydsl-based DataFetcher.
QueryMapping - Annotation Type in org.springframework.graphql.data.method.annotation
@QueryMapping is a composed annotation that acts as a shortcut for @SchemaMapping with typeName="Query".

R

ReactiveSecurityDataFetcherExceptionResolver - Class in org.springframework.graphql.execution
Reactive DataFetcherExceptionResolver for Spring Security exceptions.
ReactiveSecurityDataFetcherExceptionResolver() - Constructor for class org.springframework.graphql.execution.ReactiveSecurityDataFetcherExceptionResolver
 
ReactorContextManager - Class in org.springframework.graphql.execution
Provides helper methods to save Reactor context in the GraphQLContext so it can be subsequently obtained and propagated to data fetchers, exception handlers, and others.
ReactorContextManager() - Constructor for class org.springframework.graphql.execution.ReactorContextManager
 
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.
requiresProjection(Class<?>) - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher
 
requiresProjection(Class<?>) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher
 
resetValues(Map<String, Object>) - Method in class org.springframework.graphql.execution.SecurityContextThreadLocalAccessor
 
resetValues(Map<String, Object>) - Method in interface org.springframework.graphql.execution.ThreadLocalAccessor
Reset ThreadLocal context for the given, previously extracted and then restored values.
resolveArgument(MethodParameter, DataFetchingEnvironment) - Method in class org.springframework.graphql.data.method.annotation.support.ArgumentMapMethodArgumentResolver
 
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.SourceMethodArgumentResolver
 
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.
resolvedType() - Method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Return the message type as an emum.
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
 
resolveToMultipleErrors(Throwable, DataFetchingEnvironment) - Method in class org.springframework.graphql.execution.DataFetcherExceptionResolverAdapter
Override this method to resolve an Exception to multiple GraphQL errors.
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.
restoreValues(Map<String, Object>) - Method in class org.springframework.graphql.execution.SecurityContextThreadLocalAccessor
 
restoreValues(Map<String, Object>) - Method in interface org.springframework.graphql.execution.ThreadLocalAccessor
Restore ThreadLocal context by looking up previously extracted values.
retrieve(String) - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Shortcut for GraphQlClient.RequestSpec.execute() with a single field path to decode from.
retrieveSubscription(String) - Method in interface org.springframework.graphql.client.GraphQlClient.RequestSpec
Shortcut for GraphQlClient.RequestSpec.executeSubscription() with a single 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

schema() - Method in interface org.springframework.graphql.execution.GraphQlSource
Return the GraphQLSchema used by the current GraphQL.
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(GraphQlSource) - Constructor for class org.springframework.graphql.server.webflux.SchemaHandler
 
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.webmvc.SchemaHandler
 
SchemaMapping - Annotation Type in org.springframework.graphql.data.method.annotation
Annotation to express the mapping of a handler method to a GraphQL type and field pair.
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.
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
 
setApplicationContext(ApplicationContext) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer
 
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".
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.
setExecutor(Executor) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer
Configure an Executor to use for asynchronous handling of Callable return values from controller methods.
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.
setJsonDecoder(Decoder<?>) - Method in class org.springframework.graphql.client.AbstractGraphQlClientBuilder
setJsonEncoder(Encoder<?>) - Method in class org.springframework.graphql.client.AbstractGraphQlClientBuilder
setPayload(Object) - Method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
 
setThreadLocalContextAware(boolean) - Method in class org.springframework.graphql.execution.DataFetcherExceptionResolverAdapter
Sub-classes 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
 
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}.
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.
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
 
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.
subscribe(String, GraphQlRequest) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
Create a "subscribe" client message.
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.
SubscriptionMapping - Annotation Type in org.springframework.graphql.data.method.annotation
@SubscriptionMapping is a composed annotation that acts as a shortcut for @SchemaMapping with typeName="Subscription".
supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.ArgumentMapMethodArgumentResolver
 
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 sub-type.
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.SourceMethodArgumentResolver
 
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.
supportsPartialMessages() - Method in class org.springframework.graphql.server.webmvc.GraphQlWebSocketHandler
 

T

tcp(String, int) - Method in interface org.springframework.graphql.client.RSocketGraphQlClient.Builder
Select TCP as the underlying network protocol.
ThreadLocalAccessor - Interface in org.springframework.graphql.execution
Interface to be implemented to assist with the extraction of ThreadLocal values at the start of GraphQL request execution, e.g.
threadLocalAccessor(ThreadLocalAccessor...) - Method in interface org.springframework.graphql.server.WebGraphQlHandler.Builder
Configure accessors for ThreadLocal variables to use to extract ThreadLocal values at the start of GraphQL execution in the web layer, and have those saved, and restored around the invocation of data fetchers and exception resolvers.
threadLocalAccessors(List<ThreadLocalAccessor>) - Method in interface org.springframework.graphql.server.WebGraphQlHandler.Builder
toArgsMono(Object[]) - Method in class org.springframework.graphql.data.method.InvocableHandlerMethodSupport
Use this method to resolve the arguments asynchronously.
toEntity(Class<D>) - Method in interface org.springframework.graphql.client.ClientGraphQlResponse
Decode the full response map to the given target type.
toEntity(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.client.ClientGraphQlResponse
toEntity(Class<D>) - Method in interface org.springframework.graphql.client.ClientResponseField
Decode the field to an entity of the given type.
toEntity(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.client.ClientResponseField
toEntity(Class<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSpec
Decode the field to an entity of the given type.
toEntity(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSpec
toEntity(Class<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSubscriptionSpec
Decode the field to an entity of the given type.
toEntity(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSubscriptionSpec
toEntityList(Class<D>) - Method in interface org.springframework.graphql.client.ClientResponseField
Decode the field to a list of entities with the given type.
toEntityList(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.client.ClientResponseField
toEntityList(Class<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSpec
Decode the field to a list of entities with the given type.
toEntityList(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSpec
toEntityList(Class<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSubscriptionSpec
Decode the field to a list of entities with the given type.
toEntityList(ParameterizedTypeReference<D>) - Method in interface org.springframework.graphql.client.GraphQlClient.RetrieveSubscriptionSpec
toExecutionInput() - Method in interface org.springframework.graphql.ExecutionGraphQlRequest
Create the ExecutionInput to pass to GraphQL.
toExecutionInput() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlRequest
 
toMap() - Method in interface org.springframework.graphql.GraphQlRequest
Convert the request to a Map as defined in GraphQL over HTTP and GraphQL over WebSocket: KeyValue querydocument operationNameoperationName variablesvariables
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.support.DefaultExecutionGraphQlResponse
 
toMap() - Method in class org.springframework.graphql.support.DefaultGraphQlRequest
 
toString() - Method in class org.springframework.graphql.data.method.HandlerMethod
 
toString() - Method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage
 
toString() - Method in enum 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
 
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.
typeVisitors(List<GraphQLTypeVisitor>) - Method in interface org.springframework.graphql.execution.GraphQlSource.Builder
Add GraphQLTypeVisitors to visit all element of the created GraphQLSchema.

U

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.WebGraphQlClient.Builder
Set the GraphQL endpoint URL.

V

value() - Method in enum org.springframework.graphql.server.support.GraphQlWebSocketMessageType
The protocol value for the message type.
valueOf(String) - Static method in enum org.springframework.graphql.execution.ErrorType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.springframework.graphql.server.support.GraphQlWebSocketMessageType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.springframework.graphql.execution.ErrorType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.graphql.server.support.GraphQlWebSocketMessageType
Returns an array containing the constants of this enum type, 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.

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, Map<String, Object>, String, Locale) - Constructor for class org.springframework.graphql.server.WebGraphQlRequest
Create an instance.
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.
WebSocketGraphQlRequest - Class in org.springframework.graphql.server
WebGraphQlRequest extension for server handling of GraphQL over WebSocket requests.
WebSocketGraphQlRequest(URI, HttpHeaders, Map<String, Object>, String, Locale, WebSocketSessionInfo) - Constructor for class org.springframework.graphql.server.WebSocketGraphQlRequest
Create an instance.
WebSocketSessionInfo - Interface in org.springframework.graphql.server
Expose information about the underlying WebSocketSession including the session id, the attributes, and HTTP handshake request.
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>) - 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.
A B C D E F G H I J L M N O P Q R S T U V W 
Skip navigation links
spring-graphql