Index

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

C

CachingDocumentSource - Class in org.springframework.graphql.support

Base class for DocumentSource implementations providing support for caching loaded documents.

CachingDocumentSource(DocumentSource) - Constructor for class org.springframework.graphql.support.CachingDocumentSource

Constructor with the DocumentSource to actually load documents.

captureFrom(GraphQLContext) - Static method in class org.springframework.graphql.execution.ContextPropagationHelper

Shortcut to obtain the ContextSnapshotFactory instance, and to capture from the given GraphQLContext.

captureFrom(ContextView) - Static method in class org.springframework.graphql.execution.ContextPropagationHelper

Shortcut to obtain the ContextSnapshotFactory instance, and to capture from the given ContextView.

classMapping(String, Class<?>...) - Method in interface org.springframework.graphql.execution.SchemaMappingInspector.Initializer

Provide an explicit mapping between a GraphQL type name and the Java class(es) that represent it at runtime to help inspect union member and interface implementation types when those associations cannot be discovered otherwise.

classNameFunction(Function<GraphQLObjectType, String>) - Method in interface org.springframework.graphql.execution.SchemaMappingInspector.Initializer

Help to derive the simple class name for the Java representation of a GraphQL union member or interface implementing type.

ClassNameTypeResolver - Class in org.springframework.graphql.execution

TypeResolver that tries to find a GraphQL Object type based on the class name of a value returned from a DataFetcher.

ClassNameTypeResolver() - Constructor for class org.springframework.graphql.execution.ClassNameTypeResolver

classResolver(SchemaMappingInspector.ClassResolver) - Method in interface org.springframework.graphql.execution.SchemaMappingInspector.Initializer

Alternative to SchemaMappingInspector.Initializer.classMapping(String, Class[]) with a custom SchemaMappingInspector.ClassResolver to find the Java class(es) for a GraphQL union member or interface implementation type.

clearCache() - Method in class org.springframework.graphql.support.CachingDocumentSource

Remove all entries from the document cache.

ClientGraphQlRequest - Interface in org.springframework.graphql.client

GraphQlRequest for client side use.

ClientGraphQlResponse - Interface in org.springframework.graphql.client

GraphQlResponse for client use, with further options to handle the response.

ClientResponseField - Interface in org.springframework.graphql.client

Extends ResponseField to add options for decoding the field value.

clientTransport(ClientTransport) - Method in interface org.springframework.graphql.client.RSocketGraphQlClient.Builder

Use a given ClientTransport to communicate with the remote server.

clientTransport(ClientTransport) - Method in class org.springframework.graphql.test.tester.DefaultRSocketGraphQlTesterBuilder

clientTransport(ClientTransport) - Method in interface org.springframework.graphql.test.tester.RSocketGraphQlTester.Builder

Use a given ClientTransport to communicate with the remote server.

clientTransports(Publisher<List<LoadbalanceTarget>>, LoadbalanceStrategy) - Method in interface org.springframework.graphql.client.RSocketGraphQlClient.Builder

Use a Publisher of LoadbalanceTargets, each of which contains a ClientTransport.

codecConfigurer(Consumer<CodecConfigurer>) - Method in interface org.springframework.graphql.client.WebGraphQlClient.Builder

Configure JSON encoders and decoders for use in the GraphQlResponse to convert response data to higher level objects.

codecConfigurer(Consumer<CodecConfigurer>) - Method in interface org.springframework.graphql.test.tester.WebGraphQlTester.Builder

Configure the underlying CodecConfigurer to use for all JSON encoding and decoding needs.

coercing(Class<?>, Coercing<?, ?>) - Method in class org.springframework.graphql.client.DgsGraphQlClient.RequestSpec

Configure Coercing for serialization of scalar types.

coercing(Map<Class<?>, Coercing<?, ?>>) - Method in class org.springframework.graphql.client.DgsGraphQlClient.RequestSpec

Configure Coercing for serialization of scalar types.

complete(String) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage

Create a "complete" server message.

COMPLETE - Enum constant in enum class org.springframework.graphql.server.support.GraphQlWebSocketMessageType

Indicates that the requested operation execution has completed.

configure(GraphQLCodeRegistry.Builder) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer

Alternative to AnnotatedControllerConfigurer.configure(RuntimeWiring.Builder) that registers data fetchers in a GraphQLCodeRegistry.Builder.

configure(RuntimeWiring.Builder) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer

configure(RuntimeWiring.Builder) - Method in interface org.springframework.graphql.execution.RuntimeWiringConfigurer

Apply changes to the RuntimeWiring.Builder such as registering DataFetchers, custom scalar types, and more.

configure(RuntimeWiring.Builder, List<WiringFactory>) - Method in interface org.springframework.graphql.execution.RuntimeWiringConfigurer

Variant of RuntimeWiringConfigurer.configure(RuntimeWiring.Builder) that also collects WiringFactory instances that are then combined as one via CombinedWiringFactory.

configure(TypeDefinitionRegistry) - Method in class org.springframework.graphql.execution.ConnectionTypeDefinitionConfigurer

configure(TypeDefinitionRegistry) - Method in interface org.springframework.graphql.execution.TypeDefinitionConfigurer

Customize the given TypeDefinitionRegistry.

configureExecutionInput(BiFunction<ExecutionInput, ExecutionInput.Builder, ExecutionInput>) - Method in interface org.springframework.graphql.ExecutionGraphQlRequest

Provide a BiFunction to help initialize the ExecutionInput passed to GraphQL.

configureExecutionInput(BiFunction<ExecutionInput, ExecutionInput.Builder, ExecutionInput>) - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlRequest

configureExecutionInput(BiFunction<ExecutionInput, ExecutionInput.Builder, ExecutionInput>) - Method in interface org.springframework.graphql.test.tester.ExecutionGraphQlServiceTester.Builder

Provide a BiFunction to help initialize the ExecutionInput with.

configureGraphQl(Consumer<GraphQL.Builder>) - Method in class org.springframework.graphql.execution.AbstractGraphQlSourceBuilder

configureGraphQl(Consumer<GraphQL.Builder>) - Method in interface org.springframework.graphql.execution.GraphQlSource.Builder

Configure consumers to be given access to the GraphQL.Builder used to build GraphQL.

configureJsonPathConfig(Function<Configuration, Configuration>) - Method in class org.springframework.graphql.test.tester.AbstractGraphQlTesterBuilder

Allow transport-specific subclass builders to register a JSON Path MappingProvider that matches the JSON encoding/decoding they use.

configureRuntimeWiring(RuntimeWiringConfigurer) - Method in interface org.springframework.graphql.execution.GraphQlSource.SchemaResourceBuilder

Configure the underlying RuntimeWiring.Builder to register data fetchers, custom scalar types, type resolvers, and more.

configureTypeDefinitions(TypeDefinitionConfigurer) - Method in interface org.springframework.graphql.execution.GraphQlSource.SchemaResourceBuilder

Customize the TypeDefinitionRegistry created from parsed schema files, adding or changing schema type definitions before the GraphQLSchema is created and validated.

CONNECTION_ACK - Enum constant in enum class org.springframework.graphql.server.support.GraphQlWebSocketMessageType

Expected response to the GraphQlWebSocketMessageType.CONNECTION_INIT message from the client acknowledging a successful connection with the server.

CONNECTION_INIT - Enum constant in enum class org.springframework.graphql.server.support.GraphQlWebSocketMessageType

Indicates that the client wants to establish a connection within the existing socket.

connectionAck(Object) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage

Create a "connection_ack" server message.

ConnectionAdapter - Interface in org.springframework.graphql.data.pagination

Contract to adapt a container object for a window of elements from a larger result set to Connection.

ConnectionAdapterSupport<P> - Class in org.springframework.graphql.data.pagination

Convenient base class for implementations of ConnectionAdapter.

ConnectionAdapterSupport(CursorStrategy<P>) - Constructor for class org.springframework.graphql.data.pagination.ConnectionAdapterSupport

Constructor with a CursorStrategy to use.

ConnectionFieldTypeVisitor - Class in org.springframework.graphql.data.pagination

GraphQLTypeVisitor that looks for Connection fields in the schema, and decorates their registered DataFetcher in order to adapt return values to Connection.

connectionInit(Object) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage

Create a "connection_init" client message.

connectionInitPayload() - Method in interface org.springframework.graphql.client.WebSocketGraphQlClientInterceptor

Provide a Mono that returns the payload for the "connection_init" message.

ConnectionTypeDefinitionConfigurer - Class in org.springframework.graphql.execution

TypeDefinitionConfigurer that generates "Connection" types by looking for fields whose type definition name ends in "Connection", considered by the GraphQL Cursor Connections Specification to be a Connection Type, and adding the required type definitions if they don't already exist.

ConnectionTypeDefinitionConfigurer() - Constructor for class org.springframework.graphql.execution.ConnectionTypeDefinitionConfigurer

contains(E...) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.EntityList

Verify the list contains the given values, in any order.

containsExactly(E...) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.EntityList

Verify that the list contains exactly the given values and nothing else, in the same order.

ContextPropagationHelper - Class in org.springframework.graphql.execution

Helper for propagating context values from and to Reactor and GraphQL contexts.

ContextPropagationHelper() - Constructor for class org.springframework.graphql.execution.ContextPropagationHelper

contextSnapshotFactory() - Method in interface org.springframework.graphql.server.WebGraphQlHandler

Return the configured ContextSnapshotFactory instance to use.

contextSnapshotFactory(ContextSnapshotFactory) - Method in interface org.springframework.graphql.server.WebGraphQlHandler.Builder

Configure the ContextSnapshotFactory instance to use for context propagation of ThreadLocal, and Reactor context values from the transport layer to the GraphQL execution layer.

ContextSnapshotFactoryHelper - Class in org.springframework.graphql.execution

Deprecated, for removal: This API element is subject to removal in a future version.

since 1.3.5 in favor of ContextPropagationHelper.

ContextSnapshotFactoryHelper() - Constructor for class org.springframework.graphql.execution.ContextSnapshotFactoryHelper

Deprecated.

ContextValue - Annotation Interface in org.springframework.graphql.data.method.annotation

Annotation to bind a method parameter to an attribute from the main GraphQLContext.

ContextValueMethodArgumentResolver - Class in org.springframework.graphql.data.method.annotation.support

Resolver for a @ContextValue annotated method parameter.

ContextValueMethodArgumentResolver() - Constructor for class org.springframework.graphql.data.method.annotation.support.ContextValueMethodArgumentResolver

ContinuationHandlerMethodArgumentResolver - Class in org.springframework.graphql.data.method.annotation.support

No-op resolver for method arguments of type Continuation.

ContinuationHandlerMethodArgumentResolver() - Constructor for class org.springframework.graphql.data.method.annotation.support.ContinuationHandlerMethodArgumentResolver

count() - Method in class org.springframework.graphql.data.pagination.Subrange

The number of elements in the subrange based on the "first" and "last" arguments from the GraphQL Cursor connection spec.

create(GraphQLSchema) - Static method in interface org.springframework.graphql.execution.TypeVisitorHelper

Create an instance with the given GraphQLSchema.

create(URI, WebSocketClient) - Static method in interface org.springframework.graphql.client.WebSocketGraphQlClient

Create a WebSocketGraphQlClient.

create(URI, WebSocketClient) - Static method in interface org.springframework.graphql.test.tester.WebSocketGraphQlTester

Create a WebSocketGraphQlTester.

create(List<ConnectionAdapter>) - Static method in class org.springframework.graphql.data.pagination.ConnectionFieldTypeVisitor

Create a ConnectionTypeVisitor instance that delegates to the given adapters to adapt return values to Connection.

create(ScrollPosition, Integer, boolean) - Static method in class org.springframework.graphql.data.query.ScrollSubrange

Create a ScrollSubrange from the given inputs.

create(GraphQlClient) - Static method in class org.springframework.graphql.client.DgsGraphQlClient

Create instance that wraps the given GraphQlClient.

create(ExecutionGraphQlService) - Static method in interface org.springframework.graphql.test.tester.ExecutionGraphQlServiceTester

Create a ExecutionGraphQlServiceTester instance.

create(WebGraphQlHandler) - Static method in interface org.springframework.graphql.test.tester.WebGraphQlTester

Create a WebGraphQlTester instance.

create(WebTestClient) - Static method in interface org.springframework.graphql.test.tester.HttpGraphQlTester

Create an HttpGraphQlTester that uses the given WebTestClient.

create(RestClient) - Static method in interface org.springframework.graphql.client.HttpSyncGraphQlClient

Create an HttpSyncGraphQlClient that uses the given RestClient.

create(WebClient) - Static method in interface org.springframework.graphql.client.HttpGraphQlClient

Create an HttpGraphQlClient that uses the given WebClient.

createCancelSignal(GraphQLContext) - Static method in class org.springframework.graphql.execution.ContextPropagationHelper

Create an atomic boolean and store it into the given GraphQLContext.

createExceptionHandler(List<DataFetcherExceptionResolver>) - Static method in interface org.springframework.graphql.execution.DataFetcherExceptionResolver

Factory method to create a DataFetcherExceptionHandler from a list of DataFetcherExceptionResolver's.

createGraphQLSchema(TypeDefinitionRegistry, RuntimeWiring) - Method in class org.springframework.graphql.data.federation.FederationSchemaFactory

Create GraphQLSchema via SchemaTransformer, setting up the "_entities" DataFetcher and TypeResolver for federated types.

createHandlerMethod(Method, Object, Class<?>) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport

createProjection(Class<?>, Object) - Method in class org.springframework.graphql.data.method.annotation.support.ProjectedPayloadMethodArgumentResolver

Protected method to create the projection.

createResponse(Map<String, Object>) - Static method in interface org.springframework.graphql.client.GraphQlTransport

Factory method to create GraphQlResponse from a GraphQL response map for use in transport implementations.

createSchemaTransformer(TypeDefinitionRegistry, RuntimeWiring) - Method in class org.springframework.graphql.data.federation.FederationSchemaFactory

Alternative to FederationSchemaFactory.createGraphQLSchema(TypeDefinitionRegistry, RuntimeWiring) that allows calling additional methods on SchemaTransformer.

createStateAsync(InstrumentationCreateStateParameters) - Method in class org.springframework.graphql.observation.GraphQlObservationInstrumentation

createSubrange(ScrollPosition, Integer, boolean) - Method in class org.springframework.graphql.data.method.annotation.support.ScrollSubrangeMethodArgumentResolver

createSubrange(P, Integer, boolean) - Method in class org.springframework.graphql.data.method.annotation.support.SubrangeMethodArgumentResolver

Allows subclasses to create an extension of Subrange.

createWithResolvedBean() - Method in class org.springframework.graphql.data.method.HandlerMethod

If the provided instance contains a bean name rather than an object instance, the bean name is resolved before a HandlerMethod is created and returned.

cursorAt(Object, int) - Method in interface org.springframework.graphql.data.pagination.ConnectionAdapter

Return a cursor for the item at the given index.

cursorAt(Object, int) - Method in class org.springframework.graphql.data.query.SliceConnectionAdapter

cursorAt(Object, int) - Method in class org.springframework.graphql.data.query.WindowConnectionAdapter

CursorEncoder - Interface in org.springframework.graphql.data.pagination

Strategy to encode and decode a String cursor to make it opaque for clients.

cursorStrategy(CursorStrategy<ScrollPosition>) - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.Builder

Configure strategy for decoding a cursor from a paginated request.

cursorStrategy(CursorStrategy<ScrollPosition>) - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.ReactiveBuilder

Configure strategy for decoding a cursor from a paginated request.

cursorStrategy(CursorStrategy<ScrollPosition>) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.Builder

Configure strategy for decoding a cursor from a paginated request.

cursorStrategy(CursorStrategy<ScrollPosition>) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.ReactiveBuilder

Configure strategy for decoding a cursor from a paginated request.

CursorStrategy<P> - Interface in org.springframework.graphql.data.pagination

Strategy to convert an Object that represents the position of an item within a paginated result set to and from a String cursor.

customize(QueryByExampleDataFetcher.Builder<T, ?>) - Method in interface org.springframework.graphql.data.query.QueryByExampleDataFetcher.QueryByExampleBuilderCustomizer

Callback to customize a QueryByExampleDataFetcher.Builder instance.

customize(QueryByExampleDataFetcher.ReactiveBuilder<T, ?>) - Method in interface org.springframework.graphql.data.query.QueryByExampleDataFetcher.ReactiveQueryByExampleBuilderCustomizer

Callback to customize a QueryByExampleDataFetcher.ReactiveBuilder instance.

customize(QuerydslDataFetcher.Builder<T, ?>) - Method in interface org.springframework.graphql.data.query.QuerydslDataFetcher.QuerydslBuilderCustomizer

Callback to customize a QuerydslDataFetcher.Builder instance.

customize(QuerydslDataFetcher.ReactiveBuilder<T, ?>) - Method in interface org.springframework.graphql.data.query.QuerydslDataFetcher.ReactiveQuerydslBuilderCustomizer

Callback to customize a QuerydslDataFetcher.ReactiveBuilder instance.

customizer(QuerydslBinderCustomizer<? extends EntityPath<T>>) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.Builder

Apply a QuerydslBinderCustomizer.

customizer(QuerydslBinderCustomizer<? extends EntityPath<T>>) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.ReactiveBuilder

Apply a QuerydslBinderCustomizer.

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